@cspell/cspell-types 7.3.3 → 7.3.5

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.
@@ -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: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C 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: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C 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
  },
@@ -291,31 +336,38 @@
291
336
  },
292
337
  "DictionaryDefinitionCustom": {
293
338
  "additionalProperties": false,
294
- "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. Note: only plain text files with one word per line are supported at this moment.",
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. Scope 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: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C 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,13 +415,15 @@
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": {
@@ -374,6 +431,7 @@
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,34 +439,41 @@
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
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
  },
465
+ "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`",
403
466
  "type": "array"
404
467
  },
405
468
  "type": {
406
469
  "$ref": "#/definitions/DictionaryFileTypes",
407
470
  "default": "S",
408
- "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C 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."
409
473
  },
410
474
  "useCompounds": {
411
475
  "description": "Use Compounds.",
476
+ "markdownDescription": "Use Compounds.",
412
477
  "type": "boolean"
413
478
  },
414
479
  "words": {
@@ -416,6 +481,7 @@
416
481
  "items": {
417
482
  "type": "string"
418
483
  },
484
+ "markdownDescription": "List of words to be considered correct.",
419
485
  "type": "array"
420
486
  }
421
487
  },
@@ -430,6 +496,7 @@
430
496
  "properties": {
431
497
  "description": {
432
498
  "description": "Optional description.",
499
+ "markdownDescription": "Optional description.",
433
500
  "type": "string"
434
501
  },
435
502
  "flagWords": {
@@ -437,6 +504,7 @@
437
504
  "items": {
438
505
  "type": "string"
439
506
  },
507
+ "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```",
440
508
  "type": "array"
441
509
  },
442
510
  "ignoreWords": {
@@ -444,34 +512,41 @@
444
512
  "items": {
445
513
  "type": "string"
446
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`.",
447
516
  "type": "array"
448
517
  },
449
518
  "name": {
450
519
  "$ref": "#/definitions/DictionaryId",
451
- "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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
452
522
  },
453
523
  "noSuggest": {
454
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.",
455
526
  "type": "boolean"
456
527
  },
457
528
  "repMap": {
458
529
  "$ref": "#/definitions/ReplaceMap",
459
- "description": "Replacement pairs."
530
+ "description": "Replacement pairs.",
531
+ "markdownDescription": "Replacement pairs."
460
532
  },
461
533
  "suggestWords": {
462
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`",
463
535
  "items": {
464
536
  "type": "string"
465
537
  },
538
+ "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`",
466
539
  "type": "array"
467
540
  },
468
541
  "type": {
469
542
  "$ref": "#/definitions/DictionaryFileTypes",
470
543
  "default": "S",
471
- "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C 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."
472
546
  },
473
547
  "useCompounds": {
474
548
  "description": "Use Compounds.",
549
+ "markdownDescription": "Use Compounds.",
475
550
  "type": "boolean"
476
551
  },
477
552
  "words": {
@@ -479,6 +554,7 @@
479
554
  "items": {
480
555
  "type": "string"
481
556
  },
557
+ "markdownDescription": "List of words to be considered correct.",
482
558
  "type": "array"
483
559
  }
484
560
  },
@@ -493,6 +569,7 @@
493
569
  "properties": {
494
570
  "description": {
495
571
  "description": "Optional description.",
572
+ "markdownDescription": "Optional description.",
496
573
  "type": "string"
497
574
  },
498
575
  "flagWords": {
@@ -500,6 +577,7 @@
500
577
  "items": {
501
578
  "type": "string"
502
579
  },
580
+ "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```",
503
581
  "type": "array"
504
582
  },
505
583
  "ignoreWords": {
@@ -507,34 +585,41 @@
507
585
  "items": {
508
586
  "type": "string"
509
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`.",
510
589
  "type": "array"
511
590
  },
512
591
  "name": {
513
592
  "$ref": "#/definitions/DictionaryId",
514
- "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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
515
595
  },
516
596
  "noSuggest": {
517
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.",
518
599
  "type": "boolean"
519
600
  },
520
601
  "repMap": {
521
602
  "$ref": "#/definitions/ReplaceMap",
522
- "description": "Replacement pairs."
603
+ "description": "Replacement pairs.",
604
+ "markdownDescription": "Replacement pairs."
523
605
  },
524
606
  "suggestWords": {
525
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`",
526
608
  "items": {
527
609
  "type": "string"
528
610
  },
611
+ "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`",
529
612
  "type": "array"
530
613
  },
531
614
  "type": {
532
615
  "$ref": "#/definitions/DictionaryFileTypes",
533
616
  "default": "S",
534
- "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C 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."
535
619
  },
536
620
  "useCompounds": {
537
621
  "description": "Use Compounds.",
622
+ "markdownDescription": "Use Compounds.",
538
623
  "type": "boolean"
539
624
  },
540
625
  "words": {
@@ -542,6 +627,7 @@
542
627
  "items": {
543
628
  "type": "string"
544
629
  },
630
+ "markdownDescription": "List of words to be considered correct.",
545
631
  "type": "array"
546
632
  }
547
633
  },
@@ -556,31 +642,38 @@
556
642
  "properties": {
557
643
  "description": {
558
644
  "description": "Optional description.",
645
+ "markdownDescription": "Optional description.",
559
646
  "type": "string"
560
647
  },
561
648
  "name": {
562
649
  "$ref": "#/definitions/DictionaryId",
563
- "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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`."
564
652
  },
565
653
  "noSuggest": {
566
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.",
567
656
  "type": "boolean"
568
657
  },
569
658
  "path": {
570
659
  "$ref": "#/definitions/DictionaryPath",
571
- "description": "Path to the file."
660
+ "description": "Path to the file.",
661
+ "markdownDescription": "Path to the file."
572
662
  },
573
663
  "repMap": {
574
664
  "$ref": "#/definitions/ReplaceMap",
575
- "description": "Replacement pairs."
665
+ "description": "Replacement pairs.",
666
+ "markdownDescription": "Replacement pairs."
576
667
  },
577
668
  "type": {
578
669
  "$ref": "#/definitions/DictionaryFileTypes",
579
670
  "default": "S",
580
- "description": "Type of file: S - single word per line, W - each line can contain one or more words separated by space, C - each line is treated like code (Camel Case is allowed). Default is S. C 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."
581
673
  },
582
674
  "useCompounds": {
583
675
  "description": "Use Compounds.",
676
+ "markdownDescription": "Use Compounds.",
584
677
  "type": "boolean"
585
678
  }
586
679
  },
@@ -601,12 +694,14 @@
601
694
  },
602
695
  "DictionaryId": {
603
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 `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.",
604
698
  "pattern": "^(?=[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
605
699
  "type": "string"
606
700
  },
607
701
  "DictionaryInformation": {
608
702
  "additionalProperties": false,
609
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`.",
610
705
  "properties": {
611
706
  "accents": {
612
707
  "anyOf": [
@@ -620,13 +715,15 @@
620
715
  "type": "array"
621
716
  }
622
717
  ],
623
- "description": "The accent characters.\n\nDefault: `\"\\u0300-\\u0341\"`"
718
+ "description": "The accent characters.\n\nDefault: `\"\\u0300-\\u0341\"`",
719
+ "markdownDescription": "The accent characters.\n\nDefault: `\"\\u0300-\\u0341\"`"
624
720
  },
625
721
  "adjustments": {
626
722
  "description": "A collection of patterns to test against the suggested words. If the word matches the pattern, then the penalty is applied.",
627
723
  "items": {
628
724
  "$ref": "#/definitions/PatternAdjustment"
629
725
  },
726
+ "markdownDescription": "A collection of patterns to test against the suggested words.\nIf the word matches the pattern, then the penalty is applied.",
630
727
  "type": "array"
631
728
  },
632
729
  "alphabet": {
@@ -642,44 +739,53 @@
642
739
  }
643
740
  ],
644
741
  "default": "a-zA-Z",
645
- "description": "The alphabet to use."
742
+ "description": "The alphabet to use.",
743
+ "markdownDescription": "The alphabet to use."
646
744
  },
