@cspell/cspell-types 7.3.4 → 7.3.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/cspell.schema.json +313 -100
- package/dist/CSpellSettingsDef.d.ts +4 -58
- package/dist/DictionaryInformation.d.ts +0 -15
- package/dist/InlineDictionary.d.ts +0 -7
- package/package.json +2 -2
package/cspell.schema.json
CHANGED
|
@@ -15,20 +15,24 @@
|
|
|
15
15
|
"cacheFormat": {
|
|
16
16
|
"$ref": "#/definitions/CacheFormat",
|
|
17
17
|
"default": "legacy",
|
|
18
|
-
"description": "Format of the cache file.\n- `legacy` - use absolute paths in the cache file\n- `universal` - use a sharable format."
|
|
18
|
+
"description": "Format of the cache file.\n- `legacy` - use absolute paths in the cache file\n- `universal` - use a sharable format.",
|
|
19
|
+
"markdownDescription": "Format of the cache file.\n- `legacy` - use absolute paths in the cache file\n- `universal` - use a sharable format."
|
|
19
20
|
},
|
|
20
21
|
"cacheLocation": {
|
|
21
22
|
"$ref": "#/definitions/FSPathResolvable",
|
|
22
|
-
"description": "Path to the cache location. Can be a file or a directory. If none specified `.cspellcache` will be used. Relative paths are relative to the config file in which it is defined.\n\nA prefix of `${cwd}` is replaced with the current working directory."
|
|
23
|
+
"description": "Path to the cache location. Can be a file or a directory. If none specified `.cspellcache` will be used. Relative paths are relative to the config file in which it is defined.\n\nA prefix of `${cwd}` is replaced with the current working directory.",
|
|
24
|
+
"markdownDescription": "Path to the cache location. Can be a file or a directory.\nIf none specified `.cspellcache` will be used.\nRelative paths are relative to the config file in which it\nis defined.\n\nA prefix of `${cwd}` is replaced with the current working directory."
|
|
23
25
|
},
|
|
24
26
|
"cacheStrategy": {
|
|
25
27
|
"$ref": "#/definitions/CacheStrategy",
|
|
26
28
|
"default": "metadata",
|
|
27
|
-
"description": "Strategy to use for detecting changed files, default: metadata"
|
|
29
|
+
"description": "Strategy to use for detecting changed files, default: metadata",
|
|
30
|
+
"markdownDescription": "Strategy to use for detecting changed files, default: metadata"
|
|
28
31
|
},
|
|
29
32
|
"useCache": {
|
|
30
33
|
"default": false,
|
|
31
34
|
"description": "Store the results of processed files in order to only operate on the changed ones.",
|
|
35
|
+
"markdownDescription": "Store the results of processed files in order to only operate on the changed ones.",
|
|
32
36
|
"type": "boolean"
|
|
33
37
|
}
|
|
34
38
|
},
|
|
@@ -40,10 +44,12 @@
|
|
|
40
44
|
"metadata",
|
|
41
45
|
"content"
|
|
42
46
|
],
|
|
47
|
+
"markdownDescription": "The Strategy to use to detect if a file has changed.\n- `metadata` - uses the file system timestamp and size to detect changes (fastest).\n- `content` - uses a hash of the file content to check file changes (slower - more accurate).",
|
|
43
48
|
"type": "string"
|
|
44
49
|
},
|
|
45
50
|
"CharacterSet": {
|
|
46
51
|
"description": "This is a set of characters that can include `-` or `|`\n- `-` - indicates a range of characters: `a-c` => `abc`\n- `|` - is a group separator, indicating that the characters on either side are not related.",
|
|
52
|
+
"markdownDescription": "This is a set of characters that can include `-` or `|`\n- `-` - indicates a range of characters: `a-c` => `abc`\n- `|` - is a group separator, indicating that the characters on either side\n are not related.",
|
|
47
53
|
"type": "string"
|
|
48
54
|
},
|
|
49
55
|
"CharacterSetCosts": {
|
|
@@ -51,14 +57,17 @@
|
|
|
51
57
|
"properties": {
|
|
52
58
|
"characters": {
|
|
53
59
|
"$ref": "#/definitions/CharacterSet",
|
|
54
|
-
"description": "This is a set of characters that can include `-` or `|`\n- `-` - indicates a range of characters: `a-c` => `abc`\n- `|` - is a group separator, indicating that the characters on either side are not related."
|
|
60
|
+
"description": "This is a set of characters that can include `-` or `|`\n- `-` - indicates a range of characters: `a-c` => `abc`\n- `|` - is a group separator, indicating that the characters on either side are not related.",
|
|
61
|
+
"markdownDescription": "This is a set of characters that can include `-` or `|`\n- `-` - indicates a range of characters: `a-c` => `abc`\n- `|` - is a group separator, indicating that the characters on either side\n are not related."
|
|
55
62
|
},
|
|
56
63
|
"cost": {
|
|
57
64
|
"description": "the cost to insert / delete / replace / swap the characters in a group",
|
|
65
|
+
"markdownDescription": "the cost to insert / delete / replace / swap the characters in a group",
|
|
58
66
|
"type": "number"
|
|
59
67
|
},
|
|
60
68
|
"penalty": {
|
|
61
69
|
"description": "The penalty cost to apply if the accent is used. This is used to discourage",
|
|
70
|
+
"markdownDescription": "The penalty cost to apply if the accent is used.\nThis is used to discourage",
|
|
62
71
|
"type": "number"
|
|
63
72
|
}
|
|
64
73
|
},
|
|
@@ -73,26 +82,32 @@
|
|
|
73
82
|
"properties": {
|
|
74
83
|
"description": {
|
|
75
84
|
"description": "A description to describe the purpose of the map.",
|
|
85
|
+
"markdownDescription": "A description to describe the purpose of the map.",
|
|
76
86
|
"type": "string"
|
|
77
87
|
},
|
|
78
88
|
"insDel": {
|
|
79
89
|
"description": "The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.",
|
|
90
|
+
"markdownDescription": "The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.",
|
|
80
91
|
"type": "number"
|
|
81
92
|
},
|
|
82
93
|
"map": {
|
|
83
94
|
"description": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.",
|
|
95
|
+
"markdownDescription": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.",
|
|
84
96
|
"type": "string"
|
|
85
97
|
},
|
|
86
98
|
"penalty": {
|
|
87
99
|
"description": "Add a penalty to the final cost. This is used to discourage certain suggestions.\n\nExample: ```yaml # Match adding/removing `-` to the end of a word. map: \"$(-$)\" replace: 50 penalty: 100 ```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.",
|
|
100
|
+
"markdownDescription": "Add a penalty to the final cost.\nThis is used to discourage certain suggestions.\n\nExample:\n```yaml\n# Match adding/removing `-` to the end of a word.\nmap: \"$(-$)\"\nreplace: 50\npenalty: 100\n```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.",
|
|
88
101
|
"type": "number"
|
|
89
102
|
},
|
|
90
103
|
"replace": {
|
|
91
104
|
"description": "The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.",
|
|
105
|
+
"markdownDescription": "The cost to replace of of the substrings in the map with another substring in the map.\nExample: Map['a', 'i']\nThis would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.",
|
|
92
106
|
"type": "number"
|
|
93
107
|
},
|
|
94
108
|
"swap": {
|
|
95
109
|
"description": "The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.",
|
|
110
|
+
"markdownDescription": "The cost to swap two adjacent substrings found in the map.\nExample: Map['e', 'i']\nThis represents the cost to change `ei` to `ie` or the reverse.",
|
|
96
111
|
"type": "number"
|
|
97
112
|
}
|
|
98
113
|
},
|
|
@@ -107,26 +122,32 @@
|
|
|
107
122
|
"properties": {
|
|
108
123
|
"description": {
|
|
109
124
|
"description": "A description to describe the purpose of the map.",
|
|
125
|
+
"markdownDescription": "A description to describe the purpose of the map.",
|
|
110
126
|
"type": "string"
|
|
111
127
|
},
|
|
112
128
|
"insDel": {
|
|
113
129
|
"description": "The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.",
|
|
130
|
+
"markdownDescription": "The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.",
|
|
114
131
|
"type": "number"
|
|
115
132
|
},
|
|
116
133
|
"map": {
|
|
117
134
|
"description": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.",
|
|
135
|
+
"markdownDescription": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.",
|
|
118
136
|
"type": "string"
|
|
119
137
|
},
|
|
120
138
|
"penalty": {
|
|
121
139
|
"description": "Add a penalty to the final cost. This is used to discourage certain suggestions.\n\nExample: ```yaml # Match adding/removing `-` to the end of a word. map: \"$(-$)\" replace: 50 penalty: 100 ```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.",
|
|
140
|
+
"markdownDescription": "Add a penalty to the final cost.\nThis is used to discourage certain suggestions.\n\nExample:\n```yaml\n# Match adding/removing `-` to the end of a word.\nmap: \"$(-$)\"\nreplace: 50\npenalty: 100\n```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.",
|
|
122
141
|
"type": "number"
|
|
123
142
|
},
|
|
124
143
|
"replace": {
|
|
125
144
|
"description": "The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.",
|
|
145
|
+
"markdownDescription": "The cost to replace of of the substrings in the map with another substring in the map.\nExample: Map['a', 'i']\nThis would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.",
|
|
126
146
|
"type": "number"
|
|
127
147
|
},
|
|
128
148
|
"swap": {
|
|
129
149
|
"description": "The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.",
|
|
150
|
+
"markdownDescription": "The cost to swap two adjacent substrings found in the map.\nExample: Map['e', 'i']\nThis represents the cost to change `ei` to `ie` or the reverse.",
|
|
130
151
|
"type": "number"
|
|
131
152
|
}
|
|
132
153
|
},
|
|
@@ -141,26 +162,32 @@
|
|
|
141
162
|
"properties": {
|
|
142
163
|
"description": {
|
|
143
164
|
"description": "A description to describe the purpose of the map.",
|
|
165
|
+
"markdownDescription": "A description to describe the purpose of the map.",
|
|
144
166
|
"type": "string"
|
|
145
167
|
},
|
|
146
168
|
"insDel": {
|
|
147
169
|
"description": "The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.",
|
|
170
|
+
"markdownDescription": "The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.",
|
|
148
171
|
"type": "number"
|
|
149
172
|
},
|
|
150
173
|
"map": {
|
|
151
174
|
"description": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.",
|
|
175
|
+
"markdownDescription": "The set of substrings to map, these are generally single character strings.\n\nMultiple sets can be defined by using a `|` to separate them.\n\nExample: `\"eéê|aåá\"` contains two different sets.\n\nTo add a multi-character substring use `()`.\n\nExample: `\"f(ph)(gh)\"` results in the following set: `f`, `ph`, `gh`.\n\n- To match the beginning of a word, use `^`: `\"(^I)\"\"`.\n- To match the end of a word, use `$`: `\"(e$)(ing$)\"`.",
|
|
152
176
|
"type": "string"
|
|
153
177
|
},
|
|
154
178
|
"penalty": {
|
|
155
179
|
"description": "Add a penalty to the final cost. This is used to discourage certain suggestions.\n\nExample: ```yaml # Match adding/removing `-` to the end of a word. map: \"$(-$)\" replace: 50 penalty: 100 ```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.",
|
|
180
|
+
"markdownDescription": "Add a penalty to the final cost.\nThis is used to discourage certain suggestions.\n\nExample:\n```yaml\n# Match adding/removing `-` to the end of a word.\nmap: \"$(-$)\"\nreplace: 50\npenalty: 100\n```\n\nThis makes adding a `-` to the end of a word more expensive.\n\nThink of it as taking the toll way for speed but getting the bill later.",
|
|
156
181
|
"type": "number"
|
|
157
182
|
},
|
|
158
183
|
"replace": {
|
|
159
184
|
"description": "The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.",
|
|
185
|
+
"markdownDescription": "The cost to replace of of the substrings in the map with another substring in the map.\nExample: Map['a', 'i']\nThis would be the cost to substitute `a` with `i`: Like `bat` to `bit` or the reverse.",
|
|
160
186
|
"type": "number"
|
|
161
187
|
},
|
|
162
188
|
"swap": {
|
|
163
189
|
"description": "The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change `ei` to `ie` or the reverse.",
|
|
190
|
+
"markdownDescription": "The cost to swap two adjacent substrings found in the map.\nExample: Map['e', 'i']\nThis represents the cost to change `ei` to `ie` or the reverse.",
|
|
164
191
|
"type": "number"
|
|
165
192
|
}
|
|
166
193
|
},
|
|
@@ -172,7 +199,8 @@
|
|
|
172
199
|
},
|
|
173
200
|
"CustomDictionaryPath": {
|
|
174
201
|
"$ref": "#/definitions/FsDictionaryPath",
|
|
175
|
-
"description": "A File System Path to a dictionary file."
|
|
202
|
+
"description": "A File System Path to a dictionary file.",
|
|
203
|
+
"markdownDescription": "A File System Path to a dictionary file."
|
|
176
204
|
},
|
|
177
205
|
"CustomDictionaryScope": {
|
|
178
206
|
"description": "Specifies the scope of a dictionary.",
|
|
@@ -181,6 +209,7 @@
|
|
|
181
209
|
"workspace",
|
|
182
210
|
"folder"
|
|
183
211
|
],
|
|
212
|
+
"markdownDescription": "Specifies the scope of a dictionary.",
|
|
184
213
|
"type": "string"
|
|
185
214
|
},
|
|
186
215
|
"DictionaryDefinition": {
|
|
@@ -207,36 +236,44 @@
|
|
|
207
236
|
"deprecated": true,
|
|
208
237
|
"deprecationMessage": "Use `DictionaryDefinitionPreferred` instead.",
|
|
209
238
|
"description": "Only for legacy dictionary definitions.",
|
|
239
|
+
"markdownDescription": "Only for legacy dictionary definitions.",
|
|
210
240
|
"properties": {
|
|
211
241
|
"description": {
|
|
212
242
|
"description": "Optional description.",
|
|
243
|
+
"markdownDescription": "Optional description.",
|
|
213
244
|
"type": "string"
|
|
214
245
|
},
|
|
215
246
|
"file": {
|
|
216
247
|
"$ref": "#/definitions/DictionaryPath",
|
|
217
248
|
"deprecated": true,
|
|
218
249
|
"deprecationMessage": "Use `path` instead.",
|
|
219
|
-
"description": "Path to the file, only for legacy dictionary definitions."
|
|
250
|
+
"description": "Path to the file, only for legacy dictionary definitions.",
|
|
251
|
+
"markdownDescription": "Path to the file, only for legacy dictionary definitions."
|
|
220
252
|
},
|
|
221
253
|
"name": {
|
|
222
254
|
"$ref": "#/definitions/DictionaryId",
|
|
223
|
-
"description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
|
|
255
|
+
"description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
|
|
256
|
+
"markdownDescription": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
|
|
224
257
|
},
|
|
225
258
|
"noSuggest": {
|
|
226
259
|
"description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
|
|
260
|
+
"markdownDescription": "Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.",
|
|
227
261
|
"type": "boolean"
|
|
228
262
|
},
|
|
229
263
|
"repMap": {
|
|
230
264
|
"$ref": "#/definitions/ReplaceMap",
|
|
231
|
-
"description": "Replacement pairs."
|
|
265
|
+
"description": "Replacement pairs.",
|
|
266
|
+
"markdownDescription": "Replacement pairs."
|
|
232
267
|
},
|
|
233
268
|
"type": {
|
|
234
269
|
"$ref": "#/definitions/DictionaryFileTypes",
|
|
235
270
|
"default": "S",
|
|
236
|
-
"description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
|
|
271
|
+
"description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.",
|
|
272
|
+
"markdownDescription": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
|
|
237
273
|
},
|
|
238
274
|
"useCompounds": {
|
|
239
275
|
"description": "Use Compounds.",
|
|
276
|
+
"markdownDescription": "Use Compounds.",
|
|
240
277
|
"type": "boolean"
|
|
241
278
|
}
|
|
242
279
|
},
|
|
@@ -249,9 +286,11 @@
|
|
|
249
286
|
"DictionaryDefinitionAugmented": {
|
|
250
287
|
"additionalProperties": false,
|
|
251
288
|
"description": "Used to provide extra data related to the dictionary",
|
|
289
|
+
"markdownDescription": "Used to provide extra data related to the dictionary",
|
|
252
290
|
"properties": {
|
|
253
291
|
"description": {
|
|
254
292
|
"description": "Optional description.",
|
|
293
|
+
"markdownDescription": "Optional description.",
|
|
255
294
|
"type": "string"
|
|
256
295
|
},
|
|
257
296
|
"dictionaryInformation": {
|
|
@@ -259,27 +298,33 @@
|
|
|
259
298
|
},
|
|
260
299
|
"name": {
|
|
261
300
|
"$ref": "#/definitions/DictionaryId",
|
|
262
|
-
"description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
|
|
301
|
+
"description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
|
|
302
|
+
"markdownDescription": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
|
|
263
303
|
},
|
|
264
304
|
"noSuggest": {
|
|
265
305
|
"description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
|
|
306
|
+
"markdownDescription": "Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.",
|
|
266
307
|
"type": "boolean"
|
|
267
308
|
},
|
|
268
309
|
"path": {
|
|
269
310
|
"$ref": "#/definitions/DictionaryPath",
|
|
270
|
-
"description": "Path to the file."
|
|
311
|
+
"description": "Path to the file.",
|
|
312
|
+
"markdownDescription": "Path to the file."
|
|
271
313
|
},
|
|
272
314
|
"repMap": {
|
|
273
315
|
"$ref": "#/definitions/ReplaceMap",
|
|
274
|
-
"description": "Replacement pairs."
|
|
316
|
+
"description": "Replacement pairs.",
|
|
317
|
+
"markdownDescription": "Replacement pairs."
|
|
275
318
|
},
|
|
276
319
|
"type": {
|
|
277
320
|
"$ref": "#/definitions/DictionaryFileTypes",
|
|
278
321
|
"default": "S",
|
|
279
|
-
"description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
|
|
322
|
+
"description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.",
|
|
323
|
+
"markdownDescription": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
|
|
280
324
|
},
|
|
281
325
|
"useCompounds": {
|
|
282
326
|
"description": "Use Compounds.",
|
|
327
|
+
"markdownDescription": "Use Compounds.",
|
|
283
328
|
"type": "boolean"
|
|
284
329
|
}
|
|
285
330
|
},
|
|
@@ -292,30 +337,37 @@
|
|
|
292
337
|
"DictionaryDefinitionCustom": {
|
|
293
338
|
"additionalProperties": false,
|
|
294
339
|
"description": "For Defining Custom dictionaries. They are generally scoped to a `user`, `workspace`, or `folder`. When `addWords` is true, indicates that the spell checker can add words to the file.\n\nNote: only plain text files with one word per line are supported at this moment.",
|
|
340
|
+
"markdownDescription": "For Defining Custom dictionaries. They are generally scoped to a\n`user`, `workspace`, or `folder`.\nWhen `addWords` is true, indicates that the spell checker can add words\nto the file.\n\nNote: only plain text files with one word per line are supported at this moment.",
|
|
295
341
|
"properties": {
|
|
296
342
|
"addWords": {
|
|
297
343
|
"description": "When `true`, let's the spell checker know that words can be added to this dictionary.",
|
|
344
|
+
"markdownDescription": "When `true`, let's the spell checker know that words can be added to this dictionary.",
|
|
298
345
|
"type": "boolean"
|
|
299
346
|
},
|
|
300
347
|
"description": {
|
|
301
348
|
"description": "Optional description.",
|
|
349
|
+
"markdownDescription": "Optional description.",
|
|
302
350
|
"type": "string"
|
|
303
351
|
},
|
|
304
352
|
"name": {
|
|
305
353
|
"$ref": "#/definitions/DictionaryId",
|
|
306
|
-
"description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
|
|
354
|
+
"description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
|
|
355
|
+
"markdownDescription": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
|
|
307
356
|
},
|
|
308
357
|
"noSuggest": {
|
|
309
358
|
"description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
|
|
359
|
+
"markdownDescription": "Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.",
|
|
310
360
|
"type": "boolean"
|
|
311
361
|
},
|
|
312
362
|
"path": {
|
|
313
363
|
"$ref": "#/definitions/CustomDictionaryPath",
|
|
314
|
-
"description": "Path to custom dictionary text file."
|
|
364
|
+
"description": "Path to custom dictionary text file.",
|
|
365
|
+
"markdownDescription": "Path to custom dictionary text file."
|
|
315
366
|
},
|
|
316
367
|
"repMap": {
|
|
317
368
|
"$ref": "#/definitions/ReplaceMap",
|
|
318
|
-
"description": "Replacement pairs."
|
|
369
|
+
"description": "Replacement pairs.",
|
|
370
|
+
"markdownDescription": "Replacement pairs."
|
|
319
371
|
},
|
|
320
372
|
"scope": {
|
|
321
373
|
"anyOf": [
|
|
@@ -329,15 +381,18 @@
|
|
|
329
381
|
"type": "array"
|
|
330
382
|
}
|
|
331
383
|
],
|
|
332
|
-
"description": "Defines the scope for when words will be added to the dictionary.\n\nScope values: `user`, `workspace`, `folder`."
|
|
384
|
+
"description": "Defines the scope for when words will be added to the dictionary.\n\nScope values: `user`, `workspace`, `folder`.",
|
|
385
|
+
"markdownDescription": "Defines the scope for when words will be added to the dictionary.\n\nScope values: `user`, `workspace`, `folder`."
|
|
333
386
|
},
|
|
334
387
|
"type": {
|
|
335
388
|
"$ref": "#/definitions/DictionaryFileTypes",
|
|
336
389
|
"default": "S",
|
|
337
|
-
"description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
|
|
390
|
+
"description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.",
|
|
391
|
+
"markdownDescription": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
|
|
338
392
|
},
|
|
339
393
|
"useCompounds": {
|
|
340
394
|
"description": "Use Compounds.",
|
|
395
|
+
"markdownDescription": "Use Compounds.",
|
|
341
396
|
"type": "boolean"
|
|
342
397
|
}
|
|
343
398
|
},
|
|
@@ -360,20 +415,23 @@
|
|
|
360
415
|
"$ref": "#/definitions/DictionaryDefinitionInlineFlagWords"
|
|
361
416
|
}
|
|
362
417
|
],
|
|
363
|
-
"description": "Inline Dictionary Definitions"
|
|
418
|
+
"description": "Inline Dictionary Definitions",
|
|
419
|
+
"markdownDescription": "Inline Dictionary Definitions"
|
|
364
420
|
},
|
|
365
421
|
"DictionaryDefinitionInlineFlagWords": {
|
|
366
422
|
"additionalProperties": false,
|
|
367
423
|
"properties": {
|
|
368
424
|
"description": {
|
|
369
425
|
"description": "Optional description.",
|
|
426
|
+
"markdownDescription": "Optional description.",
|
|
370
427
|
"type": "string"
|
|
371
428
|
},
|
|
372
429
|
"flagWords": {
|
|
373
|
-
"description": "List of words to always be considered incorrect. Words found in `flagWords` override `words
|
|
430
|
+
"description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [ \"color: colour\", \"incase: in case, encase\", \"canot->cannot\", \"cancelled->canceled\" ] ```",
|
|
374
431
|
"items": {
|
|
375
432
|
"type": "string"
|
|
376
433
|
},
|
|
434
|
+
"markdownDescription": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample:\n```ts\n\"flagWords\": [\n \"color: colour\",\n \"incase: in case, encase\",\n \"canot->cannot\",\n \"cancelled->canceled\"\n]\n```",
|
|
377
435
|
"type": "array"
|
|
378
436
|
},
|
|
379
437
|
"ignoreWords": {
|
|
@@ -381,22 +439,26 @@
|
|
|
381
439
|
"items": {
|
|
382
440
|
"type": "string"
|
|
383
441
|
},
|
|
442
|
+
"markdownDescription": "List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.",
|
|
384
443
|
"type": "array"
|
|
385
444
|
},
|
|
386
445
|
"name": {
|
|
387
446
|
"$ref": "#/definitions/DictionaryId",
|
|
388
|
-
"description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
|
|
447
|
+
"description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
|
|
448
|
+
"markdownDescription": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
|
|
389
449
|
},
|
|
390
450
|
"noSuggest": {
|
|
391
451
|
"description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
|
|
452
|
+
"markdownDescription": "Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.",
|
|
392
453
|
"type": "boolean"
|
|
393
454
|
},
|
|
394
455
|
"repMap": {
|
|
395
456
|
"$ref": "#/definitions/ReplaceMap",
|
|
396
|
-
"description": "Replacement pairs."
|
|
457
|
+
"description": "Replacement pairs.",
|
|
458
|
+
"markdownDescription": "Replacement pairs."
|
|
397
459
|
},
|
|
398
460
|
"suggestWords": {
|
|
399
|
-
"description": "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
|
|
461
|
+
"description": "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.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`",
|
|
400
462
|
"items": {
|
|
401
463
|
"type": "string"
|
|
402
464
|
},
|
|
@@ -406,10 +468,12 @@
|
|
|
406
468
|
"type": {
|
|
407
469
|
"$ref": "#/definitions/DictionaryFileTypes",
|
|
408
470
|
"default": "S",
|
|
409
|
-
"description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
|
|
471
|
+
"description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.",
|
|
472
|
+
"markdownDescription": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
|
|
410
473
|
},
|
|
411
474
|
"useCompounds": {
|
|
412
475
|
"description": "Use Compounds.",
|
|
476
|
+
"markdownDescription": "Use Compounds.",
|
|
413
477
|
"type": "boolean"
|
|
414
478
|
},
|
|
415
479
|
"words": {
|
|
@@ -417,6 +481,7 @@
|
|
|
417
481
|
"items": {
|
|
418
482
|
"type": "string"
|
|
419
483
|
},
|
|
484
|
+
"markdownDescription": "List of words to be considered correct.",
|
|
420
485
|
"type": "array"
|
|
421
486
|
}
|
|
422
487
|
},
|
|
@@ -431,10 +496,11 @@
|
|
|
431
496
|
"properties": {
|
|
432
497
|
"description": {
|
|
433
498
|
"description": "Optional description.",
|
|
499
|
+
"markdownDescription": "Optional description.",
|
|
434
500
|
"type": "string"
|
|
435
501
|
},
|
|
436
502
|
"flagWords": {
|
|
437
|
-
"description": "List of words to always be considered incorrect. Words found in `flagWords` override `words
|
|
503
|
+
"description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [ \"color: colour\", \"incase: in case, encase\", \"canot->cannot\", \"cancelled->canceled\" ] ```",
|
|
438
504
|
"items": {
|
|
439
505
|
"type": "string"
|
|
440
506
|
},
|
|
@@ -446,22 +512,26 @@
|
|
|
446
512
|
"items": {
|
|
447
513
|
"type": "string"
|
|
448
514
|
},
|
|
515
|
+
"markdownDescription": "List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.",
|
|
449
516
|
"type": "array"
|
|
450
517
|
},
|
|
451
518
|
"name": {
|
|
452
519
|
"$ref": "#/definitions/DictionaryId",
|
|
453
|
-
"description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
|
|
520
|
+
"description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
|
|
521
|
+
"markdownDescription": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
|
|
454
522
|
},
|
|
455
523
|
"noSuggest": {
|
|
456
524
|
"description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
|
|
525
|
+
"markdownDescription": "Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.",
|
|
457
526
|
"type": "boolean"
|
|
458
527
|
},
|
|
459
528
|
"repMap": {
|
|
460
529
|
"$ref": "#/definitions/ReplaceMap",
|
|
461
|
-
"description": "Replacement pairs."
|
|
530
|
+
"description": "Replacement pairs.",
|
|
531
|
+
"markdownDescription": "Replacement pairs."
|
|
462
532
|
},
|
|
463
533
|
"suggestWords": {
|
|
464
|
-
"description": "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
|
|
534
|
+
"description": "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.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`",
|
|
465
535
|
"items": {
|
|
466
536
|
"type": "string"
|
|
467
537
|
},
|
|
@@ -471,10 +541,12 @@
|
|
|
471
541
|
"type": {
|
|
472
542
|
"$ref": "#/definitions/DictionaryFileTypes",
|
|
473
543
|
"default": "S",
|
|
474
|
-
"description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
|
|
544
|
+
"description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.",
|
|
545
|
+
"markdownDescription": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
|
|
475
546
|
},
|
|
476
547
|
"useCompounds": {
|
|
477
548
|
"description": "Use Compounds.",
|
|
549
|
+
"markdownDescription": "Use Compounds.",
|
|
478
550
|
"type": "boolean"
|
|
479
551
|
},
|
|
480
552
|
"words": {
|
|
@@ -482,6 +554,7 @@
|
|
|
482
554
|
"items": {
|
|
483
555
|
"type": "string"
|
|
484
556
|
},
|
|
557
|
+
"markdownDescription": "List of words to be considered correct.",
|
|
485
558
|
"type": "array"
|
|
486
559
|
}
|
|
487
560
|
},
|
|
@@ -496,10 +569,11 @@
|
|
|
496
569
|
"properties": {
|
|
497
570
|
"description": {
|
|
498
571
|
"description": "Optional description.",
|
|
572
|
+
"markdownDescription": "Optional description.",
|
|
499
573
|
"type": "string"
|
|
500
574
|
},
|
|
501
575
|
"flagWords": {
|
|
502
|
-
"description": "List of words to always be considered incorrect. Words found in `flagWords` override `words
|
|
576
|
+
"description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [ \"color: colour\", \"incase: in case, encase\", \"canot->cannot\", \"cancelled->canceled\" ] ```",
|
|
503
577
|
"items": {
|
|
504
578
|
"type": "string"
|
|
505
579
|
},
|
|
@@ -511,22 +585,26 @@
|
|
|
511
585
|
"items": {
|
|
512
586
|
"type": "string"
|
|
513
587
|
},
|
|
588
|
+
"markdownDescription": "List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.",
|
|
514
589
|
"type": "array"
|
|
515
590
|
},
|
|
516
591
|
"name": {
|
|
517
592
|
"$ref": "#/definitions/DictionaryId",
|
|
518
|
-
"description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
|
|
593
|
+
"description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
|
|
594
|
+
"markdownDescription": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
|
|
519
595
|
},
|
|
520
596
|
"noSuggest": {
|
|
521
597
|
"description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
|
|
598
|
+
"markdownDescription": "Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.",
|
|
522
599
|
"type": "boolean"
|
|
523
600
|
},
|
|
524
601
|
"repMap": {
|
|
525
602
|
"$ref": "#/definitions/ReplaceMap",
|
|
526
|
-
"description": "Replacement pairs."
|
|
603
|
+
"description": "Replacement pairs.",
|
|
604
|
+
"markdownDescription": "Replacement pairs."
|
|
527
605
|
},
|
|
528
606
|
"suggestWords": {
|
|
529
|
-
"description": "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
|
|
607
|
+
"description": "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.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`",
|
|
530
608
|
"items": {
|
|
531
609
|
"type": "string"
|
|
532
610
|
},
|
|
@@ -536,10 +614,12 @@
|
|
|
536
614
|
"type": {
|
|
537
615
|
"$ref": "#/definitions/DictionaryFileTypes",
|
|
538
616
|
"default": "S",
|
|
539
|
-
"description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
|
|
617
|
+
"description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.",
|
|
618
|
+
"markdownDescription": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
|
|
540
619
|
},
|
|
541
620
|
"useCompounds": {
|
|
542
621
|
"description": "Use Compounds.",
|
|
622
|
+
"markdownDescription": "Use Compounds.",
|
|
543
623
|
"type": "boolean"
|
|
544
624
|
},
|
|
545
625
|
"words": {
|
|
@@ -547,6 +627,7 @@
|
|
|
547
627
|
"items": {
|
|
548
628
|
"type": "string"
|
|
549
629
|
},
|
|
630
|
+
"markdownDescription": "List of words to be considered correct.",
|
|
550
631
|
"type": "array"
|
|
551
632
|
}
|
|
552
633
|
},
|
|
@@ -561,31 +642,38 @@
|
|
|
561
642
|
"properties": {
|
|
562
643
|
"description": {
|
|
563
644
|
"description": "Optional description.",
|
|
645
|
+
"markdownDescription": "Optional description.",
|
|
564
646
|
"type": "string"
|
|
565
647
|
},
|
|
566
648
|
"name": {
|
|
567
649
|
"$ref": "#/definitions/DictionaryId",
|
|
568
|
-
"description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
|
|
650
|
+
"description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
|
|
651
|
+
"markdownDescription": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
|
|
569
652
|
},
|
|
570
653
|
"noSuggest": {
|
|
571
654
|
"description": "Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.",
|
|
655
|
+
"markdownDescription": "Indicate that suggestions should not come from this dictionary.\nWords in this dictionary are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\nthis dictionary, it will be removed from the set of\npossible suggestions.",
|
|
572
656
|
"type": "boolean"
|
|
573
657
|
},
|
|
574
658
|
"path": {
|
|
575
659
|
"$ref": "#/definitions/DictionaryPath",
|
|
576
|
-
"description": "Path to the file."
|
|
660
|
+
"description": "Path to the file.",
|
|
661
|
+
"markdownDescription": "Path to the file."
|
|
577
662
|
},
|
|
578
663
|
"repMap": {
|
|
579
664
|
"$ref": "#/definitions/ReplaceMap",
|
|
580
|
-
"description": "Replacement pairs."
|
|
665
|
+
"description": "Replacement pairs.",
|
|
666
|
+
"markdownDescription": "Replacement pairs."
|
|
581
667
|
},
|
|
582
668
|
"type": {
|
|
583
669
|
"$ref": "#/definitions/DictionaryFileTypes",
|
|
584
670
|
"default": "S",
|
|
585
|
-
"description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
|
|
671
|
+
"description": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules.",
|
|
672
|
+
"markdownDescription": "Type of file:\n- S - single word per line,\n- W - each line can contain one or more words separated by space,\n- C - each line is treated like code (Camel Case is allowed).\n\nDefault is S.\n\nC is the slowest to load due to the need to split each line based upon code splitting rules."
|
|
586
673
|
},
|
|
587
674
|
"useCompounds": {
|
|
588
675
|
"description": "Use Compounds.",
|
|
676
|
+
"markdownDescription": "Use Compounds.",
|
|
589
677
|
"type": "boolean"
|
|
590
678
|
}
|
|
591
679
|
},
|
|
@@ -606,12 +694,14 @@
|
|
|
606
694
|
},
|
|
607
695
|
"DictionaryId": {
|
|
608
696
|
"description": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
|
|
697
|
+
"markdownDescription": "This is the name of a dictionary.\n\nName Format:\n- Must contain at least 1 number or letter.\n- Spaces are allowed.\n- Leading and trailing space will be removed.\n- Names ARE case-sensitive.\n- Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
|
|
609
698
|
"pattern": "^(?=[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
|
|
610
699
|
"type": "string"
|
|
611
700
|
},
|
|
612
701
|
"DictionaryInformation": {
|
|
613
702
|
"additionalProperties": false,
|
|
614
703
|
"description": "Use by dictionary authors to help improve the quality of suggestions given from the dictionary.\n\nAdded with `v5.16.0`.",
|
|
704
|
+
"markdownDescription": "Use by dictionary authors to help improve the quality of suggestions\ngiven from the dictionary.\n\nAdded with `v5.16.0`.",
|
|
615
705
|
"properties": {
|
|
616
706
|
"accents": {
|
|
617
707
|
"anyOf": [
|
|
@@ -625,7 +715,7 @@
|
|
|
625
715
|
"type": "array"
|
|
626
716
|
}
|
|
627
717
|
],
|
|
628
|
-
"description": "The accent characters
|
|
718
|
+
"description": "The accent characters.\n\nDefault: `\"\\u0300-\\u0341\"`",
|
|
629
719
|
"markdownDescription": "The accent characters.\n\nDefault: `\"\\u0300-\\u0341\"`"
|
|
630
720
|
},
|
|
631
721
|
"adjustments": {
|
|
@@ -633,6 +723,7 @@
|
|
|
633
723
|
"items": {
|
|
634
724
|
"$ref": "#/definitions/PatternAdjustment"
|
|
635
725
|
},
|
|
726
|
+
"markdownDescription": "A collection of patterns to test against the suggested words.\nIf the word matches the pattern, then the penalty is applied.",
|
|
636
727
|
"type": "array"
|
|
637
728
|
},
|
|
638
729
|
"alphabet": {
|
|
@@ -648,44 +739,53 @@
|
|
|
648
739
|
}
|
|
649
740
|
],
|
|
650
741
|
"default": "a-zA-Z",
|
|
651
|
-
"description": "The alphabet to use."
|
|
742
|
+
"description": "The alphabet to use.",
|
|
743
|
+
"markdownDescription": "The alphabet to use."
|
|
652
744
|
},
|
|
653
745
|
"costs": {
|
|
654
746
|
"$ref": "#/definitions/EditCosts",
|
|
655
|
-
"description": "Define edit costs."
|
|
747
|
+
"description": "Define edit costs.",
|
|
748
|
+
"markdownDescription": "Define edit costs."
|
|
656
749
|
},
|
|
657
750
|
"hunspellInformation": {
|
|
658
751
|
"$ref": "#/definitions/HunspellInformation",
|
|
659
|
-
"description": "Used by dictionary authors"
|
|
752
|
+
"description": "Used by dictionary authors",
|
|
753
|
+
"markdownDescription": "Used by dictionary authors"
|
|
660
754
|
},
|
|
661
755
|
"ignore": {
|
|
662
756
|
"$ref": "#/definitions/CharacterSet",
|
|
663
|
-
"description": "An optional set of characters that can possibly be removed from a word before checking it.\n\nThis is useful in languages like Arabic where Harakat accents are optional.\n\nNote: All matching characters are removed or none. Partial removal is not supported."
|
|
757
|
+
"description": "An optional set of characters that can possibly be removed from a word before checking it.\n\nThis is useful in languages like Arabic where Harakat accents are optional.\n\nNote: All matching characters are removed or none. Partial removal is not supported.",
|
|
758
|
+
"markdownDescription": "An optional set of characters that can possibly be removed from a word before\nchecking it.\n\nThis is useful in languages like Arabic where Harakat accents are optional.\n\nNote: All matching characters are removed or none. Partial removal is not supported."
|
|
664
759
|
},
|
|
665
760
|
"locale": {
|
|
666
761
|
"description": "The locale of the dictionary. Example: `nl,nl-be`",
|
|
762
|
+
"markdownDescription": "The locale of the dictionary.\nExample: `nl,nl-be`",
|
|
667
763
|
"type": "string"
|
|
668
764
|
},
|
|
669
765
|
"suggestionEditCosts": {
|
|
670
766
|
"$ref": "#/definitions/SuggestionCostsDefs",
|
|
671
|
-
"description": "Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list."
|
|
767
|
+
"description": "Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list.",
|
|
768
|
+
"markdownDescription": "Used in making suggestions. The lower the value, the more likely the suggestion\nwill be near the top of the suggestion list."
|
|
672
769
|
}
|
|
673
770
|
},
|
|
674
771
|
"type": "object"
|
|
675
772
|
},
|
|
676
773
|
"DictionaryNegRef": {
|
|
677
774
|
"description": "This a negative reference to a named dictionary.\n\nIt is used to exclude or include a dictionary by name.\n\nThe reference starts with 1 or more `!`.\n- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.\n- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`. Overrides `!<dictionary_name>`.\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`. Overrides `!!<dictionary_name>`.",
|
|
775
|
+
"markdownDescription": "This a negative reference to a named dictionary.\n\nIt is used to exclude or include a dictionary by name.\n\nThe reference starts with 1 or more `!`.\n- `!<dictionary_name>` - Used to exclude the dictionary matching `<dictionary_name>`.\n- `!!<dictionary_name>` - Used to re-include a dictionary matching `<dictionary_name>`.\n Overrides `!<dictionary_name>`.\n- `!!!<dictionary_name>` - Used to exclude a dictionary matching `<dictionary_name>`.\n Overrides `!!<dictionary_name>`.",
|
|
678
776
|
"pattern": "^(?=!+[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
|
|
679
777
|
"type": "string"
|
|
680
778
|
},
|
|
681
779
|
"DictionaryPath": {
|
|
682
780
|
"description": "A File System Path to a dictionary file.",
|
|
781
|
+
"markdownDescription": "A File System Path to a dictionary file.",
|
|
683
782
|
"pattern": "^.*\\.(?:txt|trie)(?:\\.gz)?$",
|
|
684
783
|
"type": "string"
|
|
685
784
|
},
|
|
686
785
|
"DictionaryRef": {
|
|
687
786
|
"$ref": "#/definitions/DictionaryId",
|
|
688
|
-
"description": "This a reference to a named dictionary. It is expected to match the name of a dictionary."
|
|
787
|
+
"description": "This a reference to a named dictionary. It is expected to match the name of a dictionary.",
|
|
788
|
+
"markdownDescription": "This a reference to a named dictionary.\nIt is expected to match the name of a dictionary."
|
|
689
789
|
},
|
|
690
790
|
"DictionaryReference": {
|
|
691
791
|
"anyOf": [
|
|
@@ -696,7 +796,8 @@
|
|
|
696
796
|
"$ref": "#/definitions/DictionaryNegRef"
|
|
697
797
|
}
|
|
698
798
|
],
|
|
699
|
-
"description": "Reference to a dictionary by name. One of:\n- {@link DictionaryRef } \n- {@link DictionaryNegRef }"
|
|
799
|
+
"description": "Reference to a dictionary by name. One of:\n- {@link DictionaryRef } \n- {@link DictionaryNegRef }",
|
|
800
|
+
"markdownDescription": "Reference to a dictionary by name.\nOne of:\n- {@link DictionaryRef } \n- {@link DictionaryNegRef }"
|
|
700
801
|
},
|
|
701
802
|
"EditCosts": {
|
|
702
803
|
"additionalProperties": false,
|
|
@@ -704,26 +805,31 @@
|
|
|
704
805
|
"accentCosts": {
|
|
705
806
|
"default": 1,
|
|
706
807
|
"description": "The cost to add / remove an accent This should be very cheap, it helps with fixing accent issues.",
|
|
808
|
+
"markdownDescription": "The cost to add / remove an accent\nThis should be very cheap, it helps with fixing accent issues.",
|
|
707
809
|
"type": "number"
|
|
708
810
|
},
|
|
709
811
|
"baseCost": {
|
|
710
812
|
"default": 100,
|
|
711
813
|
"description": "This is the base cost for making an edit.",
|
|
814
|
+
"markdownDescription": "This is the base cost for making an edit.",
|
|
712
815
|
"type": "number"
|
|
713
816
|
},
|
|
714
817
|
"capsCosts": {
|
|
715
818
|
"default": 1,
|
|
716
819
|
"description": "The cost to change capitalization. This should be very cheap, it helps with fixing capitalization issues.",
|
|
820
|
+
"markdownDescription": "The cost to change capitalization.\nThis should be very cheap, it helps with fixing capitalization issues.",
|
|
717
821
|
"type": "number"
|
|
718
822
|
},
|
|
719
823
|
"firstLetterPenalty": {
|
|
720
824
|
"default": 4,
|
|
721
825
|
"description": "The extra cost incurred for changing the first letter of a word. This value should be less than `100 - baseCost`.",
|
|
826
|
+
"markdownDescription": "The extra cost incurred for changing the first letter of a word.\nThis value should be less than `100 - baseCost`.",
|
|
722
827
|
"type": "number"
|
|
723
828
|
},
|
|
724
829
|
"nonAlphabetCosts": {
|
|
725
830
|
"default": 110,
|
|
726
831
|
"description": "This is the cost for characters not in the alphabet.",
|
|
832
|
+
"markdownDescription": "This is the cost for characters not in the alphabet.",
|
|
727
833
|
"type": "number"
|
|
728
834
|
}
|
|
729
835
|
},
|
|
@@ -731,7 +837,8 @@
|
|
|
731
837
|
},
|
|
732
838
|
"FSPathResolvable": {
|
|
733
839
|
"$ref": "#/definitions/FsPath",
|
|
734
|
-
"description": "A File System Path.\n\nSpecial Properties:\n- `${cwd}` prefix - will be replaced with the current working directory.\n- Relative paths are relative to the configuration file."
|
|
840
|
+
"description": "A File System Path.\n\nSpecial Properties:\n- `${cwd}` prefix - will be replaced with the current working directory.\n- Relative paths are relative to the configuration file.",
|
|
841
|
+
"markdownDescription": "A File System Path.\n\nSpecial Properties:\n- `${cwd}` prefix - will be replaced with the current working directory.\n- Relative paths are relative to the configuration file."
|
|
735
842
|
},
|
|
736
843
|
"FeatureEnableOnly": {
|
|
737
844
|
"type": "boolean"
|
|
@@ -739,85 +846,101 @@
|
|
|
739
846
|
"Features": {
|
|
740
847
|
"additionalProperties": false,
|
|
741
848
|
"description": "Features are behaviors or settings that can be explicitly configured.",
|
|
849
|
+
"markdownDescription": "Features are behaviors or settings that can be explicitly configured.",
|
|
742
850
|
"properties": {
|
|
743
851
|
"weighted-suggestions": {
|
|
744
852
|
"$ref": "#/definitions/FeatureEnableOnly",
|
|
745
|
-
"description": "Enable/disable using weighted suggestions."
|
|
853
|
+
"description": "Enable/disable using weighted suggestions.",
|
|
854
|
+
"markdownDescription": "Enable/disable using weighted suggestions."
|
|
746
855
|
}
|
|
747
856
|
},
|
|
748
857
|
"type": "object"
|
|
749
858
|
},
|
|
750
859
|
"FsDictionaryPath": {
|
|
751
860
|
"description": "A File System Path. Relative paths are relative to the configuration file.",
|
|
861
|
+
"markdownDescription": "A File System Path. Relative paths are relative to the configuration file.",
|
|
752
862
|
"type": "string"
|
|
753
863
|
},
|
|
754
864
|
"FsPath": {
|
|
755
865
|
"description": "A File System Path. Relative paths are relative to the configuration file.",
|
|
866
|
+
"markdownDescription": "A File System Path. Relative paths are relative to the configuration file.",
|
|
756
867
|
"type": "string"
|
|
757
868
|
},
|
|
758
869
|
"Glob": {
|
|
759
870
|
"$ref": "#/definitions/SimpleGlob",
|
|
760
|
-
"description": "These are glob expressions."
|
|
871
|
+
"description": "These are glob expressions.",
|
|
872
|
+
"markdownDescription": "These are glob expressions."
|
|
761
873
|
},
|
|
762
874
|
"HunspellInformation": {
|
|
763
875
|
"additionalProperties": false,
|
|
764
876
|
"properties": {
|
|
765
877
|
"aff": {
|
|
766
|
-
"description": "Selected Hunspell AFF content
|
|
878
|
+
"description": "Selected Hunspell AFF content. The content must be UTF-8\n\nSections:\n- TRY\n- MAP\n- REP\n- KEY\n- ICONV\n- OCONV\n\nExample: ```hunspell # Comment TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ` MAP aàâäAÀÂÄ MAP eéèêëEÉÈÊË MAP iîïyIÎÏY MAP oôöOÔÖ MAP (IJ)(IJ) ```",
|
|
767
879
|
"markdownDescription": "Selected Hunspell AFF content.\nThe content must be UTF-8\n\nSections:\n- TRY\n- MAP\n- REP\n- KEY\n- ICONV\n- OCONV\n\nExample:\n```hunspell\n# Comment\nTRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ`\nMAP aàâäAÀÂÄ\nMAP eéèêëEÉÈÊË\nMAP iîïyIÎÏY\nMAP oôöOÔÖ\nMAP (IJ)(IJ)\n```",
|
|
768
880
|
"type": "string"
|
|
769
881
|
},
|
|
770
882
|
"costs": {
|
|
771
883
|
"additionalProperties": false,
|
|
772
884
|
"description": "The costs to apply when using the hunspell settings",
|
|
885
|
+
"markdownDescription": "The costs to apply when using the hunspell settings",
|
|
773
886
|
"properties": {
|
|
774
887
|
"accentCosts": {
|
|
775
888
|
"default": 1,
|
|
776
889
|
"description": "The cost to add / remove an accent This should be very cheap, it helps with fixing accent issues.",
|
|
890
|
+
"markdownDescription": "The cost to add / remove an accent\nThis should be very cheap, it helps with fixing accent issues.",
|
|
777
891
|
"type": "number"
|
|
778
892
|
},
|
|
779
893
|
"baseCost": {
|
|
780
894
|
"default": 100,
|
|
781
895
|
"description": "This is the base cost for making an edit.",
|
|
896
|
+
"markdownDescription": "This is the base cost for making an edit.",
|
|
782
897
|
"type": "number"
|
|
783
898
|
},
|
|
784
899
|
"capsCosts": {
|
|
785
900
|
"default": 1,
|
|
786
901
|
"description": "The cost to change capitalization. This should be very cheap, it helps with fixing capitalization issues.",
|
|
902
|
+
"markdownDescription": "The cost to change capitalization.\nThis should be very cheap, it helps with fixing capitalization issues.",
|
|
787
903
|
"type": "number"
|
|
788
904
|
},
|
|
789
905
|
"firstLetterPenalty": {
|
|
790
906
|
"default": 4,
|
|
791
907
|
"description": "The extra cost incurred for changing the first letter of a word. This value should be less than `100 - baseCost`.",
|
|
908
|
+
"markdownDescription": "The extra cost incurred for changing the first letter of a word.\nThis value should be less than `100 - baseCost`.",
|
|
792
909
|
"type": "number"
|
|
793
910
|
},
|
|
794
911
|
"ioConvertCost": {
|
|
795
912
|
"default": 30,
|
|
796
913
|
"description": "The cost to convert between convert pairs.\n\nThe value should be slightly higher than the mapCost.",
|
|
914
|
+
"markdownDescription": "The cost to convert between convert pairs.\n\nThe value should be slightly higher than the mapCost.",
|
|
797
915
|
"type": "number"
|
|
798
916
|
},
|
|
799
917
|
"keyboardCost": {
|
|
800
918
|
"default": 99,
|
|
801
919
|
"description": "The cost of replacing or swapping any adjacent keyboard characters.\n\nThis should be slightly cheaper than `tryCharCost`.",
|
|
920
|
+
"markdownDescription": "The cost of replacing or swapping any adjacent keyboard characters.\n\nThis should be slightly cheaper than `tryCharCost`.",
|
|
802
921
|
"type": "number"
|
|
803
922
|
},
|
|
804
923
|
"mapCost": {
|
|
805
924
|
"default": 25,
|
|
806
925
|
"description": "mapSet replacement cost is the cost to substitute one character with another from the same set.\n\nMap characters are considered very similar to each other and are often the cause of simple mistakes.",
|
|
926
|
+
"markdownDescription": "mapSet replacement cost is the cost to substitute one character with another from\nthe same set.\n\nMap characters are considered very similar to each other and are often\nthe cause of simple mistakes.",
|
|
807
927
|
"type": "number"
|
|
808
928
|
},
|
|
809
929
|
"nonAlphabetCosts": {
|
|
810
930
|
"default": 110,
|
|
811
931
|
"description": "This is the cost for characters not in the alphabet.",
|
|
932
|
+
"markdownDescription": "This is the cost for characters not in the alphabet.",
|
|
812
933
|
"type": "number"
|
|
813
934
|
},
|
|
814
935
|
"replaceCosts": {
|
|
815
936
|
"default": 75,
|
|
816
937
|
"description": "The cost to substitute pairs found in the replace settings.",
|
|
938
|
+
"markdownDescription": "The cost to substitute pairs found in the replace settings.",
|
|
817
939
|
"type": "number"
|
|
818
940
|
},
|
|
819
941
|
"tryCharCost": {
|
|
820
942
|
"description": "The cost of inserting / deleting / or swapping any `tryChars` Defaults to `baseCosts`",
|
|
943
|
+
"markdownDescription": "The cost of inserting / deleting / or swapping any `tryChars`\nDefaults to `baseCosts`",
|
|
821
944
|
"type": "number"
|
|
822
945
|
}
|
|
823
946
|
},
|
|
@@ -844,16 +967,19 @@
|
|
|
844
967
|
},
|
|
845
968
|
"LanguageIdMultiple": {
|
|
846
969
|
"description": "This can be 'typescript,cpp,json,literal haskell', etc.",
|
|
970
|
+
"markdownDescription": "This can be 'typescript,cpp,json,literal haskell', etc.",
|
|
847
971
|
"pattern": "^([-\\w_\\s]+)(,[-\\w_\\s]+)*$",
|
|
848
972
|
"type": "string"
|
|
849
973
|
},
|
|
850
974
|
"LanguageIdMultipleNeg": {
|
|
851
975
|
"description": "This can be 'typescript,cpp,json,literal haskell', etc.",
|
|
976
|
+
"markdownDescription": "This can be 'typescript,cpp,json,literal haskell', etc.",
|
|
852
977
|
"pattern": "^(![-\\w_\\s]+)(,![-\\w_\\s]+)*$",
|
|
853
978
|
"type": "string"
|
|
854
979
|
},
|
|
855
980
|
"LanguageIdSingle": {
|
|
856
981
|
"description": "This can be '*', 'typescript', 'cpp', 'json', etc.",
|
|
982
|
+
"markdownDescription": "This can be '*', 'typescript', 'cpp', 'json', etc.",
|
|
857
983
|
"pattern": "^(!?[-\\w_\\s]+)|(\\*)$",
|
|
858
984
|
"type": "string"
|
|
859
985
|
},
|
|
@@ -862,21 +988,23 @@
|
|
|
862
988
|
"properties": {
|
|
863
989
|
"allowCompoundWords": {
|
|
864
990
|
"default": false,
|
|
865
|
-
"description": "True to enable compound word checking. See https://cspell.org/docs/case-sensitive/ for more details.",
|
|
991
|
+
"description": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
|
|
866
992
|
"markdownDescription": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
|
|
867
993
|
"type": "boolean"
|
|
868
994
|
},
|
|
869
995
|
"caseSensitive": {
|
|
870
996
|
"default": false,
|
|
871
997
|
"description": "Determines if words must match case and accent rules.\n\n- `false` - Case is ignored and accents can be missing on the entire word. Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.",
|
|
998
|
+
"markdownDescription": "Determines if words must match case and accent rules.\n\n- `false` - Case is ignored and accents can be missing on the entire word.\n Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.",
|
|
872
999
|
"type": "boolean"
|
|
873
1000
|
},
|
|
874
1001
|
"description": {
|
|
875
1002
|
"description": "Optional description of configuration.",
|
|
1003
|
+
"markdownDescription": "Optional description of configuration.",
|
|
876
1004
|
"type": "string"
|
|
877
1005
|
},
|
|
878
1006
|
"dictionaries": {
|
|
879
|
-
"description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.",
|
|
1007
|
+
"description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.",
|
|
880
1008
|
"items": {
|
|
881
1009
|
"$ref": "#/definitions/DictionaryReference"
|
|
882
1010
|
},
|
|
@@ -888,15 +1016,17 @@
|
|
|
888
1016
|
"items": {
|
|
889
1017
|
"$ref": "#/definitions/DictionaryDefinition"
|
|
890
1018
|
},
|
|
1019
|
+
"markdownDescription": "Define additional available dictionaries.\n\nFor example, you can use the following to add a custom dictionary:\n\n```json\n\"dictionaryDefinitions\": [\n { \"name\": \"custom-words\", \"path\": \"./custom-words.txt\"}\n],\n\"dictionaries\": [\"custom-words\"]\n```",
|
|
891
1020
|
"type": "array"
|
|
892
1021
|
},
|
|
893
1022
|
"enabled": {
|
|
894
1023
|
"default": true,
|
|
895
1024
|
"description": "Is the spell checker enabled.",
|
|
1025
|
+
"markdownDescription": "Is the spell checker enabled.",
|
|
896
1026
|
"type": "boolean"
|
|
897
1027
|
},
|
|
898
1028
|
"flagWords": {
|
|
899
|
-
"description": "List of words to always be considered incorrect. Words found in `flagWords` override `words
|
|
1029
|
+
"description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [ \"color: colour\", \"incase: in case, encase\", \"canot->cannot\", \"cancelled->canceled\" ] ```",
|
|
900
1030
|
"items": {
|
|
901
1031
|
"type": "string"
|
|
902
1032
|
},
|
|
@@ -905,11 +1035,12 @@
|
|
|
905
1035
|
},
|
|
906
1036
|
"id": {
|
|
907
1037
|
"description": "Optional identifier.",
|
|
1038
|
+
"markdownDescription": "Optional identifier.",
|
|
908
1039
|
"type": "string"
|
|
909
1040
|
},
|
|
910
1041
|
"ignoreRegExpList": {
|
|
911
1042
|
"$ref": "#/definitions/RegExpPatternList",
|
|
912
|
-
"description": "List of regular expression patterns or pattern names to exclude from spell checking.",
|
|
1043
|
+
"description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList: - >- /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).",
|
|
913
1044
|
"markdownDescription": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON\n```json\n\"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"]\n```\n\nYAML\n```yaml\nignoreRegExpList:\n - >-\n /\\b[A-Z]+\\b/g\n```\n\nBy default, several patterns are excluded. See\n[Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
|
|
914
1045
|
},
|
|
915
1046
|
"ignoreWords": {
|
|
@@ -917,16 +1048,18 @@
|
|
|
917
1048
|
"items": {
|
|
918
1049
|
"type": "string"
|
|
919
1050
|
},
|
|
1051
|
+
"markdownDescription": "List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.",
|
|
920
1052
|
"type": "array"
|
|
921
1053
|
},
|
|
922
1054
|
"includeRegExpList": {
|
|
923
1055
|
"$ref": "#/definitions/RegExpPatternList",
|
|
924
|
-
"description": "List of regular expression patterns or defined pattern names to match for spell checking.",
|
|
1056
|
+
"description": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).",
|
|
925
1057
|
"markdownDescription": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
|
|
926
1058
|
},
|
|
927
1059
|
"languageId": {
|
|
928
1060
|
"$ref": "#/definitions/MatchingFileType",
|
|
929
|
-
"description": "The language id. Ex: \"typescript\", \"html\", or \"php\". \"*\" -- will match all languages."
|
|
1061
|
+
"description": "The language id. Ex: \"typescript\", \"html\", or \"php\". \"*\" -- will match all languages.",
|
|
1062
|
+
"markdownDescription": "The language id. Ex: \"typescript\", \"html\", or \"php\". \"*\" -- will match all languages."
|
|
930
1063
|
},
|
|
931
1064
|
"local": {
|
|
932
1065
|
"anyOf": [
|
|
@@ -942,7 +1075,8 @@
|
|
|
942
1075
|
],
|
|
943
1076
|
"deprecated": true,
|
|
944
1077
|
"deprecationMessage": "Use `locale` instead.",
|
|
945
|
-
"description": "Deprecated - The locale filter, matches against the language. This can be a comma separated list. \"*\" will match all locales."
|
|
1078
|
+
"description": "Deprecated - The locale filter, matches against the language. This can be a comma separated list. \"*\" will match all locales.",
|
|
1079
|
+
"markdownDescription": "Deprecated - The locale filter, matches against the language. This can be a comma separated list. \"*\" will match all locales."
|
|
946
1080
|
},
|
|
947
1081
|
"locale": {
|
|
948
1082
|
"anyOf": [
|
|
@@ -956,10 +1090,12 @@
|
|
|
956
1090
|
"type": "array"
|
|
957
1091
|
}
|
|
958
1092
|
],
|
|
959
|
-
"description": "The locale filter, matches against the language. This can be a comma separated list. \"*\" will match all locales."
|
|
1093
|
+
"description": "The locale filter, matches against the language. This can be a comma separated list. \"*\" will match all locales.",
|
|
1094
|
+
"markdownDescription": "The locale filter, matches against the language. This can be a comma separated list. \"*\" will match all locales."
|
|
960
1095
|
},
|
|
961
1096
|
"name": {
|
|
962
1097
|
"description": "Optional name of configuration.",
|
|
1098
|
+
"markdownDescription": "Optional name of configuration.",
|
|
963
1099
|
"type": "string"
|
|
964
1100
|
},
|
|
965
1101
|
"noSuggestDictionaries": {
|
|
@@ -967,18 +1103,19 @@
|
|
|
967
1103
|
"items": {
|
|
968
1104
|
"$ref": "#/definitions/DictionaryReference"
|
|
969
1105
|
},
|
|
1106
|
+
"markdownDescription": "Optional list of dictionaries that will not be used for suggestions.\nWords in these dictionaries are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\none of these dictionaries, it will be removed from the set of\npossible suggestions.",
|
|
970
1107
|
"type": "array"
|
|
971
1108
|
},
|
|
972
1109
|
"patterns": {
|
|
973
|
-
"description": "Defines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.",
|
|
1110
|
+
"description": "Defines a list of patterns that can be used with the `ignoreRegExpList` and `includeRegExpList` options.\n\nFor example:\n\n```javascript \"ignoreRegExpList\": [\"comments\"], \"patterns\": [ { \"name\": \"comment-single-line\", \"pattern\": \"/#.*/g\" }, { \"name\": \"comment-multi-line\", \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\" }, // You can also combine multiple named patterns into one single named pattern { \"name\": \"comments\", \"pattern\": [\"comment-single-line\", \"comment-multi-line\"] } ] ``` Defines a list of patterns that can be used with the `ignoreRegExpList` and `includeRegExpList` options.",
|
|
974
1111
|
"items": {
|
|
975
1112
|
"$ref": "#/definitions/RegExpPatternDefinition"
|
|
976
1113
|
},
|
|
977
|
-
"markdownDescription": "Defines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.\n\nFor example:\n\n```javascript\n\"ignoreRegExpList\": [\"comments\"],\n\"patterns\": [\n {\n \"name\": \"comment-single-line\",\n \"pattern\": \"/#.*/g\"\n },\n {\n \"name\": \"comment-multi-line\",\n \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"\n },\n // You can also combine multiple named patterns into one single named pattern\n {\n \"name\": \"comments\",\n \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]\n }\n]\n
|
|
1114
|
+
"markdownDescription": "Defines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.\n\nFor example:\n\n```javascript\n\"ignoreRegExpList\": [\"comments\"],\n\"patterns\": [\n {\n \"name\": \"comment-single-line\",\n \"pattern\": \"/#.*/g\"\n },\n {\n \"name\": \"comment-multi-line\",\n \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"\n },\n // You can also combine multiple named patterns into one single named pattern\n {\n \"name\": \"comments\",\n \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]\n }\n]\n```\nDefines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.",
|
|
978
1115
|
"type": "array"
|
|
979
1116
|
},
|
|
980
1117
|
"suggestWords": {
|
|
981
|
-
"description": "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
|
|
1118
|
+
"description": "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.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`",
|
|
982
1119
|
"items": {
|
|
983
1120
|
"type": "string"
|
|
984
1121
|
},
|
|
@@ -990,6 +1127,7 @@
|
|
|
990
1127
|
"items": {
|
|
991
1128
|
"type": "string"
|
|
992
1129
|
},
|
|
1130
|
+
"markdownDescription": "List of words to be considered correct.",
|
|
993
1131
|
"type": "array"
|
|
994
1132
|
}
|
|
995
1133
|
},
|
|
@@ -1000,6 +1138,7 @@
|
|
|
1000
1138
|
},
|
|
1001
1139
|
"LocaleId": {
|
|
1002
1140
|
"description": "This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc.",
|
|
1141
|
+
"markdownDescription": "This is a written language locale like: 'en', 'en-GB', 'fr', 'es', 'de', etc.",
|
|
1003
1142
|
"type": "string"
|
|
1004
1143
|
},
|
|
1005
1144
|
"MatchingFileType": {
|
|
@@ -1020,21 +1159,23 @@
|
|
|
1020
1159
|
"properties": {
|
|
1021
1160
|
"allowCompoundWords": {
|
|
1022
1161
|
"default": false,
|
|
1023
|
-
"description": "True to enable compound word checking. See https://cspell.org/docs/case-sensitive/ for more details.",
|
|
1162
|
+
"description": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
|
|
1024
1163
|
"markdownDescription": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
|
|
1025
1164
|
"type": "boolean"
|
|
1026
1165
|
},
|
|
1027
1166
|
"caseSensitive": {
|
|
1028
1167
|
"default": false,
|
|
1029
1168
|
"description": "Determines if words must match case and accent rules.\n\n- `false` - Case is ignored and accents can be missing on the entire word. Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.",
|
|
1169
|
+
"markdownDescription": "Determines if words must match case and accent rules.\n\n- `false` - Case is ignored and accents can be missing on the entire word.\n Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.",
|
|
1030
1170
|
"type": "boolean"
|
|
1031
1171
|
},
|
|
1032
1172
|
"description": {
|
|
1033
1173
|
"description": "Optional description of configuration.",
|
|
1174
|
+
"markdownDescription": "Optional description of configuration.",
|
|
1034
1175
|
"type": "string"
|
|
1035
1176
|
},
|
|
1036
1177
|
"dictionaries": {
|
|
1037
|
-
"description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.",
|
|
1178
|
+
"description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.",
|
|
1038
1179
|
"items": {
|
|
1039
1180
|
"$ref": "#/definitions/DictionaryReference"
|
|
1040
1181
|
},
|
|
@@ -1046,9 +1187,11 @@
|
|
|
1046
1187
|
"items": {
|
|
1047
1188
|
"$ref": "#/definitions/DictionaryDefinition"
|
|
1048
1189
|
},
|
|
1190
|
+
"markdownDescription": "Define additional available dictionaries.\n\nFor example, you can use the following to add a custom dictionary:\n\n```json\n\"dictionaryDefinitions\": [\n { \"name\": \"custom-words\", \"path\": \"./custom-words.txt\"}\n],\n\"dictionaries\": [\"custom-words\"]\n```",
|
|
1049
1191
|
"type": "array"
|
|
1050
1192
|
},
|
|
1051
1193
|
"enableFiletypes": {
|
|
1194
|
+
"description": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by `cSpell.enabledLanguageIds`.\n\nTo disable a language, prefix with `!` as in `!json`,\n\nExample: ``` jsonc // enable checking for jsonc !json // disable checking for json kotlin // enable checking for kotlin ```",
|
|
1052
1195
|
"items": {
|
|
1053
1196
|
"$ref": "#/definitions/LanguageIdSingle"
|
|
1054
1197
|
},
|
|
@@ -1061,6 +1204,7 @@
|
|
|
1061
1204
|
"enabled": {
|
|
1062
1205
|
"default": true,
|
|
1063
1206
|
"description": "Is the spell checker enabled.",
|
|
1207
|
+
"markdownDescription": "Is the spell checker enabled.",
|
|
1064
1208
|
"type": "boolean"
|
|
1065
1209
|
},
|
|
1066
1210
|
"enabledLanguageIds": {
|
|
@@ -1068,6 +1212,7 @@
|
|
|
1068
1212
|
"items": {
|
|
1069
1213
|
"$ref": "#/definitions/LanguageIdSingle"
|
|
1070
1214
|
},
|
|
1215
|
+
"markdownDescription": "languageIds for the files to spell check.",
|
|
1071
1216
|
"type": "array"
|
|
1072
1217
|
},
|
|
1073
1218
|
"filename": {
|
|
@@ -1082,10 +1227,11 @@
|
|
|
1082
1227
|
"type": "array"
|
|
1083
1228
|
}
|
|
1084
1229
|
],
|
|
1085
|
-
"description": "Glob pattern or patterns to match against."
|
|
1230
|
+
"description": "Glob pattern or patterns to match against.",
|
|
1231
|
+
"markdownDescription": "Glob pattern or patterns to match against."
|
|
1086
1232
|
},
|
|
1087
1233
|
"flagWords": {
|
|
1088
|
-
"description": "List of words to always be considered incorrect. Words found in `flagWords` override `words
|
|
1234
|
+
"description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [ \"color: colour\", \"incase: in case, encase\", \"canot->cannot\", \"cancelled->canceled\" ] ```",
|
|
1089
1235
|
"items": {
|
|
1090
1236
|
"type": "string"
|
|
1091
1237
|
},
|
|
@@ -1094,11 +1240,12 @@
|
|
|
1094
1240
|
},
|
|
1095
1241
|
"id": {
|
|
1096
1242
|
"description": "Optional identifier.",
|
|
1243
|
+
"markdownDescription": "Optional identifier.",
|
|
1097
1244
|
"type": "string"
|
|
1098
1245
|
},
|
|
1099
1246
|
"ignoreRegExpList": {
|
|
1100
1247
|
"$ref": "#/definitions/RegExpPatternList",
|
|
1101
|
-
"description": "List of regular expression patterns or pattern names to exclude from spell checking.",
|
|
1248
|
+
"description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList: - >- /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).",
|
|
1102
1249
|
"markdownDescription": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON\n```json\n\"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"]\n```\n\nYAML\n```yaml\nignoreRegExpList:\n - >-\n /\\b[A-Z]+\\b/g\n```\n\nBy default, several patterns are excluded. See\n[Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
|
|
1103
1250
|
},
|
|
1104
1251
|
"ignoreWords": {
|
|
@@ -1106,23 +1253,26 @@
|
|
|
1106
1253
|
"items": {
|
|
1107
1254
|
"type": "string"
|
|
1108
1255
|
},
|
|
1256
|
+
"markdownDescription": "List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.",
|
|
1109
1257
|
"type": "array"
|
|
1110
1258
|
},
|
|
1111
1259
|
"includeRegExpList": {
|
|
1112
1260
|
"$ref": "#/definitions/RegExpPatternList",
|
|
1113
|
-
"description": "List of regular expression patterns or defined pattern names to match for spell checking.",
|
|
1261
|
+
"description": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).",
|
|
1114
1262
|
"markdownDescription": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
|
|
1115
1263
|
},
|
|
1116
1264
|
"language": {
|
|
1117
1265
|
"$ref": "#/definitions/LocaleId",
|
|
1118
|
-
"description": "Sets the locale."
|
|
1266
|
+
"description": "Sets the locale.",
|
|
1267
|
+
"markdownDescription": "Sets the locale."
|
|
1119
1268
|
},
|
|
1120
1269
|
"languageId": {
|
|
1121
1270
|
"$ref": "#/definitions/MatchingFileType",
|
|
1122
|
-
"description": "Sets the programming language id to match file type."
|
|
1271
|
+
"description": "Sets the programming language id to match file type.",
|
|
1272
|
+
"markdownDescription": "Sets the programming language id to match file type."
|
|
1123
1273
|
},
|
|
1124
1274
|
"languageSettings": {
|
|
1125
|
-
"description": "Additional settings for individual languages.",
|
|
1275
|
+
"description": "Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.",
|
|
1126
1276
|
"items": {
|
|
1127
1277
|
"$ref": "#/definitions/LanguageSetting"
|
|
1128
1278
|
},
|
|
@@ -1132,25 +1282,30 @@
|
|
|
1132
1282
|
"loadDefaultConfiguration": {
|
|
1133
1283
|
"default": true,
|
|
1134
1284
|
"description": "By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` will prevent ALL default configuration from being loaded.",
|
|
1285
|
+
"markdownDescription": "By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false`\nwill prevent ALL default configuration from being loaded.",
|
|
1135
1286
|
"type": "boolean"
|
|
1136
1287
|
},
|
|
1137
1288
|
"maxDuplicateProblems": {
|
|
1138
1289
|
"default": 5,
|
|
1139
1290
|
"description": "The maximum number of times the same word can be flagged as an error in a file.",
|
|
1291
|
+
"markdownDescription": "The maximum number of times the same word can be flagged as an error in a file.",
|
|
1140
1292
|
"type": "number"
|
|
1141
1293
|
},
|
|
1142
1294
|
"maxNumberOfProblems": {
|
|
1143
1295
|
"default": 10000,
|
|
1144
1296
|
"description": "The maximum number of problems to report in a file.",
|
|
1297
|
+
"markdownDescription": "The maximum number of problems to report in a file.",
|
|
1145
1298
|
"type": "number"
|
|
1146
1299
|
},
|
|
1147
1300
|
"minWordLength": {
|
|
1148
1301
|
"default": 4,
|
|
1149
1302
|
"description": "The minimum length of a word before checking it against a dictionary.",
|
|
1303
|
+
"markdownDescription": "The minimum length of a word before checking it against a dictionary.",
|
|
1150
1304
|
"type": "number"
|
|
1151
1305
|
},
|
|
1152
1306
|
"name": {
|
|
1153
1307
|
"description": "Optional name of configuration.",
|
|
1308
|
+
"markdownDescription": "Optional name of configuration.",
|
|
1154
1309
|
"type": "string"
|
|
1155
1310
|
},
|
|
1156
1311
|
"noSuggestDictionaries": {
|
|
@@ -1158,19 +1313,21 @@
|
|
|
1158
1313
|
"items": {
|
|
1159
1314
|
"$ref": "#/definitions/DictionaryReference"
|
|
1160
1315
|
},
|
|
1316
|
+
"markdownDescription": "Optional list of dictionaries that will not be used for suggestions.\nWords in these dictionaries are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\none of these dictionaries, it will be removed from the set of\npossible suggestions.",
|
|
1161
1317
|
"type": "array"
|
|
1162
1318
|
},
|
|
1163
1319
|
"numSuggestions": {
|
|
1164
1320
|
"default": 10,
|
|
1165
1321
|
"description": "Number of suggestions to make.",
|
|
1322
|
+
"markdownDescription": "Number of suggestions to make.",
|
|
1166
1323
|
"type": "number"
|
|
1167
1324
|
},
|
|
1168
1325
|
"patterns": {
|
|
1169
|
-
"description": "Defines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.",
|
|
1326
|
+
"description": "Defines a list of patterns that can be used with the `ignoreRegExpList` and `includeRegExpList` options.\n\nFor example:\n\n```javascript \"ignoreRegExpList\": [\"comments\"], \"patterns\": [ { \"name\": \"comment-single-line\", \"pattern\": \"/#.*/g\" }, { \"name\": \"comment-multi-line\", \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\" }, // You can also combine multiple named patterns into one single named pattern { \"name\": \"comments\", \"pattern\": [\"comment-single-line\", \"comment-multi-line\"] } ] ``` Defines a list of patterns that can be used with the `ignoreRegExpList` and `includeRegExpList` options.",
|
|
1170
1327
|
"items": {
|
|
1171
1328
|
"$ref": "#/definitions/RegExpPatternDefinition"
|
|
1172
1329
|
},
|
|
1173
|
-
"markdownDescription": "Defines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.\n\nFor example:\n\n```javascript\n\"ignoreRegExpList\": [\"comments\"],\n\"patterns\": [\n {\n \"name\": \"comment-single-line\",\n \"pattern\": \"/#.*/g\"\n },\n {\n \"name\": \"comment-multi-line\",\n \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"\n },\n // You can also combine multiple named patterns into one single named pattern\n {\n \"name\": \"comments\",\n \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]\n }\n]\n
|
|
1330
|
+
"markdownDescription": "Defines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.\n\nFor example:\n\n```javascript\n\"ignoreRegExpList\": [\"comments\"],\n\"patterns\": [\n {\n \"name\": \"comment-single-line\",\n \"pattern\": \"/#.*/g\"\n },\n {\n \"name\": \"comment-multi-line\",\n \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"\n },\n // You can also combine multiple named patterns into one single named pattern\n {\n \"name\": \"comments\",\n \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]\n }\n]\n```\nDefines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.",
|
|
1174
1331
|
"type": "array"
|
|
1175
1332
|
},
|
|
1176
1333
|
"pnpFiles": {
|
|
@@ -1182,10 +1339,11 @@
|
|
|
1182
1339
|
"items": {
|
|
1183
1340
|
"type": "string"
|
|
1184
1341
|
},
|
|
1342
|
+
"markdownDescription": "The PnP files to search for. Note: `.mjs` files are not currently supported.",
|
|
1185
1343
|
"type": "array"
|
|
1186
1344
|
},
|
|
1187
1345
|
"suggestWords": {
|
|
1188
|
-
"description": "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
|
|
1346
|
+
"description": "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.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`",
|
|
1189
1347
|
"items": {
|
|
1190
1348
|
"type": "string"
|
|
1191
1349
|
},
|
|
@@ -1194,18 +1352,20 @@
|
|
|
1194
1352
|
},
|
|
1195
1353
|
"suggestionNumChanges": {
|
|
1196
1354
|
"default": 3,
|
|
1197
|
-
"description": "The maximum number of changes allowed on a word to be considered a suggestions.",
|
|
1355
|
+
"description": "The maximum number of changes allowed on a word to be considered a suggestions.\n\nFor example, appending an `s` onto `example` -> `examples` is considered 1 change.\n\nRange: between 1 and 5.",
|
|
1198
1356
|
"markdownDescription": "The maximum number of changes allowed on a word to be considered a suggestions.\n\nFor example, appending an `s` onto `example` -> `examples` is considered 1 change.\n\nRange: between 1 and 5.",
|
|
1199
1357
|
"type": "number"
|
|
1200
1358
|
},
|
|
1201
1359
|
"suggestionsTimeout": {
|
|
1202
1360
|
"default": 500,
|
|
1203
1361
|
"description": "The maximum amount of time in milliseconds to generate suggestions for a word.",
|
|
1362
|
+
"markdownDescription": "The maximum amount of time in milliseconds to generate suggestions for a word.",
|
|
1204
1363
|
"type": "number"
|
|
1205
1364
|
},
|
|
1206
1365
|
"usePnP": {
|
|
1207
1366
|
"default": false,
|
|
1208
1367
|
"description": "Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in the repository.\n\nWhen true, the spell checker will search up the directory structure for the existence of a PnP file and load it.",
|
|
1368
|
+
"markdownDescription": "Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading\npackages stored in the repository.\n\nWhen true, the spell checker will search up the directory structure for the existence\nof a PnP file and load it.",
|
|
1209
1369
|
"type": "boolean"
|
|
1210
1370
|
},
|
|
1211
1371
|
"words": {
|
|
@@ -1213,6 +1373,7 @@
|
|
|
1213
1373
|
"items": {
|
|
1214
1374
|
"type": "string"
|
|
1215
1375
|
},
|
|
1376
|
+
"markdownDescription": "List of words to be considered correct.",
|
|
1216
1377
|
"type": "array"
|
|
1217
1378
|
}
|
|
1218
1379
|
},
|
|
@@ -1229,14 +1390,17 @@
|
|
|
1229
1390
|
"properties": {
|
|
1230
1391
|
"id": {
|
|
1231
1392
|
"description": "Id of the Adjustment, i.e. `short-compound`",
|
|
1393
|
+
"markdownDescription": "Id of the Adjustment, i.e. `short-compound`",
|
|
1232
1394
|
"type": "string"
|
|
1233
1395
|
},
|
|
1234
1396
|
"penalty": {
|
|
1235
1397
|
"description": "The amount of penalty to apply.",
|
|
1398
|
+
"markdownDescription": "The amount of penalty to apply.",
|
|
1236
1399
|
"type": "number"
|
|
1237
1400
|
},
|
|
1238
1401
|
"regexp": {
|
|
1239
1402
|
"description": "RegExp pattern to match",
|
|
1403
|
+
"markdownDescription": "RegExp pattern to match",
|
|
1240
1404
|
"type": "string"
|
|
1241
1405
|
}
|
|
1242
1406
|
},
|
|
@@ -1249,6 +1413,7 @@
|
|
|
1249
1413
|
},
|
|
1250
1414
|
"PatternId": {
|
|
1251
1415
|
"description": "This matches the name in a pattern definition.",
|
|
1416
|
+
"markdownDescription": "This matches the name in a pattern definition.",
|
|
1252
1417
|
"type": "string"
|
|
1253
1418
|
},
|
|
1254
1419
|
"PatternRef": {
|
|
@@ -1263,7 +1428,8 @@
|
|
|
1263
1428
|
"$ref": "#/definitions/PredefinedPatterns"
|
|
1264
1429
|
}
|
|
1265
1430
|
],
|
|
1266
|
-
"description": "A PatternRef is a Pattern or PatternId."
|
|
1431
|
+
"description": "A PatternRef is a Pattern or PatternId.",
|
|
1432
|
+
"markdownDescription": "A PatternRef is a Pattern or PatternId."
|
|
1267
1433
|
},
|
|
1268
1434
|
"PredefinedPatterns": {
|
|
1269
1435
|
"enum": [
|
|
@@ -1303,11 +1469,13 @@
|
|
|
1303
1469
|
"properties": {
|
|
1304
1470
|
"description": {
|
|
1305
1471
|
"description": "Description of the pattern.",
|
|
1472
|
+
"markdownDescription": "Description of the pattern.",
|
|
1306
1473
|
"type": "string"
|
|
1307
1474
|
},
|
|
1308
1475
|
"name": {
|
|
1309
1476
|
"$ref": "#/definitions/PatternId",
|
|
1310
|
-
"description": "Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList. It is possible to redefine one of the predefined patterns to override its value."
|
|
1477
|
+
"description": "Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList. It is possible to redefine one of the predefined patterns to override its value.",
|
|
1478
|
+
"markdownDescription": "Pattern name, used as an identifier in ignoreRegExpList and includeRegExpList.\nIt is possible to redefine one of the predefined patterns to override its value."
|
|
1311
1479
|
},
|
|
1312
1480
|
"pattern": {
|
|
1313
1481
|
"anyOf": [
|
|
@@ -1321,7 +1489,8 @@
|
|
|
1321
1489
|
"type": "array"
|
|
1322
1490
|
}
|
|
1323
1491
|
],
|
|
1324
|
-
"description": "RegExp pattern or array of RegExp patterns."
|
|
1492
|
+
"description": "RegExp pattern or array of RegExp patterns.",
|
|
1493
|
+
"markdownDescription": "RegExp pattern or array of RegExp patterns."
|
|
1325
1494
|
}
|
|
1326
1495
|
},
|
|
1327
1496
|
"required": [
|
|
@@ -1335,6 +1504,7 @@
|
|
|
1335
1504
|
"items": {
|
|
1336
1505
|
"$ref": "#/definitions/PatternRef"
|
|
1337
1506
|
},
|
|
1507
|
+
"markdownDescription": "A list of pattern names or regular expressions.",
|
|
1338
1508
|
"type": "array"
|
|
1339
1509
|
},
|
|
1340
1510
|
"ReplaceEntry": {
|
|
@@ -1353,11 +1523,13 @@
|
|
|
1353
1523
|
},
|
|
1354
1524
|
"ReporterModuleName": {
|
|
1355
1525
|
"description": "The module or path to the the reporter to load.",
|
|
1526
|
+
"markdownDescription": "The module or path to the the reporter to load.",
|
|
1356
1527
|
"type": "string"
|
|
1357
1528
|
},
|
|
1358
1529
|
"ReporterOptions": {
|
|
1359
1530
|
"$ref": "#/definitions/Serializable",
|
|
1360
|
-
"description": "Options to send to the reporter. These are defined by the reporter."
|
|
1531
|
+
"description": "Options to send to the reporter. These are defined by the reporter.",
|
|
1532
|
+
"markdownDescription": "Options to send to the reporter. These are defined by the reporter."
|
|
1361
1533
|
},
|
|
1362
1534
|
"ReporterSettings": {
|
|
1363
1535
|
"anyOf": [
|
|
@@ -1389,7 +1561,8 @@
|
|
|
1389
1561
|
"type": "array"
|
|
1390
1562
|
}
|
|
1391
1563
|
],
|
|
1392
|
-
"description": "Declare a reporter to use.\n\n`default` - is a special name for the default cli reporter.\n\nExamples:\n- `\"default\"` - to use the default reporter\n- `\"@cspell/cspell-json-reporter\"` - use the cspell JSON reporter.\n- `[\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]`"
|
|
1564
|
+
"description": "Declare a reporter to use.\n\n`default` - is a special name for the default cli reporter.\n\nExamples:\n- `\"default\"` - to use the default reporter\n- `\"@cspell/cspell-json-reporter\"` - use the cspell JSON reporter.\n- `[\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]`",
|
|
1565
|
+
"markdownDescription": "Declare a reporter to use.\n\n`default` - is a special name for the default cli reporter.\n\nExamples:\n- `\"default\"` - to use the default reporter\n- `\"@cspell/cspell-json-reporter\"` - use the cspell JSON reporter.\n- `[\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]`"
|
|
1393
1566
|
},
|
|
1394
1567
|
"Serializable": {
|
|
1395
1568
|
"anyOf": [
|
|
@@ -1412,6 +1585,7 @@
|
|
|
1412
1585
|
},
|
|
1413
1586
|
"SimpleGlob": {
|
|
1414
1587
|
"description": "Simple Glob string, the root will be globRoot.",
|
|
1588
|
+
"markdownDescription": "Simple Glob string, the root will be globRoot.",
|
|
1415
1589
|
"type": "string"
|
|
1416
1590
|
},
|
|
1417
1591
|
"SuggestionCostMapDef": {
|
|
@@ -1426,7 +1600,8 @@
|
|
|
1426
1600
|
"$ref": "#/definitions/CostMapDefSwap"
|
|
1427
1601
|
}
|
|
1428
1602
|
],
|
|
1429
|
-
"description": "A WeightedMapDef enables setting weights for edits between related characters and substrings.\n\nMultiple groups can be defined using a `|`. A multi-character substring is defined using `()`.\n\nFor example, in some languages, some letters sound alike.\n\n```yaml map: 'sc(sh)(sch)(ss)|t(tt)' # two groups. replace: 50 # Make it 1/2 the cost of a normal edit to replace a `t` with `tt`. ```\n\nThe following could be used to make inserting, removing, or replacing vowels cheaper. ```yaml map: 'aeiouy' insDel: 50 # Make it is cheaper to insert or delete a vowel. replace: 45 # It is even cheaper to replace one with another. ```\n\nNote: the default edit distance is 100."
|
|
1603
|
+
"description": "A WeightedMapDef enables setting weights for edits between related characters and substrings.\n\nMultiple groups can be defined using a `|`. A multi-character substring is defined using `()`.\n\nFor example, in some languages, some letters sound alike.\n\n```yaml map: 'sc(sh)(sch)(ss)|t(tt)' # two groups. replace: 50 # Make it 1/2 the cost of a normal edit to replace a `t` with `tt`. ```\n\nThe following could be used to make inserting, removing, or replacing vowels cheaper. ```yaml map: 'aeiouy' insDel: 50 # Make it is cheaper to insert or delete a vowel. replace: 45 # It is even cheaper to replace one with another. ```\n\nNote: the default edit distance is 100.",
|
|
1604
|
+
"markdownDescription": "A WeightedMapDef enables setting weights for edits between related characters and substrings.\n\nMultiple groups can be defined using a `|`.\nA multi-character substring is defined using `()`.\n\nFor example, in some languages, some letters sound alike.\n\n```yaml\n map: 'sc(sh)(sch)(ss)|t(tt)' # two groups.\n replace: 50 # Make it 1/2 the cost of a normal edit to replace a `t` with `tt`.\n```\n\nThe following could be used to make inserting, removing, or replacing vowels cheaper.\n```yaml\n map: 'aeiouy'\n insDel: 50 # Make it is cheaper to insert or delete a vowel.\n replace: 45 # It is even cheaper to replace one with another.\n```\n\nNote: the default edit distance is 100."
|
|
1430
1605
|
},
|
|
1431
1606
|
"SuggestionCostsDefs": {
|
|
1432
1607
|
"items": {
|
|
@@ -1447,6 +1622,7 @@
|
|
|
1447
1622
|
"VersionLatest": {
|
|
1448
1623
|
"const": "0.2",
|
|
1449
1624
|
"description": "Configuration File Version.",
|
|
1625
|
+
"markdownDescription": "Configuration File Version.",
|
|
1450
1626
|
"type": "string"
|
|
1451
1627
|
},
|
|
1452
1628
|
"VersionLegacy": {
|
|
@@ -1454,6 +1630,7 @@
|
|
|
1454
1630
|
"deprecated": true,
|
|
1455
1631
|
"deprecationMessage": "Use `0.2` instead.",
|
|
1456
1632
|
"description": "Legacy Configuration File Versions.",
|
|
1633
|
+
"markdownDescription": "Legacy Configuration File Versions.",
|
|
1457
1634
|
"type": "string"
|
|
1458
1635
|
}
|
|
1459
1636
|
},
|
|
@@ -1461,29 +1638,33 @@
|
|
|
1461
1638
|
"$schema": {
|
|
1462
1639
|
"default": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
|
|
1463
1640
|
"description": "Url to JSON Schema",
|
|
1641
|
+
"markdownDescription": "Url to JSON Schema",
|
|
1464
1642
|
"type": "string"
|
|
1465
1643
|
},
|
|
1466
1644
|
"allowCompoundWords": {
|
|
1467
1645
|
"default": false,
|
|
1468
|
-
"description": "True to enable compound word checking. See https://cspell.org/docs/case-sensitive/ for more details.",
|
|
1646
|
+
"description": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
|
|
1469
1647
|
"markdownDescription": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
|
|
1470
1648
|
"type": "boolean"
|
|
1471
1649
|
},
|
|
1472
1650
|
"cache": {
|
|
1473
1651
|
"$ref": "#/definitions/CacheSettings",
|
|
1474
|
-
"description": "Define cache settings."
|
|
1652
|
+
"description": "Define cache settings.",
|
|
1653
|
+
"markdownDescription": "Define cache settings."
|
|
1475
1654
|
},
|
|
1476
1655
|
"caseSensitive": {
|
|
1477
1656
|
"default": false,
|
|
1478
1657
|
"description": "Determines if words must match case and accent rules.\n\n- `false` - Case is ignored and accents can be missing on the entire word. Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.",
|
|
1658
|
+
"markdownDescription": "Determines if words must match case and accent rules.\n\n- `false` - Case is ignored and accents can be missing on the entire word.\n Incorrect accents or partially missing accents will be marked as incorrect.\n- `true` - Case and accents are enforced.",
|
|
1479
1659
|
"type": "boolean"
|
|
1480
1660
|
},
|
|
1481
1661
|
"description": {
|
|
1482
1662
|
"description": "Optional description of configuration.",
|
|
1663
|
+
"markdownDescription": "Optional description of configuration.",
|
|
1483
1664
|
"type": "string"
|
|
1484
1665
|
},
|
|
1485
1666
|
"dictionaries": {
|
|
1486
|
-
"description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.",
|
|
1667
|
+
"description": "Optional list of dictionaries to use. Each entry should match the name of the dictionary.\n\nTo remove a dictionary from the list, add `!` before the name.\n\nFor example, `!typescript` will turn off the dictionary with the name `typescript`.\n\nSee the [Dictionaries](https://cspell.org/docs/dictionaries/) and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.",
|
|
1487
1668
|
"items": {
|
|
1488
1669
|
"$ref": "#/definitions/DictionaryReference"
|
|
1489
1670
|
},
|
|
@@ -1495,9 +1676,11 @@
|
|
|
1495
1676
|
"items": {
|
|
1496
1677
|
"$ref": "#/definitions/DictionaryDefinition"
|
|
1497
1678
|
},
|
|
1679
|
+
"markdownDescription": "Define additional available dictionaries.\n\nFor example, you can use the following to add a custom dictionary:\n\n```json\n\"dictionaryDefinitions\": [\n { \"name\": \"custom-words\", \"path\": \"./custom-words.txt\"}\n],\n\"dictionaries\": [\"custom-words\"]\n```",
|
|
1498
1680
|
"type": "array"
|
|
1499
1681
|
},
|
|
1500
1682
|
"enableFiletypes": {
|
|
1683
|
+
"description": "Enable / Disable checking file types (languageIds).\n\nThese are in additional to the file types specified by `cSpell.enabledLanguageIds`.\n\nTo disable a language, prefix with `!` as in `!json`,\n\nExample: ``` jsonc // enable checking for jsonc !json // disable checking for json kotlin // enable checking for kotlin ```",
|
|
1501
1684
|
"items": {
|
|
1502
1685
|
"$ref": "#/definitions/LanguageIdSingle"
|
|
1503
1686
|
},
|
|
@@ -1510,11 +1693,13 @@
|
|
|
1510
1693
|
"enableGlobDot": {
|
|
1511
1694
|
"default": false,
|
|
1512
1695
|
"description": "Enable scanning files and directories beginning with `.` (period).\n\nBy default, CSpell does not scan `hidden` files.",
|
|
1696
|
+
"markdownDescription": "Enable scanning files and directories beginning with `.` (period).\n\nBy default, CSpell does not scan `hidden` files.",
|
|
1513
1697
|
"type": "boolean"
|
|
1514
1698
|
},
|
|
1515
1699
|
"enabled": {
|
|
1516
1700
|
"default": true,
|
|
1517
1701
|
"description": "Is the spell checker enabled.",
|
|
1702
|
+
"markdownDescription": "Is the spell checker enabled.",
|
|
1518
1703
|
"type": "boolean"
|
|
1519
1704
|
},
|
|
1520
1705
|
"enabledLanguageIds": {
|
|
@@ -1522,16 +1707,19 @@
|
|
|
1522
1707
|
"items": {
|
|
1523
1708
|
"$ref": "#/definitions/LanguageIdSingle"
|
|
1524
1709
|
},
|
|
1710
|
+
"markdownDescription": "languageIds for the files to spell check.",
|
|
1525
1711
|
"type": "array"
|
|
1526
1712
|
},
|
|
1527
1713
|
"failFast": {
|
|
1528
1714
|
"default": false,
|
|
1529
1715
|
"description": "Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks)",
|
|
1716
|
+
"markdownDescription": "Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks)",
|
|
1530
1717
|
"type": "boolean"
|
|
1531
1718
|
},
|
|
1532
1719
|
"features": {
|
|
1533
1720
|
"$ref": "#/definitions/Features",
|
|
1534
|
-
"description": "Configure CSpell features."
|
|
1721
|
+
"description": "Configure CSpell features.",
|
|
1722
|
+
"markdownDescription": "Configure CSpell features."
|
|
1535
1723
|
},
|
|
1536
1724
|
"files": {
|
|
1537
1725
|
"description": "Glob patterns of files to be checked.\n\nGlob patterns are relative to the `globRoot` of the configuration file that defines them.",
|
|
@@ -1542,7 +1730,7 @@
|
|
|
1542
1730
|
"type": "array"
|
|
1543
1731
|
},
|
|
1544
1732
|
"flagWords": {
|
|
1545
|
-
"description": "List of words to always be considered incorrect. Words found in `flagWords` override `words
|
|
1733
|
+
"description": "List of words to always be considered incorrect. Words found in `flagWords` override `words`.\n\nFormat of `flagWords`\n- single word entry - `word`\n- with suggestions - `word:suggestion` or `word->suggestion, suggestions`\n\nExample: ```ts \"flagWords\": [ \"color: colour\", \"incase: in case, encase\", \"canot->cannot\", \"cancelled->canceled\" ] ```",
|
|
1546
1734
|
"items": {
|
|
1547
1735
|
"type": "string"
|
|
1548
1736
|
},
|
|
@@ -1561,15 +1749,17 @@
|
|
|
1561
1749
|
"type": "array"
|
|
1562
1750
|
}
|
|
1563
1751
|
],
|
|
1564
|
-
"description": "Tells the spell checker to searching for `.gitignore` files when it reaches a matching root."
|
|
1752
|
+
"description": "Tells the spell checker to searching for `.gitignore` files when it reaches a matching root.",
|
|
1753
|
+
"markdownDescription": "Tells the spell checker to searching for `.gitignore` files when it reaches a matching root."
|
|
1565
1754
|
},
|
|
1566
1755
|
"globRoot": {
|
|
1567
1756
|
"$ref": "#/definitions/FSPathResolvable",
|
|
1568
|
-
"description": "The root to use for glob patterns found in this configuration.",
|
|
1757
|
+
"description": "The root to use for glob patterns found in this configuration. Default: location of the configuration file. For compatibility reasons, config files with version 0.1, the glob root will default to be `${cwd}`.\n\nUse `globRoot` to define a different location. `globRoot` can be relative to the location of this configuration file. Defining globRoot, does not impact imported configurations.\n\nSpecial Values:\n- `${cwd}` - will be replaced with the current working directory.\n- `.` - will be the location of the containing configuration file.",
|
|
1569
1758
|
"markdownDescription": "The root to use for glob patterns found in this configuration.\nDefault: location of the configuration file.\n For compatibility reasons, config files with version 0.1, the glob root will\n default to be `${cwd}`.\n\nUse `globRoot` to define a different location.\n`globRoot` can be relative to the location of this configuration file.\nDefining globRoot, does not impact imported configurations.\n\nSpecial Values:\n- `${cwd}` - will be replaced with the current working directory.\n- `.` - will be the location of the containing configuration file."
|
|
1570
1759
|
},
|
|
1571
1760
|
"id": {
|
|
1572
1761
|
"description": "Optional identifier.",
|
|
1762
|
+
"markdownDescription": "Optional identifier.",
|
|
1573
1763
|
"type": "string"
|
|
1574
1764
|
},
|
|
1575
1765
|
"ignorePaths": {
|
|
@@ -1577,11 +1767,12 @@
|
|
|
1577
1767
|
"items": {
|
|
1578
1768
|
"$ref": "#/definitions/Glob"
|
|
1579
1769
|
},
|
|
1770
|
+
"markdownDescription": "Glob patterns of files to be ignored.\n\nGlob patterns are relative to the `globRoot` of the configuration file that defines them.",
|
|
1580
1771
|
"type": "array"
|
|
1581
1772
|
},
|
|
1582
1773
|
"ignoreRegExpList": {
|
|
1583
1774
|
"$ref": "#/definitions/RegExpPatternList",
|
|
1584
|
-
"description": "List of regular expression patterns or pattern names to exclude from spell checking.",
|
|
1775
|
+
"description": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON ```json \"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"] ```\n\nYAML ```yaml ignoreRegExpList: - >- /\\b[A-Z]+\\b/g ```\n\nBy default, several patterns are excluded. See [Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).",
|
|
1585
1776
|
"markdownDescription": "List of regular expression patterns or pattern names to exclude from spell checking.\n\nExample: `[\"href\"]` - to exclude html href pattern.\n\nRegular expressions use JavaScript regular expression syntax.\n\nExample: to ignore ALL-CAPS words\n\nJSON\n```json\n\"ignoreRegExpList\": [\"/\\\\b[A-Z]+\\\\b/g\"]\n```\n\nYAML\n```yaml\nignoreRegExpList:\n - >-\n /\\b[A-Z]+\\b/g\n```\n\nBy default, several patterns are excluded. See\n[Configuration](https://cspell.org/configuration/patterns) for more details.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
|
|
1586
1777
|
},
|
|
1587
1778
|
"ignoreWords": {
|
|
@@ -1589,6 +1780,7 @@
|
|
|
1589
1780
|
"items": {
|
|
1590
1781
|
"type": "string"
|
|
1591
1782
|
},
|
|
1783
|
+
"markdownDescription": "List of words to be ignored. An ignored word will not show up as an error, even if it is\nalso in the `flagWords`.",
|
|
1592
1784
|
"type": "array"
|
|
1593
1785
|
},
|
|
1594
1786
|
"import": {
|
|
@@ -1603,25 +1795,27 @@
|
|
|
1603
1795
|
"type": "array"
|
|
1604
1796
|
}
|
|
1605
1797
|
],
|
|
1606
|
-
"description": "Allows this configuration to inherit configuration for one or more other files.\n\nSee https://cspell.org/configuration/imports/ for more details.",
|
|
1798
|
+
"description": "Allows this configuration to inherit configuration for one or more other files.\n\nSee [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details.",
|
|
1607
1799
|
"markdownDescription": "Allows this configuration to inherit configuration for one or more other files.\n\nSee [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details."
|
|
1608
1800
|
},
|
|
1609
1801
|
"includeRegExpList": {
|
|
1610
1802
|
"$ref": "#/definitions/RegExpPatternList",
|
|
1611
|
-
"description": "List of regular expression patterns or defined pattern names to match for spell checking.",
|
|
1803
|
+
"description": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).",
|
|
1612
1804
|
"markdownDescription": "List of regular expression patterns or defined pattern names to match for spell checking.\n\nIf this property is defined, only text matching the included patterns will be checked.\n\nWhile you can create your own patterns, you can also leverage several patterns that are\n[built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html)."
|
|
1613
1805
|
},
|
|
1614
1806
|
"language": {
|
|
1615
1807
|
"$ref": "#/definitions/LocaleId",
|
|
1616
1808
|
"default": "en",
|
|
1617
|
-
"description": "Current active spelling language. This specifies the language locale to use in choosing the general dictionary.\n\nFor example:\n\n- \"en-GB\" for British English.\n- \"en,nl\" to enable both English and Dutch."
|
|
1809
|
+
"description": "Current active spelling language. This specifies the language locale to use in choosing the general dictionary.\n\nFor example:\n\n- \"en-GB\" for British English.\n- \"en,nl\" to enable both English and Dutch.",
|
|
1810
|
+
"markdownDescription": "Current active spelling language. This specifies the language locale to use in choosing the\ngeneral dictionary.\n\nFor example:\n\n- \"en-GB\" for British English.\n- \"en,nl\" to enable both English and Dutch."
|
|
1618
1811
|
},
|
|
1619
1812
|
"languageId": {
|
|
1620
1813
|
"$ref": "#/definitions/MatchingFileType",
|
|
1621
|
-
"description": "Forces the spell checker to assume a give language id. Used mainly as an Override."
|
|
1814
|
+
"description": "Forces the spell checker to assume a give language id. Used mainly as an Override.",
|
|
1815
|
+
"markdownDescription": "Forces the spell checker to assume a give language id. Used mainly as an Override."
|
|
1622
1816
|
},
|
|
1623
1817
|
"languageSettings": {
|
|
1624
|
-
"description": "Additional settings for individual languages.",
|
|
1818
|
+
"description": "Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.",
|
|
1625
1819
|
"items": {
|
|
1626
1820
|
"$ref": "#/definitions/LanguageSetting"
|
|
1627
1821
|
},
|
|
@@ -1631,30 +1825,36 @@
|
|
|
1631
1825
|
"loadDefaultConfiguration": {
|
|
1632
1826
|
"default": true,
|
|
1633
1827
|
"description": "By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false` will prevent ALL default configuration from being loaded.",
|
|
1828
|
+
"markdownDescription": "By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false`\nwill prevent ALL default configuration from being loaded.",
|
|
1634
1829
|
"type": "boolean"
|
|
1635
1830
|
},
|
|
1636
1831
|
"maxDuplicateProblems": {
|
|
1637
1832
|
"default": 5,
|
|
1638
1833
|
"description": "The maximum number of times the same word can be flagged as an error in a file.",
|
|
1834
|
+
"markdownDescription": "The maximum number of times the same word can be flagged as an error in a file.",
|
|
1639
1835
|
"type": "number"
|
|
1640
1836
|
},
|
|
1641
1837
|
"maxNumberOfProblems": {
|
|
1642
1838
|
"default": 10000,
|
|
1643
1839
|
"description": "The maximum number of problems to report in a file.",
|
|
1840
|
+
"markdownDescription": "The maximum number of problems to report in a file.",
|
|
1644
1841
|
"type": "number"
|
|
1645
1842
|
},
|
|
1646
1843
|
"minWordLength": {
|
|
1647
1844
|
"default": 4,
|
|
1648
1845
|
"description": "The minimum length of a word before checking it against a dictionary.",
|
|
1846
|
+
"markdownDescription": "The minimum length of a word before checking it against a dictionary.",
|
|
1649
1847
|
"type": "number"
|
|
1650
1848
|
},
|
|
1651
1849
|
"name": {
|
|
1652
1850
|
"description": "Optional name of configuration.",
|
|
1851
|
+
"markdownDescription": "Optional name of configuration.",
|
|
1653
1852
|
"type": "string"
|
|
1654
1853
|
},
|
|
1655
1854
|
"noConfigSearch": {
|
|
1656
1855
|
"default": false,
|
|
1657
1856
|
"description": "Prevents searching for local configuration when checking individual documents.",
|
|
1857
|
+
"markdownDescription": "Prevents searching for local configuration when checking individual documents.",
|
|
1658
1858
|
"type": "boolean"
|
|
1659
1859
|
},
|
|
1660
1860
|
"noSuggestDictionaries": {
|
|
@@ -1662,15 +1862,17 @@
|
|
|
1662
1862
|
"items": {
|
|
1663
1863
|
"$ref": "#/definitions/DictionaryReference"
|
|
1664
1864
|
},
|
|
1865
|
+
"markdownDescription": "Optional list of dictionaries that will not be used for suggestions.\nWords in these dictionaries are considered correct, but will not be\nused when making spell correction suggestions.\n\nNote: if a word is suggested by another dictionary, but found in\none of these dictionaries, it will be removed from the set of\npossible suggestions.",
|
|
1665
1866
|
"type": "array"
|
|
1666
1867
|
},
|
|
1667
1868
|
"numSuggestions": {
|
|
1668
1869
|
"default": 10,
|
|
1669
1870
|
"description": "Number of suggestions to make.",
|
|
1871
|
+
"markdownDescription": "Number of suggestions to make.",
|
|
1670
1872
|
"type": "number"
|
|
1671
1873
|
},
|
|
1672
1874
|
"overrides": {
|
|
1673
|
-
"description": "Overrides are used to apply settings for specific files in your project
|
|
1875
|
+
"description": "Overrides are used to apply settings for specific files in your project.\n\nFor example:\n\n```javascript \"overrides\": [ // Force `*.hrr` and `*.crr` files to be treated as `cpp` files: { \"filename\": \"**/{*.hrr,*.crr}\", \"languageId\": \"cpp\" }, // Force `*.txt` to use the Dutch dictionary (Dutch dictionary needs to be installed separately): { \"language\": \"nl\", \"filename\": \"**/dutch/**/*.txt\" } ] ```",
|
|
1674
1876
|
"items": {
|
|
1675
1877
|
"$ref": "#/definitions/OverrideSettings"
|
|
1676
1878
|
},
|
|
@@ -1678,11 +1880,11 @@
|
|
|
1678
1880
|
"type": "array"
|
|
1679
1881
|
},
|
|
1680
1882
|
"patterns": {
|
|
1681
|
-
"description": "Defines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.",
|
|
1883
|
+
"description": "Defines a list of patterns that can be used with the `ignoreRegExpList` and `includeRegExpList` options.\n\nFor example:\n\n```javascript \"ignoreRegExpList\": [\"comments\"], \"patterns\": [ { \"name\": \"comment-single-line\", \"pattern\": \"/#.*/g\" }, { \"name\": \"comment-multi-line\", \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\" }, // You can also combine multiple named patterns into one single named pattern { \"name\": \"comments\", \"pattern\": [\"comment-single-line\", \"comment-multi-line\"] } ] ``` Defines a list of patterns that can be used with the `ignoreRegExpList` and `includeRegExpList` options.",
|
|
1682
1884
|
"items": {
|
|
1683
1885
|
"$ref": "#/definitions/RegExpPatternDefinition"
|
|
1684
1886
|
},
|
|
1685
|
-
"markdownDescription": "Defines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.\n\nFor example:\n\n```javascript\n\"ignoreRegExpList\": [\"comments\"],\n\"patterns\": [\n {\n \"name\": \"comment-single-line\",\n \"pattern\": \"/#.*/g\"\n },\n {\n \"name\": \"comment-multi-line\",\n \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"\n },\n // You can also combine multiple named patterns into one single named pattern\n {\n \"name\": \"comments\",\n \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]\n }\n]\n
|
|
1887
|
+
"markdownDescription": "Defines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.\n\nFor example:\n\n```javascript\n\"ignoreRegExpList\": [\"comments\"],\n\"patterns\": [\n {\n \"name\": \"comment-single-line\",\n \"pattern\": \"/#.*/g\"\n },\n {\n \"name\": \"comment-multi-line\",\n \"pattern\": \"/(?:\\\\/\\\\*[\\\\s\\\\S]*?\\\\*\\\\/)/g\"\n },\n // You can also combine multiple named patterns into one single named pattern\n {\n \"name\": \"comments\",\n \"pattern\": [\"comment-single-line\", \"comment-multi-line\"]\n }\n]\n```\nDefines a list of patterns that can be used with the `ignoreRegExpList` and\n`includeRegExpList` options.",
|
|
1686
1888
|
"type": "array"
|
|
1687
1889
|
},
|
|
1688
1890
|
"pnpFiles": {
|
|
@@ -1694,18 +1896,20 @@
|
|
|
1694
1896
|
"items": {
|
|
1695
1897
|
"type": "string"
|
|
1696
1898
|
},
|
|
1899
|
+
"markdownDescription": "The PnP files to search for. Note: `.mjs` files are not currently supported.",
|
|
1697
1900
|
"type": "array"
|
|
1698
1901
|
},
|
|
1699
1902
|
"readonly": {
|
|
1700
1903
|
"default": false,
|
|
1701
1904
|
"description": "Indicate that the configuration file should not be modified. This is used to prevent tools like the VS Code Spell Checker from modifying the file to add words and other configuration.",
|
|
1905
|
+
"markdownDescription": "Indicate that the configuration file should not be modified.\nThis is used to prevent tools like the VS Code Spell Checker from\nmodifying the file to add words and other configuration.",
|
|
1702
1906
|
"type": "boolean"
|
|
1703
1907
|
},
|
|
1704
1908
|
"reporters": {
|
|
1705
1909
|
"default": [
|
|
1706
1910
|
"default"
|
|
1707
1911
|
],
|
|
1708
|
-
"description": "Define which reports to use
|
|
1912
|
+
"description": "Define which reports to use. `default` - is a special name for the default cli reporter.\n\nExamples:\n- `[\"default\"]` - to use the default reporter\n- `[\"@cspell/cspell-json-reporter\"]` - use the cspell JSON reporter.\n- `[[\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]]`\n- `[ \"default\", [\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]]` - Use both the default reporter and the cspell-json-reporter.",
|
|
1709
1913
|
"items": {
|
|
1710
1914
|
"$ref": "#/definitions/ReporterSettings"
|
|
1711
1915
|
},
|
|
@@ -1715,15 +1919,17 @@
|
|
|
1715
1919
|
"showStatus": {
|
|
1716
1920
|
"deprecated": true,
|
|
1717
1921
|
"description": "Show status.",
|
|
1922
|
+
"markdownDescription": "Show status.",
|
|
1718
1923
|
"type": "boolean"
|
|
1719
1924
|
},
|
|
1720
1925
|
"spellCheckDelayMs": {
|
|
1721
1926
|
"deprecated": true,
|
|
1722
1927
|
"description": "Delay in ms after a document has changed before checking it for spelling errors.",
|
|
1928
|
+
"markdownDescription": "Delay in ms after a document has changed before checking it for spelling errors.",
|
|
1723
1929
|
"type": "number"
|
|
1724
1930
|
},
|
|
1725
1931
|
"suggestWords": {
|
|
1726
|
-
"description": "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
|
|
1932
|
+
"description": "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.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix) - `word: suggestion` - `word->suggestion`\n- Multiple suggestions (not auto fixable) - `word: first, second, third` - `word->first, second, third`",
|
|
1727
1933
|
"items": {
|
|
1728
1934
|
"type": "string"
|
|
1729
1935
|
},
|
|
@@ -1732,23 +1938,26 @@
|
|
|
1732
1938
|
},
|
|
1733
1939
|
"suggestionNumChanges": {
|
|
1734
1940
|
"default": 3,
|
|
1735
|
-
"description": "The maximum number of changes allowed on a word to be considered a suggestions.",
|
|
1941
|
+
"description": "The maximum number of changes allowed on a word to be considered a suggestions.\n\nFor example, appending an `s` onto `example` -> `examples` is considered 1 change.\n\nRange: between 1 and 5.",
|
|
1736
1942
|
"markdownDescription": "The maximum number of changes allowed on a word to be considered a suggestions.\n\nFor example, appending an `s` onto `example` -> `examples` is considered 1 change.\n\nRange: between 1 and 5.",
|
|
1737
1943
|
"type": "number"
|
|
1738
1944
|
},
|
|
1739
1945
|
"suggestionsTimeout": {
|
|
1740
1946
|
"default": 500,
|
|
1741
1947
|
"description": "The maximum amount of time in milliseconds to generate suggestions for a word.",
|
|
1948
|
+
"markdownDescription": "The maximum amount of time in milliseconds to generate suggestions for a word.",
|
|
1742
1949
|
"type": "number"
|
|
1743
1950
|
},
|
|
1744
1951
|
"useGitignore": {
|
|
1745
1952
|
"default": false,
|
|
1746
1953
|
"description": "Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found.",
|
|
1954
|
+
"markdownDescription": "Tells the spell checker to load `.gitignore` files and skip files that match the globs in the `.gitignore` files found.",
|
|
1747
1955
|
"type": "boolean"
|
|
1748
1956
|
},
|
|
1749
1957
|
"usePnP": {
|
|
1750
1958
|
"default": false,
|
|
1751
1959
|
"description": "Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading packages stored in the repository.\n\nWhen true, the spell checker will search up the directory structure for the existence of a PnP file and load it.",
|
|
1960
|
+
"markdownDescription": "Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading\npackages stored in the repository.\n\nWhen true, the spell checker will search up the directory structure for the existence\nof a PnP file and load it.",
|
|
1752
1961
|
"type": "boolean"
|
|
1753
1962
|
},
|
|
1754
1963
|
"userWords": {
|
|
@@ -1756,22 +1965,26 @@
|
|
|
1756
1965
|
"items": {
|
|
1757
1966
|
"type": "string"
|
|
1758
1967
|
},
|
|
1968
|
+
"markdownDescription": "Words to add to global dictionary -- should only be in the user config file.",
|
|
1759
1969
|
"type": "array"
|
|
1760
1970
|
},
|
|
1761
1971
|
"validateDirectives": {
|
|
1762
1972
|
"description": "Verify that the in-document directives are correct.",
|
|
1973
|
+
"markdownDescription": "Verify that the in-document directives are correct.",
|
|
1763
1974
|
"type": "boolean"
|
|
1764
1975
|
},
|
|
1765
1976
|
"version": {
|
|
1766
1977
|
"$ref": "#/definitions/Version",
|
|
1767
1978
|
"default": "0.2",
|
|
1768
|
-
"description": "Configuration format version of the settings file.\n\nThis controls how the settings in the configuration file behave."
|
|
1979
|
+
"description": "Configuration format version of the settings file.\n\nThis controls how the settings in the configuration file behave.",
|
|
1980
|
+
"markdownDescription": "Configuration format version of the settings file.\n\nThis controls how the settings in the configuration file behave."
|
|
1769
1981
|
},
|
|
1770
1982
|
"words": {
|
|
1771
1983
|
"description": "List of words to be considered correct.",
|
|
1772
1984
|
"items": {
|
|
1773
1985
|
"type": "string"
|
|
1774
1986
|
},
|
|
1987
|
+
"markdownDescription": "List of words to be considered correct.",
|
|
1775
1988
|
"type": "array"
|
|
1776
1989
|
}
|
|
1777
1990
|
},
|