ami/tl-vikunja
1
0
Fork 0
Code Activity

feat(natural language): make natural language prefixes configurable (#795)

Browse Source 
Co-authored-by: kolaente <k@knt.li>
Reviewed-on: https://kolaente.dev/vikunja/frontend/pulls/795
Co-authored-by: konrad <k@knt.li>
Co-committed-by: konrad <k@knt.li>
This commit is contained in:
konrad
2021-09-29 18:30:55 +00:00
parent 3b58756285
commit d47b13647e
7 changed files with 192 additions and 89 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
src/modules/parseTaskText.test.js
View File

@ -7,6 +7,29 @@ describe('Parse Task Text', () => {
it('should return text with no intents as is', () => {
expect(parseTaskText('Lorem Ipsum').text).toBe('Lorem Ipsum')
})
it('should not parse text when disabled', () => {
const text = 'Lorem Ipsum today *label +list !2 @user'
const result = parseTaskText(text, 'disabled')
expect(result.text).toBe(text)
})
it('should parse text in todoist mode when configured', () => {
const result = parseTaskText('Lorem Ipsum today @label #list !2 +user', 'todoist')
expect(result.text).toBe('Lorem Ipsum')
const now = new Date()
expect(result.date.getFullYear()).toBe(now.getFullYear())
expect(result.date.getMonth()).toBe(now.getMonth())
expect(result.date.getDate()).toBe(now.getDate())
expect(result.labels).toHaveLength(1)
expect(result.labels[0]).toBe('label')
expect(result.list).toBe('list')
expect(result.priority).toBe(2)
expect(result.assignees).toHaveLength(1)
expect(result.assignees[0]).toBe('user')
})
describe('Date Parsing', () => {
it('should not return any date if none was provided', () => {
@ -47,8 +70,8 @@ describe('Parse Task Text', () => {
}
for (const c in cases) {
it('should recognize today with a time ' + c, () => {
const result = parseTaskText('Lorem Ipsum today ' + c)
it(`should recognize today with a time ${c}`, () => {
const result = parseTaskText(`Lorem Ipsum today ${c}`)
expect(result.text).toBe('Lorem Ipsum')
const now = new Date()
@ -354,7 +377,7 @@ describe('Parse Task Text', () => {
describe('Labels', () => {
it('should parse labels', () => {
const result = parseTaskText('Lorem Ipsum @label1 @label2')
const result = parseTaskText('Lorem Ipsum *label1 *label2')
expect(result.text).toBe('Lorem Ipsum')
expect(result.labels).toHaveLength(2)
@ -362,7 +385,7 @@ describe('Parse Task Text', () => {
expect(result.labels[1]).toBe('label2')
})
it('should parse labels from the start', () => {
const result = parseTaskText('@label1 Lorem Ipsum @label2')
const result = parseTaskText('*label1 Lorem Ipsum *label2')
expect(result.text).toBe('Lorem Ipsum')
expect(result.labels).toHaveLength(2)
@ -370,7 +393,7 @@ describe('Parse Task Text', () => {
expect(result.labels[1]).toBe('label2')
})
it('should resolve duplicate labels', () => {
const result = parseTaskText('Lorem Ipsum @label1 @label1 @label2')
const result = parseTaskText('Lorem Ipsum *label1 *label1 *label2')
expect(result.text).toBe('Lorem Ipsum')
expect(result.labels).toHaveLength(2)
@ -378,14 +401,14 @@ describe('Parse Task Text', () => {
expect(result.labels[1]).toBe('label2')
})
it('should correctly parse labels with spaces in them', () => {
const result = parseTaskText(`Lorem @'label with space' Ipsum`)
const result = parseTaskText(`Lorem *'label with space' Ipsum`)
expect(result.text).toBe('Lorem Ipsum')
expect(result.labels).toHaveLength(1)
expect(result.labels[0]).toBe('label with space')
})
it('should correctly parse labels with spaces in them and "', () => {
const result = parseTaskText('Lorem @"label with space" Ipsum')
const result = parseTaskText('Lorem *"label with space" Ipsum')
expect(result.text).toBe('Lorem Ipsum')
expect(result.labels).toHaveLength(1)
@ -395,27 +418,27 @@ describe('Parse Task Text', () => {
describe('List', () => {
it('should parse a list', () => {
const result = parseTaskText('Lorem Ipsum #list')
const result = parseTaskText('Lorem Ipsum +list')
expect(result.text).toBe('Lorem Ipsum')
expect(result.list).toBe('list')
})
it('should parse a list with a space in it', () => {
const result = parseTaskText(`Lorem Ipsum #'list with long name'`)
const result = parseTaskText(`Lorem Ipsum +'list with long name'`)
expect(result.text).toBe('Lorem Ipsum')
expect(result.list).toBe('list with long name')
})
it('should parse a list with a space in it and "', () => {
const result = parseTaskText(`Lorem Ipsum #"list with long name"`)
const result = parseTaskText(`Lorem Ipsum +"list with long name"`)
expect(result.text).toBe('Lorem Ipsum')
expect(result.list).toBe('list with long name')
})
it('should parse only the first list', () => {
const result = parseTaskText(`Lorem Ipsum #list1 #list2 #list3`)
const result = parseTaskText(`Lorem Ipsum +list1 +list2 +list3`)
expect(result.text).toBe('Lorem Ipsum #list2 #list3')
expect(result.text).toBe('Lorem Ipsum +list2 +list3')
expect(result.list).toBe('list1')
})
})
@ -445,14 +468,14 @@ describe('Parse Task Text', () => {
describe('Assignee', () => {
it('should parse an assignee', () => {
const result = parseTaskText('Lorem Ipsum +user')
const result = parseTaskText('Lorem Ipsum @user')
expect(result.text).toBe('Lorem Ipsum')
expect(result.assignees).toHaveLength(1)
expect(result.assignees[0]).toBe('user')
})
it('should parse multiple assignees', () => {
const result = parseTaskText('Lorem Ipsum +user1 +user2 +user3')
const result = parseTaskText('Lorem Ipsum @user1 @user2 @user3')
expect(result.text).toBe('Lorem Ipsum')
expect(result.assignees).toHaveLength(3)
@ -461,7 +484,7 @@ describe('Parse Task Text', () => {
expect(result.assignees[2]).toBe('user3')
})
it('should parse avoid duplicate assignees', () => {
const result = parseTaskText('Lorem Ipsum +user1 +user1 +user2')
const result = parseTaskText('Lorem Ipsum @user1 @user1 @user2')
expect(result.text).toBe('Lorem Ipsum')
expect(result.assignees).toHaveLength(2)
@ -469,14 +492,14 @@ describe('Parse Task Text', () => {
expect(result.assignees[1]).toBe('user2')
})
it('should parse an assignee with a space in it', () => {
const result = parseTaskText(`Lorem Ipsum +'user with long name'`)
const result = parseTaskText(`Lorem Ipsum @'user with long name'`)
expect(result.text).toBe('Lorem Ipsum')
expect(result.assignees).toHaveLength(1)
expect(result.assignees[0]).toBe('user with long name')
})
it('should parse an assignee with a space in it and "', () => {
const result = parseTaskText(`Lorem Ipsum +"user with long name"`)
const result = parseTaskText(`Lorem Ipsum @"user with long name"`)
expect(result.text).toBe('Lorem Ipsum')
expect(result.assignees).toHaveLength(1)

67
src/modules/parseTaskText.ts
View File

@ -1,10 +1,31 @@
import {parseDate} from '../helpers/time/parseDate'
import _priorities from '../models/constants/priorities.json'
const LABEL_PREFIX: string = '@'
const LIST_PREFIX: string = '#'
const PRIORITY_PREFIX: string = '!'
const ASSIGNEE_PREFIX: string = '+'
const VIKUNJA_PREFIXES: Prefixes = {
label: '*',
list: '+',
priority: '!',
assignee: '@',
}
const TODOIST_PREFIXES: Prefixes = {
label: '@',
list: '#',
priority: '!',
assignee: '+',
}
export enum PrefixMode {
Disabled = 'disabled',
Default = 'vikunja',
Todoist = 'todoist',
}
export const PREFIXES = {
[PrefixMode.Disabled]: undefined,
[PrefixMode.Default]: VIKUNJA_PREFIXES,
[PrefixMode.Todoist]: TODOIST_PREFIXES,
}
const priorities: Priorites = _priorities
@ -26,12 +47,19 @@ interface ParsedTaskText {
assignees: string[],
}
interface Prefixes {
label: string,
list: string,
priority: string,
assignee: string,
}
/**
* Parses task text for dates, assignees, labels, lists, priorities and returns an object with all found intents.
*
* @param text
*/
export const parseTaskText = (text: string): ParsedTaskText => {
export const parseTaskText = (text: string, prefixesMode: PrefixMode = PrefixMode.Default): ParsedTaskText => {
const result: ParsedTaskText = {
text: text,
date: null,
@ -41,20 +69,25 @@ export const parseTaskText = (text: string): ParsedTaskText => {
assignees: [],
}
result.labels = getItemsFromPrefix(text, LABEL_PREFIX)
const prefixes = PREFIXES[prefixesMode]
if (prefixes === undefined) {
return result
}
const lists: string[] = getItemsFromPrefix(text, LIST_PREFIX)
result.labels = getItemsFromPrefix(text, prefixes.label)
const lists: string[] = getItemsFromPrefix(text, prefixes.list)
result.list = lists.length > 0 ? lists[0] : null
result.priority = getPriority(text)
result.priority = getPriority(text, prefixes.priority)
result.assignees = getItemsFromPrefix(text, ASSIGNEE_PREFIX)
result.assignees = getItemsFromPrefix(text, prefixes.assignee)
const {newText, date} = parseDate(text)
result.text = newText
result.date = date
return cleanupResult(result)
return cleanupResult(result, prefixes)
}
const getItemsFromPrefix = (text: string, prefix: string): string[] => {
@ -82,8 +115,8 @@ const getItemsFromPrefix = (text: string, prefix: string): string[] => {
return Array.from(new Set(items))
}
const getPriority = (text: string): number | null => {
const ps = getItemsFromPrefix(text, PRIORITY_PREFIX)
const getPriority = (text: string, prefix: string): number | null => {
const ps = getItemsFromPrefix(text, prefix)
if (ps.length === 0) {
return null
}
@ -112,11 +145,11 @@ const cleanupItemText = (text: string, items: string[], prefix: string): string
return text
}
const cleanupResult = (result: ParsedTaskText): ParsedTaskText => {
result.text = cleanupItemText(result.text, result.labels, LABEL_PREFIX)
result.text = result.list !== null ? cleanupItemText(result.text, [result.list], LIST_PREFIX) : result.text
result.text = result.priority !== null ? cleanupItemText(result.text, [String(result.priority)], PRIORITY_PREFIX) : result.text
result.text = cleanupItemText(result.text, result.assignees, ASSIGNEE_PREFIX)
const cleanupResult = (result: ParsedTaskText, prefixes: Prefixes): ParsedTaskText => {
result.text = cleanupItemText(result.text, result.labels, prefixes.label)
result.text = result.list !== null ? cleanupItemText(result.text, [result.list], prefixes.list) : result.text
result.text = result.priority !== null ? cleanupItemText(result.text, [String(result.priority)], prefixes.priority) : result.text
result.text = cleanupItemText(result.text, result.assignees, prefixes.assignee)
result.text = result.text.trim()
return result