647
745
  "costs": {
648
746
  "$ref": "#/definitions/EditCosts",
649
- "description": "Define edit costs."
747
+ "description": "Define edit costs.",
748
+ "markdownDescription": "Define edit costs."
650
749
  },
651
750
  "hunspellInformation": {
652
751
  "$ref": "#/definitions/HunspellInformation",
653
- "description": "Used by dictionary authors"
752
+ "description": "Used by dictionary authors",
753
+ "markdownDescription": "Used by dictionary authors"
654
754
  },
655
755
  "ignore": {
656
756
  "$ref": "#/definitions/CharacterSet",
657
- "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."
658
759
  },
659
760
  "locale": {
660
761
  "description": "The locale of the dictionary. Example: `nl,nl-be`",
762
+ "markdownDescription": "The locale of the dictionary.\nExample: `nl,nl-be`",
661
763
  "type": "string"
662
764
  },
663
765
  "suggestionEditCosts": {
664
766
  "$ref": "#/definitions/SuggestionCostsDefs",
665
- "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."
666
769
  }
667
770
  },
668
771
  "type": "object"
669
772
  },
670
773
  "DictionaryNegRef": {
671
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>`.",
672
776
  "pattern": "^(?=!+[^!*,;{}[\\]~\\n]+$)(?=(.*\\w)).+$",
673
777
  "type": "string"
674
778
  },
675
779
  "DictionaryPath": {
676
780
  "description": "A File System Path to a dictionary file.",
781
+ "markdownDescription": "A File System Path to a dictionary file.",
677
782
  "pattern": "^.*\\.(?:txt|trie)(?:\\.gz)?$",
678
783
  "type": "string"
679
784
  },
680
785
  "DictionaryRef": {
681
786
  "$ref": "#/definitions/DictionaryId",
682
- "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."
683
789
  },
684
790
  "DictionaryReference": {
685
791
  "anyOf": [
@@ -690,7 +796,8 @@
690
796
  "$ref": "#/definitions/DictionaryNegRef"
691
797
  }
692
798
  ],
693
- "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 }"
694
801
  },
695
802
  "EditCosts": {
696
803
  "additionalProperties": false,
@@ -698,26 +805,31 @@
698
805
  "accentCosts": {
699
806
  "default": 1,
700
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.",
701
809
  "type": "number"
702
810
  },
703
811
  "baseCost": {
704
812
  "default": 100,
705
813
  "description": "This is the base cost for making an edit.",
814
+ "markdownDescription": "This is the base cost for making an edit.",
706
815
  "type": "number"
707
816
  },
708
817
  "capsCosts": {
709
818
  "default": 1,
710
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.",
711
821
  "type": "number"
712
822
  },
713
823
  "firstLetterPenalty": {
714
824
  "default": 4,
715
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`.",
716
827
  "type": "number"
717
828
  },
718
829
  "nonAlphabetCosts": {
719
830
  "default": 110,
720
831
  "description": "This is the cost for characters not in the alphabet.",
832
+ "markdownDescription": "This is the cost for characters not in the alphabet.",
721
833
  "type": "number"
722
834
  }
723
835
  },
@@ -725,7 +837,8 @@
725
837
  },
726
838
  "FSPathResolvable": {
727
839
  "$ref": "#/definitions/FsPath",
728
- "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."
729
842
  },
