-
-
Notifications
You must be signed in to change notification settings - Fork 84
/
InlineDictionary.ts
47 lines (44 loc) · 1.33 KB
/
InlineDictionary.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
export interface InlineDictionary {
/**
* List of words to be considered correct.
*/
words?: string[];
// cspell:ignore colour color canot
/**
* List of words to always be considered incorrect. Words found in `flagWords` override `words`.
*
* Format of `flagWords`
* - single word entry - `word`
* - with suggestions - `word:suggestion` or `word->suggestion, suggestions`
*
* Example:
* ```ts
* "flagWords": [
* "color: colour",
* "incase: in case, encase",
* "canot->cannot",
* "cancelled->canceled"
* ]
* ```
*/
flagWords?: string[];
/**
* List of words to be ignored. An ignored word will not show up as an error, even if it is
* also in the `flagWords`.
*/
ignoreWords?: string[];
/**
* A list of suggested replacements for words.
* Suggested words provide a way to make preferred suggestions on word replacements.
* To hint at a preferred change, but not to require it.
*
* Format of `suggestWords`
* - Single suggestion (possible auto fix)
* - `word: suggestion`
* - `word->suggestion`
* - Multiple suggestions (not auto fixable)
* - `word: first, second, third`
* - `word->first, second, third`
*/
suggestWords?: string[];
}