730
843
  "FeatureEnableOnly": {
731
844
  "type": "boolean"
@@ -733,84 +846,101 @@
733
846
  "Features": {
734
847
  "additionalProperties": false,
735
848
  "description": "Features are behaviors or settings that can be explicitly configured.",
849
+ "markdownDescription": "Features are behaviors or settings that can be explicitly configured.",
736
850
  "properties": {
737
851
  "weighted-suggestions": {
738
852
  "$ref": "#/definitions/FeatureEnableOnly",
739
- "description": "Enable/disable using weighted suggestions."
853
+ "description": "Enable/disable using weighted suggestions.",
854
+ "markdownDescription": "Enable/disable using weighted suggestions."
740
855
  }
741
856
  },
742
857
  "type": "object"
743
858
  },
744
859
  "FsDictionaryPath": {
745
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.",
746
862
  "type": "string"
747
863
  },
748
864
  "FsPath": {
749
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.",
750
867
  "type": "string"
751
868
  },
752
869
  "Glob": {
753
870
  "$ref": "#/definitions/SimpleGlob",
754
- "description": "These are glob expressions."
871
+ "description": "These are glob expressions.",
872
+ "markdownDescription": "These are glob expressions."
755
873
  },
756
874
  "HunspellInformation": {
757
875
  "additionalProperties": false,
758
876
  "properties": {
759
877
  "aff": {
760
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) ```",
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```",
761
880
  "type": "string"
762
881
  },
763
882
  "costs": {
764
883
  "additionalProperties": false,
765
884
  "description": "The costs to apply when using the hunspell settings",
885
+ "markdownDescription": "The costs to apply when using the hunspell settings",
766
886
  "properties": {
767
887
  "accentCosts": {
768
888
  "default": 1,
769
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.",
770
891
  "type": "number"
771
892
  },
772
893
  "baseCost": {
773
894
  "default": 100,
774
895
  "description": "This is the base cost for making an edit.",
896
+ "markdownDescription": "This is the base cost for making an edit.",
775
897
  "type": "number"
776
898
  },
777
899
  "capsCosts": {
778
900
  "default": 1,
779
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.",
780
903
  "type": "number"
781
904
  },
782
905
  "firstLetterPenalty": {
783
906
  "default": 4,
784
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`.",
785
909
  "type": "number"
786
910
  },
787
911
  "ioConvertCost": {
788
912
  "default": 30,
789
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.",
790
915
  "type": "number"
791
916
  },
792
917
  "keyboardCost": {
793
918
  "default": 99,
794
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`.",
795
921
  "type": "number"
796
922
  },
797
923
  "mapCost": {
798
924
  "default": 25,
799
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.",
800
927
  "type": "number"
801
928
  },
802
929
  "nonAlphabetCosts": {
803
930
  "default": 110,
804
931
  "description": "This is the cost for characters not in the alphabet.",
932
+ "markdownDescription": "This is the cost for characters not in the alphabet.",
805
933
  "type": "number"
806
934
  },
807
935
  "replaceCosts": {
808
936
  "default": 75,
809
937
  "description": "The cost to substitute pairs found in the replace settings.",
938
+ "markdownDescription": "The cost to substitute pairs found in the replace settings.",
810
939
  "type": "number"
811
940
  },
812
941
  "tryCharCost": {
813
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`",
814
944
  "type": "number"
815
945
  }
816
946
  },
@@ -837,16 +967,19 @@
837
967
  },
838
968
  "LanguageIdMultiple": {
839
969
  "description": "This can be 'typescript,cpp,json,literal haskell', etc.",
970
+ "markdownDescription": "This can be 'typescript,cpp,json,literal haskell', etc.",
840
971
  "pattern": "^([-\\w_\\s]+)(,[-\\w_\\s]+)*$",
841
972
  "type": "string"
842
973
  },
843
974
  "LanguageIdMultipleNeg": {
844
975
  "description": "This can be 'typescript,cpp,json,literal haskell', etc.",
976
+ "markdownDescription": "This can be 'typescript,cpp,json,literal haskell', etc.",
845
977
  "pattern": "^(![-\\w_\\s]+)(,![-\\w_\\s]+)*$",
846
978
  "type": "string"
847
979
  },
848
980
  "LanguageIdSingle": {
849
981
  "description": "This can be '*', 'typescript', 'cpp', 'json', etc.",
982
+ "markdownDescription": "This can be '*', 'typescript', 'cpp', 'json', etc.",
850
983
  "pattern": "^(!?[-\\w_\\s]+)|(\\*)$",
851
984
  "type": "string"
852
985
  },
@@ -856,15 +989,18 @@
856
989
  "allowCompoundWords": {
857
990
  "default": false,
858
991
  "description": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
992
+ "markdownDescription": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
859
993
  "type": "boolean"
860
994
  },
861
995
  "caseSensitive": {
862
996
  "default": false,
863
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.",
864
999
  "type": "boolean"
865
1000
  },
866
1001
  "description": {
867
1002
  "description": "Optional description of configuration.",
1003
+ "markdownDescription": "Optional description of configuration.",
868
1004
  "type": "string"
869
1005
  },
870
1006
  "dictionaries": {
@@ -872,6 +1008,7 @@
872
1008
  "items": {
873
1009
  "$ref": "#/definitions/DictionaryReference"
874
1010
  },
1011
+ "markdownDescription": "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/)\nand [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.",
875
1012
  "type": "array"
876
1013
  },
877
1014
  "dictionaryDefinitions": {
@@ -879,11 +1016,13 @@
879
1016
  "items": {
880
1017
  "$ref": "#/definitions/DictionaryDefinition"
881
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```",
882
1020
  "type": "array"
883
1021
  },
884
1022
  "enabled": {
885
1023
  "default": true,
886
1024
  "description": "Is the spell checker enabled.",
1025
+ "markdownDescription": "Is the spell checker enabled.",
887
1026
  "type": "boolean"
888
1027
  },
889
1028
  "flagWords": {
@@ -891,30 +1030,36 @@
891
1030
  "items": {
892
1031
  "type": "string"
893
1032
  },
1033
+ "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```",
894
1034
  "type": "array"
895
1035
  },
896
1036
  "id": {
897
1037
  "description": "Optional identifier.",
1038
+ "markdownDescription": "Optional identifier.",
898
1039
  "type": "string"
899
1040
  },
900
1041
  "ignoreRegExpList": {
901
1042
  "$ref": "#/definitions/RegExpPatternList",
902
- "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)."
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).",
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)."
903
1045
  },
904
1046
  "ignoreWords": {
905
1047
  "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
906
1048
  "items": {
907
1049
  "type": "string"
908
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`.",
909
1052
  "type": "array"
910
1053
  },
911
1054
  "includeRegExpList": {
912
1055
  "$ref": "#/definitions/RegExpPatternList",
913
- "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)."
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).",
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)."
914
1058
  },
915
1059
  "languageId": {
916
1060
  "$ref": "#/definitions/MatchingFileType",
917
- "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."
918
1063
  },
919
1064
  "local": {
920
1065
  "anyOf": [
@@ -930,7 +1075,8 @@
930
1075
  ],
931
1076
  "deprecated": true,
932
1077
  "deprecationMessage": "Use `locale` instead.",
933
- "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."
934
1080
  },
935
1081
  "locale": {
936
1082
  "anyOf": [
@@ -944,10 +1090,12 @@
944
1090
  "type": "array"
945
1091
  }
946
1092
  ],
947
- "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."
948
1095
  },
949
1096
  "name": {
950
1097
  "description": "Optional name of configuration.",
1098
+ "markdownDescription": "Optional name of configuration.",
951
1099
  "type": "string"
952
1100
  },
953
1101
  "noSuggestDictionaries": {
@@ -955,13 +1103,15 @@
955
1103
  "items": {
956
1104
  "$ref": "#/definitions/DictionaryReference"
957
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.",
958
1107
  "type": "array"
959
1108
  },
960
1109
  "patterns": {
961
- "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\"] } ] ```",
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.",
962
1111
  "items": {
963
1112
  "$ref": "#/definitions/RegExpPatternDefinition"
964
1113
  },
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.",
965
1115
  "type": "array"
966
1116
  },
967
1117
  "suggestWords": {
@@ -969,6 +1119,7 @@
969
1119
  "items": {
970
1120
  "type": "string"
971
1121
  },
1122
+ "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`",
972
1123
  "type": "array"
973
1124
  },
974
1125
  "words": {
@@ -976,6 +1127,7 @@
976
1127
  "items": {
977
1128
  "type": "string"
978
1129
  },
1130
+ "markdownDescription": "List of words to be considered correct.",
979
1131
  "type": "array"
980
1132
  }
981
1133
  },
@@ -986,6 +1138,7 @@
986
1138
  },
987
1139
  "LocaleId": {
988
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.",
989
1142
  "type": "string"
990
1143
  },
991
1144
  "MatchingFileType": {
@@ -1007,15 +1160,18 @@
1007
1160
  "allowCompoundWords": {
1008
1161
  "default": false,
1009
1162
  "description": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
1163
+ "markdownDescription": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
1010
1164
  "type": "boolean"
1011
1165
  },
1012
1166
  "caseSensitive": {
1013
1167
  "default": false,
1014
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.",
1015
1170
  "type": "boolean"
1016
1171
  },
1017
1172
  "description": {
1018
1173
  "description": "Optional description of configuration.",
1174
+ "markdownDescription": "Optional description of configuration.",
1019
1175
  "type": "string"
1020
1176
  },
1021
1177
  "dictionaries": {
@@ -1023,6 +1179,7 @@
1023
1179
  "items": {
1024
1180
  "$ref": "#/definitions/DictionaryReference"
1025
1181
  },
1182
+ "markdownDescription": "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/)\nand [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.",
1026
1183
  "type": "array"
1027
1184
  },
1028
1185
  "dictionaryDefinitions": {
@@ -1030,13 +1187,15 @@
1030
1187
  "items": {
1031
1188
  "$ref": "#/definitions/DictionaryDefinition"
1032
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```",
1033
1191
  "type": "array"
1034
1192
  },
1035
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 ```",
1036
1195
  "items": {
1037
1196
  "$ref": "#/definitions/LanguageIdSingle"
1038
1197
  },
1039
- "markdownDescription": "Enable / Disable checking file types (languageIds).\nThese are in additional to the file types specified by `cSpell.enabledLanguageIds`.\nTo disable a language, prefix with `!` as in `!json`,\n\nExample:\n```\njsonc // enable checking for jsonc\n!json // disable checking for json\nkotlin // enable checking for kotlin\n```",
1198
+ "markdownDescription": "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:\n```\njsonc // enable checking for jsonc\n!json // disable checking for json\nkotlin // enable checking for kotlin\n```",
1040
1199
  "scope": "resource",
1041
1200
  "title": "File Types to Check",
1042
1201
  "type": "array",
@@ -1045,6 +1204,7 @@
1045
1204
  "enabled": {
1046
1205
  "default": true,
1047
1206
  "description": "Is the spell checker enabled.",
1207
+ "markdownDescription": "Is the spell checker enabled.",
1048
1208
  "type": "boolean"
1049
1209
  },
1050
1210
  "enabledLanguageIds": {
@@ -1052,6 +1212,7 @@
1052
1212
  "items": {
1053
1213
  "$ref": "#/definitions/LanguageIdSingle"
1054
1214
  },
1215
+ "markdownDescription": "languageIds for the files to spell check.",
1055
1216
  "type": "array"
1056
1217
  },
1057
1218
  "filename": {
@@ -1066,71 +1227,85 @@
1066
1227
  "type": "array"
1067
1228
  }
1068
1229
  ],
1069
- "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."
1070
1232
  },
1071
1233
  "flagWords": {
1072
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\" ] ```",
1073
1235
  "items": {
1074
1236
  "type": "string"
1075
1237
  },
1238
+ "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```",
1076
1239
  "type": "array"
1077
1240
  },
1078
1241
  "id": {
1079
1242
  "description": "Optional identifier.",
1243
+ "markdownDescription": "Optional identifier.",
1080
1244
  "type": "string"
1081
1245
  },
1082
1246
  "ignoreRegExpList": {
1083
1247
  "$ref": "#/definitions/RegExpPatternList",
1084
- "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)."
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).",
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)."
1085
1250
  },
1086
1251
  "ignoreWords": {
1087
1252
  "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
1088
1253
  "items": {
1089
1254
  "type": "string"
1090
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`.",
1091
1257
  "type": "array"
1092
1258
  },
1093
1259
  "includeRegExpList": {
1094
1260
  "$ref": "#/definitions/RegExpPatternList",
1095
- "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)."
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).",
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)."
1096
1263
  },
1097
1264
  "language": {
1098
1265
  "$ref": "#/definitions/LocaleId",
1099
- "description": "Sets the locale."
1266
+ "description": "Sets the locale.",
1267
+ "markdownDescription": "Sets the locale."
1100
1268
  },
1101
1269
  "languageId": {
1102
1270
  "$ref": "#/definitions/MatchingFileType",
1103
- "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."
1104
1273
  },
1105
1274
  "languageSettings": {
1106
1275
  "description": "Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.",
1107
1276
  "items": {
1108
1277
  "$ref": "#/definitions/LanguageSetting"
1109
1278
  },
1279
+ "markdownDescription": "Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.",
1110
1280
  "type": "array"
1111
1281
  },
1112
1282
  "loadDefaultConfiguration": {
1113
1283
  "default": true,
1114
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.",
1115
1286
  "type": "boolean"
1116
1287
  },
1117
1288
  "maxDuplicateProblems": {
1118
1289
  "default": 5,
1119
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.",
1120
1292
  "type": "number"
1121
1293
  },
1122
1294
  "maxNumberOfProblems": {
1123
1295
  "default": 10000,
1124
1296
  "description": "The maximum number of problems to report in a file.",
1297
+ "markdownDescription": "The maximum number of problems to report in a file.",
1125
1298
  "type": "number"
1126
1299
  },
1127
1300
  "minWordLength": {
1128
1301
  "default": 4,
1129
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.",
1130
1304
  "type": "number"
1131
1305
  },
1132
1306
  "name": {
1133
1307
  "description": "Optional name of configuration.",
1308
+ "markdownDescription": "Optional name of configuration.",
1134
1309
  "type": "string"
1135
1310
  },
1136
1311
  "noSuggestDictionaries": {
@@ -1138,18 +1313,21 @@
1138
1313
  "items": {
1139
1314
  "$ref": "#/definitions/DictionaryReference"
1140
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.",
1141
1317
  "type": "array"
1142
1318
  },
1143
1319
  "numSuggestions": {
1144
1320
  "default": 10,
1145
1321
  "description": "Number of suggestions to make.",
1322
+ "markdownDescription": "Number of suggestions to make.",
1146
1323
  "type": "number"
1147
1324
  },
1148
1325
  "patterns": {
1149
- "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\"] } ] ```",
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.",
1150
1327
  "items": {
1151
1328
  "$ref": "#/definitions/RegExpPatternDefinition"
1152
1329
  },
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.",
1153
1331
  "type": "array"
1154
1332
  },
1155
1333
  "pnpFiles": {
@@ -1161,6 +1339,7 @@
1161
1339
  "items": {
1162
1340
  "type": "string"
1163
1341
  },
1342
+ "markdownDescription": "The PnP files to search for. Note: `.mjs` files are not currently supported.",
1164
1343
  "type": "array"
1165
1344
  },
1166
1345
  "suggestWords": {
@@ -1168,21 +1347,25 @@
1168
1347
  "items": {
1169
1348
  "type": "string"
1170
1349
  },
1350
+ "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`",
1171
1351
  "type": "array"
1172
1352
  },
1173
1353
  "suggestionNumChanges": {
1174
1354
  "default": 3,
1175
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.",
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.",
1176
1357
  "type": "number"
1177
1358
  },
1178
1359
  "suggestionsTimeout": {
1179
1360
  "default": 500,
1180
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.",
1181
1363
  "type": "number"
1182
1364
  },
1183
1365
  "usePnP": {
1184
1366
  "default": false,
1185
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.",
1186
1369
  "type": "boolean"
1187
1370
  },
1188
1371
  "words": {
@@ -1190,6 +1373,7 @@
1190
1373
  "items": {
1191
1374
  "type": "string"
1192
1375
  },
1376
+ "markdownDescription": "List of words to be considered correct.",
1193
1377
  "type": "array"
1194
1378
  }
1195
1379
  },
@@ -1206,14 +1390,17 @@
1206
1390
  "properties": {
1207
1391
  "id": {
1208
1392
  "description": "Id of the Adjustment, i.e. `short-compound`",
1393
+ "markdownDescription": "Id of the Adjustment, i.e. `short-compound`",
1209
1394
  "type": "string"
1210
1395
  },
1211
1396
  "penalty": {
1212
1397
  "description": "The amount of penalty to apply.",
1398
+ "markdownDescription": "The amount of penalty to apply.",
1213
1399
  "type": "number"
1214
1400
  },
1215
1401
  "regexp": {
1216
1402
  "description": "RegExp pattern to match",
1403
+ "markdownDescription": "RegExp pattern to match",
1217
1404
  "type": "string"
1218
1405
  }
1219
1406
  },
@@ -1226,6 +1413,7 @@
1226
1413
  },
1227
1414
  "PatternId": {
1228
1415
  "description": "This matches the name in a pattern definition.",
1416
+ "markdownDescription": "This matches the name in a pattern definition.",
1229
1417
  "type": "string"
1230
1418
  },
1231
1419
  "PatternRef": {
@@ -1240,7 +1428,8 @@
1240
1428
  "$ref": "#/definitions/PredefinedPatterns"
1241
1429
  }
1242
1430
  ],
1243
- "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."
1244
1433
  },
1245
1434
  "PredefinedPatterns": {
1246
1435
  "enum": [
@@ -1280,11 +1469,13 @@
1280
1469
  "properties": {
1281
1470
  "description": {
1282
1471
  "description": "Description of the pattern.",
1472
+ "markdownDescription": "Description of the pattern.",
1283
1473
  "type": "string"
1284
1474
  },
1285
1475
  "name": {
1286
1476
  "$ref": "#/definitions/PatternId",
1287
- "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."
1288
1479
  },
1289
1480
  "pattern": {
1290
1481
  "anyOf": [
@@ -1298,7 +1489,8 @@
1298
1489
  "type": "array"
1299
1490
  }
1300
1491
  ],
1301
- "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."
1302
1494
  }
1303
1495
  },
1304
1496
  "required": [
@@ -1312,6 +1504,7 @@
1312
1504
  "items": {
1313
1505
  "$ref": "#/definitions/PatternRef"
1314
1506
  },
1507
+ "markdownDescription": "A list of pattern names or regular expressions.",
1315
1508
  "type": "array"
1316
1509
  },
1317
1510
  "ReplaceEntry": {
@@ -1330,11 +1523,13 @@
1330
1523
  },
1331
1524
  "ReporterModuleName": {
1332
1525
  "description": "The module or path to the the reporter to load.",
1526
+ "markdownDescription": "The module or path to the the reporter to load.",
1333
1527
  "type": "string"
1334
1528
  },
1335
1529
  "ReporterOptions": {
1336
1530
  "$ref": "#/definitions/Serializable",
1337
- "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."
1338
1533
  },
1339
1534
  "ReporterSettings": {
1340
1535
  "anyOf": [
@@ -1366,7 +1561,8 @@
1366
1561
  "type": "array"
1367
1562
  }
1368
1563
  ],
1369
- "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\" }]`"
1370
1566
  },
1371
1567
  "Serializable": {
1372
1568
  "anyOf": [
@@ -1389,6 +1585,7 @@
1389
1585
  },
1390
1586
  "SimpleGlob": {
1391
1587
  "description": "Simple Glob string, the root will be globRoot.",
1588
+ "markdownDescription": "Simple Glob string, the root will be globRoot.",
1392
1589
  "type": "string"
1393
1590
  },
1394
1591
  "SuggestionCostMapDef": {
@@ -1403,7 +1600,8 @@
1403
1600
  "$ref": "#/definitions/CostMapDefSwap"
1404
1601
  }
1405
1602
  ],
1406
- "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."
1407
1605
  },
1408
1606
  "SuggestionCostsDefs": {
1409
1607
  "items": {
@@ -1424,6 +1622,7 @@
1424
1622
  "VersionLatest": {
1425
1623
  "const": "0.2",
1426
1624
  "description": "Configuration File Version.",
1625
+ "markdownDescription": "Configuration File Version.",
1427
1626
  "type": "string"
1428
1627
  },
1429
1628
  "VersionLegacy": {
@@ -1431,6 +1630,7 @@
1431
1630
  "deprecated": true,
1432
1631
  "deprecationMessage": "Use `0.2` instead.",
1433
1632
  "description": "Legacy Configuration File Versions.",
1633
+ "markdownDescription": "Legacy Configuration File Versions.",
1434
1634
  "type": "string"
1435
1635
  }
1436
1636
  },
@@ -1438,24 +1638,29 @@
1438
1638
  "$schema": {
1439
1639
  "default": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
1440
1640
  "description": "Url to JSON Schema",
1641
+ "markdownDescription": "Url to JSON Schema",
1441
1642
  "type": "string"
1442
1643
  },
1443
1644
  "allowCompoundWords": {
1444
1645
  "default": false,
1445
1646
  "description": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
1647
+ "markdownDescription": "True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.",
1446
1648
  "type": "boolean"
1447
1649
  },
1448
1650
  "cache": {
1449
1651
  "$ref": "#/definitions/CacheSettings",
1450
- "description": "Define cache settings."
1652
+ "description": "Define cache settings.",
1653
+ "markdownDescription": "Define cache settings."
1451
1654
  },
1452
1655
  "caseSensitive": {
1453
1656
  "default": false,
1454
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.",
1455
1659
  "type": "boolean"
1456
1660
  },
1457
1661
  "description": {
1458
1662
  "description": "Optional description of configuration.",
1663
+ "markdownDescription": "Optional description of configuration.",
1459
1664
  "type": "string"
1460
1665
  },
1461
1666
  "dictionaries": {
@@ -1463,6 +1668,7 @@
1463
1668
  "items": {
1464
1669
  "$ref": "#/definitions/DictionaryReference"
1465
1670
  },
1671
+ "markdownDescription": "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/)\nand [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.",
1466
1672
  "type": "array"
1467
1673
  },
1468
1674
  "dictionaryDefinitions": {
@@ -1470,13 +1676,15 @@
1470
1676
  "items": {
1471
1677
  "$ref": "#/definitions/DictionaryDefinition"
1472
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```",
1473
1680
  "type": "array"
1474
1681
  },
1475
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 ```",
1476
1684
  "items": {
1477
1685
  "$ref": "#/definitions/LanguageIdSingle"
1478
1686
  },
1479
- "markdownDescription": "Enable / Disable checking file types (languageIds).\nThese are in additional to the file types specified by `cSpell.enabledLanguageIds`.\nTo disable a language, prefix with `!` as in `!json`,\n\nExample:\n```\njsonc // enable checking for jsonc\n!json // disable checking for json\nkotlin // enable checking for kotlin\n```",
1687
+ "markdownDescription": "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:\n```\njsonc // enable checking for jsonc\n!json // disable checking for json\nkotlin // enable checking for kotlin\n```",
1480
1688
  "scope": "resource",
1481
1689
  "title": "File Types to Check",
1482
1690
  "type": "array",
@@ -1485,11 +1693,13 @@
1485
1693
  "enableGlobDot": {
1486
1694
  "default": false,
1487
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.",
1488
1697
  "type": "boolean"
1489
1698
  },
1490
1699
  "enabled": {
1491
1700
  "default": true,
1492
1701
  "description": "Is the spell checker enabled.",
1702
+ "markdownDescription": "Is the spell checker enabled.",
1493
1703
  "type": "boolean"
1494
1704
  },
1495
1705
  "enabledLanguageIds": {
@@ -1497,22 +1707,26 @@
1497
1707
  "items": {
1498
1708
  "$ref": "#/definitions/LanguageIdSingle"
1499
1709
  },
1710
+ "markdownDescription": "languageIds for the files to spell check.",
1500
1711
  "type": "array"
1501
1712
  },
1502
1713
  "failFast": {
1503
1714
  "default": false,
1504
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)",
1505
1717
  "type": "boolean"
1506
1718
  },
1507
1719
  "features": {
1508
1720
  "$ref": "#/definitions/Features",
1509
- "description": "Configure CSpell features."
1721
+ "description": "Configure CSpell features.",
1722
+ "markdownDescription": "Configure CSpell features."
1510
1723
  },
1511
1724
  "files": {
1512
1725
  "description": "Glob patterns of files to be checked.\n\nGlob patterns are relative to the `globRoot` of the configuration file that defines them.",
1513
1726
  "items": {
1514
1727
  "$ref": "#/definitions/Glob"
1515
1728
  },
1729
+ "markdownDescription": "Glob patterns of files to be checked.\n\nGlob patterns are relative to the `globRoot` of the configuration file that defines them.",
1516
1730
  "type": "array"
1517
1731
  },
1518
1732
  "flagWords": {
@@ -1520,6 +1734,7 @@
1520
1734
  "items": {
1521
1735
  "type": "string"
1522
1736
  },
1737
+ "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```",
1523
1738
  "type": "array"
1524
1739
  },
1525
1740
  "gitignoreRoot": {
@@ -1534,14 +1749,17 @@
1534
1749
  "type": "array"
1535
1750
  }
1536
1751
  ],
1537
- "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."
1538
1754
  },
1539
1755
  "globRoot": {
1540
1756
  "$ref": "#/definitions/FSPathResolvable",
1541
- "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."
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.",
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."
1542
1759
  },
1543
1760
  "id": {
1544
1761
  "description": "Optional identifier.",
1762
+ "markdownDescription": "Optional identifier.",
1545
1763
  "type": "string"
1546
1764
  },
1547
1765
  "ignorePaths": {
@@ -1549,17 +1767,20 @@
1549
1767
  "items": {
1550
1768
  "$ref": "#/definitions/Glob"
1551
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.",
1552
1771
  "type": "array"
1553
1772
  },
1554
1773
  "ignoreRegExpList": {
1555
1774
  "$ref": "#/definitions/RegExpPatternList",
1556
- "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)."
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).",
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)."
1557
1777
  },
1558
1778
  "ignoreWords": {
1559
1779
  "description": "List of words to be ignored. An ignored word will not show up as an error, even if it is also in the `flagWords`.",
1560
1780
  "items": {
1561
1781
  "type": "string"
1562
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`.",
1563
1784
  "type": "array"
1564
1785
  },
1565
1786
  "import": {
@@ -1574,55 +1795,66 @@
1574
1795
  "type": "array"
1575
1796
  }
1576
1797
  ],
1577
- "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."
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.",
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."
1578
1800
  },
1579
1801
  "includeRegExpList": {
1580
1802
  "$ref": "#/definitions/RegExpPatternList",
1581
- "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)."
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).",
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)."
1582
1805
  },
1583
1806
  "language": {
1584
1807
  "$ref": "#/definitions/LocaleId",
1585
1808
  "default": "en",
1586
- "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."
1587
1811
  },
1588
1812
  "languageId": {
1589
1813
  "$ref": "#/definitions/MatchingFileType",
1590
- "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."
1591
1816
  },
1592
1817
  "languageSettings": {
1593
1818
  "description": "Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.",
1594
1819
  "items": {
1595
1820
  "$ref": "#/definitions/LanguageSetting"
1596
1821
  },
1822
+ "markdownDescription": "Additional settings for individual languages.\n\nSee [Language Settings](https://cspell.org/configuration/language-settings/) for more details.",
1597
1823
  "type": "array"
1598
1824
  },
1599
1825
  "loadDefaultConfiguration": {
1600
1826
  "default": true,
1601
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.",
1602
1829
  "type": "boolean"
1603
1830
  },
1604
1831
  "maxDuplicateProblems": {
1605
1832
  "default": 5,
1606
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.",
1607
1835
  "type": "number"
1608
1836
  },
1609
1837
  "maxNumberOfProblems": {
1610
1838
  "default": 10000,
1611
1839
  "description": "The maximum number of problems to report in a file.",
1840
+ "markdownDescription": "The maximum number of problems to report in a file.",
1612
1841
  "type": "number"
1613
1842
  },
1614
1843
  "minWordLength": {
1615
1844
  "default": 4,
1616
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.",
1617
1847
  "type": "number"
1618
1848
  },
1619
1849
  "name": {
1620
1850
  "description": "Optional name of configuration.",
1851
+ "markdownDescription": "Optional name of configuration.",
1621
1852
  "type": "string"
1622
1853
  },
1623
1854
  "noConfigSearch": {
1624
1855
  "default": false,
1625
1856
  "description": "Prevents searching for local configuration when checking individual documents.",
1857
+ "markdownDescription": "Prevents searching for local configuration when checking individual documents.",
1626
1858
  "type": "boolean"
1627
1859
  },
1628
1860
  "noSuggestDictionaries": {
@@ -1630,11 +1862,13 @@
1630
1862
  "items": {
1631
1863
  "$ref": "#/definitions/DictionaryReference"
1632
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.",
1633
1866
  "type": "array"
1634
1867
  },
1635
1868
  "numSuggestions": {
1636
1869
  "default": 10,
1637
1870
  "description": "Number of suggestions to make.",
1871
+ "markdownDescription": "Number of suggestions to make.",
1638
1872
  "type": "number"
1639
1873
  },
1640
1874
  "overrides": {
@@ -1642,13 +1876,15 @@
1642
1876
  "items": {
1643
1877
  "$ref": "#/definitions/OverrideSettings"
1644
1878
  },
1879
+ "markdownDescription": "Overrides are used to apply settings for specific files in your project.\n\nFor example:\n\n```javascript\n\"overrides\": [\n // Force `*.hrr` and `*.crr` files to be treated as `cpp` files:\n {\n \"filename\": \"**​/{*.hrr,*.crr}\",\n \"languageId\": \"cpp\"\n },\n // Force `*.txt` to use the Dutch dictionary (Dutch dictionary needs to be installed separately):\n {\n \"language\": \"nl\",\n \"filename\": \"**​/dutch/**​/*.txt\"\n }\n]\n```",
1645
1880
  "type": "array"
1646
1881
  },
1647
1882
  "patterns": {
1648
- "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\"] } ] ```",
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.",
1649
1884
  "items": {
1650
1885
  "$ref": "#/definitions/RegExpPatternDefinition"
1651
1886
  },
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.",
1652
1888
  "type": "array"
1653
1889
  },
1654
1890
  "pnpFiles": {
@@ -1660,11 +1896,13 @@
1660
1896
  "items": {
1661
1897
  "type": "string"
1662
1898
  },
1899
+ "markdownDescription": "The PnP files to search for. Note: `.mjs` files are not currently supported.",
1663
1900
  "type": "array"
1664
1901
  },
1665
1902
  "readonly": {
1666
1903
  "default": false,
1667
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.",
1668
1906
  "type": "boolean"
1669
1907
  },
1670
1908
  "reporters": {
@@ -1675,16 +1913,19 @@
1675
1913
  "items": {
1676
1914
  "$ref": "#/definitions/ReporterSettings"
1677
1915
  },
1916
+ "markdownDescription": "Define which reports to use.\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\" }]]`\n- `[ \"default\", [\"@cspell/cspell-json-reporter\", { \"outFile\": \"out.json\" }]]` - Use both the default reporter and the cspell-json-reporter.",
1678
1917
  "type": "array"
1679
1918
  },
1680
1919
  "showStatus": {
1681
1920
  "deprecated": true,
1682
1921
  "description": "Show status.",
1922
+ "markdownDescription": "Show status.",
1683
1923
  "type": "boolean"
1684
1924
  },
1685
1925
  "spellCheckDelayMs": {
1686
1926
  "deprecated": true,
1687
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.",
1688
1929
  "type": "number"
1689
1930
  },
1690
1931
  "suggestWords": {
@@ -1692,26 +1933,31 @@
1692
1933
  "items": {
1693
1934
  "type": "string"
1694
1935
  },
1936
+ "markdownDescription": "A list of suggested replacements for words.\nSuggested words provide a way to make preferred suggestions on word replacements.\nTo hint at a preferred change, but not to require it.\n\nFormat of `suggestWords`\n- Single suggestion (possible auto fix)\n - `word: suggestion`\n - `word->suggestion`\n- Multiple suggestions (not auto fixable)\n - `word: first, second, third`\n - `word->first, second, third`",
1695
1937
  "type": "array"
1696
1938
  },
1697
1939
  "suggestionNumChanges": {
1698
1940
  "default": 3,
1699
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.",
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.",
1700
1943
  "type": "number"
1701
1944
  },
1702
1945
  "suggestionsTimeout": {
1703
1946
  "default": 500,
1704
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.",
1705
1949
  "type": "number"
1706
1950
  },
1707
1951
  "useGitignore": {
1708
1952
  "default": false,
1709
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.",
1710
1955
  "type": "boolean"
1711
1956
  },
1712
1957
  "usePnP": {
1713
1958
  "default": false,
1714
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.",
1715
1961
  "type": "boolean"
1716
1962
  },
1717
1963
  "userWords": {
@@ -1719,22 +1965,26 @@
1719
1965
  "items": {
1720
1966
  "type": "string"
1721
1967
  },
1968
+ "markdownDescription": "Words to add to global dictionary -- should only be in the user config file.",
1722
1969
  "type": "array"
1723
1970
  },
1724
1971
  "validateDirectives": {
1725
1972
  "description": "Verify that the in-document directives are correct.",
1973
+ "markdownDescription": "Verify that the in-document directives are correct.",
1726
1974
  "type": "boolean"
1727
1975
  },
1728
1976
  "version": {
1729
1977
  "$ref": "#/definitions/Version",
1730
1978
  "default": "0.2",
1731
- "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."
1732
1981
  },
1733
1982
  "words": {
1734
1983
  "description": "List of words to be considered correct.",
1735
1984
  "items": {
1736
1985
  "type": "string"
1737
1986
  },
1987
+ "markdownDescription": "List of words to be considered correct.",
1738
1988
  "type": "array"
1739
1989
  }
1740
1990
  },