@cspell/cspell-tools 10.3.1-alpha.0 → 10.3.1-alpha.1
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.
|
@@ -7,14 +7,17 @@
|
|
|
7
7
|
"properties": {
|
|
8
8
|
"compress": {
|
|
9
9
|
"description": "compress the resulting file",
|
|
10
|
+
"markdownDescription": "compress the resulting file",
|
|
10
11
|
"type": "boolean"
|
|
11
12
|
},
|
|
12
13
|
"optimize": {
|
|
13
14
|
"description": "optimize the trie into a DAWG",
|
|
15
|
+
"markdownDescription": "optimize the trie into a DAWG",
|
|
14
16
|
"type": "boolean"
|
|
15
17
|
},
|
|
16
18
|
"useStringTable": {
|
|
17
19
|
"description": "use a string table to reduce size",
|
|
20
|
+
"markdownDescription": "use a string table to reduce size",
|
|
18
21
|
"type": "boolean"
|
|
19
22
|
}
|
|
20
23
|
},
|
|
@@ -47,11 +50,13 @@
|
|
|
47
50
|
"properties": {
|
|
48
51
|
"allowedSplitWords": {
|
|
49
52
|
"$ref": "#/definitions/FilePathOrFilePathArray",
|
|
50
|
-
"description": "Words in the `allowedSplitWords` are considered correct and can be used as a basis for splitting compound words.\n\nIf entries can be split so that all the words in the entry are allowed, then only the individual words are added, otherwise the entire entry is added. This is to prevent misspellings in CamelCase words from being introduced into the dictionary."
|
|
53
|
+
"description": "Words in the `allowedSplitWords` are considered correct and can be used as a basis for splitting compound words.\n\nIf entries can be split so that all the words in the entry are allowed, then only the individual words are added, otherwise the entire entry is added. This is to prevent misspellings in CamelCase words from being introduced into the dictionary.",
|
|
54
|
+
"markdownDescription": "Words in the `allowedSplitWords` are considered correct and can be used\nas a basis for splitting compound words.\n\nIf entries can be split so that all the words in the entry are allowed,\nthen only the individual words are added, otherwise the entire entry is added.\nThis is to prevent misspellings in CamelCase words from being introduced into the\ndictionary."
|
|
51
55
|
},
|
|
52
56
|
"keepRawCase": {
|
|
53
57
|
"default": false,
|
|
54
58
|
"description": "Do not generate lower case / accent free versions of words.",
|
|
59
|
+
"markdownDescription": "Do not generate lower case / accent free versions of words.",
|
|
55
60
|
"type": "boolean"
|
|
56
61
|
},
|
|
57
62
|
"listFile": {
|
|
@@ -59,11 +64,13 @@
|
|
|
59
64
|
},
|
|
60
65
|
"maxDepth": {
|
|
61
66
|
"description": "Maximum number of nested Hunspell Rules to apply. This is needed for recursive dictionaries like Hebrew.",
|
|
67
|
+
"markdownDescription": "Maximum number of nested Hunspell Rules to apply.\nThis is needed for recursive dictionaries like Hebrew.",
|
|
62
68
|
"type": "number"
|
|
63
69
|
},
|
|
64
70
|
"minCompoundLength": {
|
|
65
71
|
"default": 4,
|
|
66
72
|
"description": "Controls the minimum length of a compound word when storing words using `storeSplitWordsAsCompounds`. The compound words are prefixed / suffixed with `*`, to allow them to be combined with other compound words. If the length is too low, then the dictionary will consider many misspelled words as correct.",
|
|
73
|
+
"markdownDescription": "Controls the minimum length of a compound word when storing words using `storeSplitWordsAsCompounds`.\nThe compound words are prefixed / suffixed with `*`, to allow them to be combined with other compound words.\nIf the length is too low, then the dictionary will consider many misspelled words as correct.",
|
|
67
74
|
"type": "number"
|
|
68
75
|
},
|
|
69
76
|
"split": {
|
|
@@ -77,11 +84,13 @@
|
|
|
77
84
|
}
|
|
78
85
|
],
|
|
79
86
|
"default": false,
|
|
80
|
-
"description": "Split lines into words."
|
|
87
|
+
"description": "Split lines into words.",
|
|
88
|
+
"markdownDescription": "Split lines into words."
|
|
81
89
|
},
|
|
82
90
|
"storeSplitWordsAsCompounds": {
|
|
83
91
|
"default": false,
|
|
84
92
|
"description": "Camel case words that have been split using the `allowedSplitWords` are added to the dictionary as compoundable words. These words are prefixed / suffixed with `*`.",
|
|
93
|
+
"markdownDescription": "Camel case words that have been split using the `allowedSplitWords` are added to the dictionary as compoundable words.\nThese words are prefixed / suffixed with `*`.",
|
|
85
94
|
"type": "boolean"
|
|
86
95
|
}
|
|
87
96
|
},
|
|
@@ -92,6 +101,7 @@
|
|
|
92
101
|
},
|
|
93
102
|
"FilePath": {
|
|
94
103
|
"description": "Note: All relative paths are relative to the config file location.",
|
|
104
|
+
"markdownDescription": "Note: All relative paths are relative to the config file location.",
|
|
95
105
|
"type": "string"
|
|
96
106
|
},
|
|
97
107
|
"FilePathOrFilePathArray": {
|
|
@@ -112,7 +122,8 @@
|
|
|
112
122
|
"properties": {
|
|
113
123
|
"allowedSplitWords": {
|
|
114
124
|
"$ref": "#/definitions/FilePathOrFilePathArray",
|
|
115
|
-
"description": "Words in the `allowedSplitWords` are considered correct and can be used as a basis for splitting compound words.\n\nIf entries can be split so that all the words in the entry are allowed, then only the individual words are added, otherwise the entire entry is added. This is to prevent misspellings in CamelCase words from being introduced into the dictionary."
|
|
125
|
+
"description": "Words in the `allowedSplitWords` are considered correct and can be used as a basis for splitting compound words.\n\nIf entries can be split so that all the words in the entry are allowed, then only the individual words are added, otherwise the entire entry is added. This is to prevent misspellings in CamelCase words from being introduced into the dictionary.",
|
|
126
|
+
"markdownDescription": "Words in the `allowedSplitWords` are considered correct and can be used\nas a basis for splitting compound words.\n\nIf entries can be split so that all the words in the entry are allowed,\nthen only the individual words are added, otherwise the entire entry is added.\nThis is to prevent misspellings in CamelCase words from being introduced into the\ndictionary."
|
|
116
127
|
},
|
|
117
128
|
"filename": {
|
|
118
129
|
"$ref": "#/definitions/FilePath"
|
|
@@ -120,15 +131,18 @@
|
|
|
120
131
|
"keepRawCase": {
|
|
121
132
|
"default": false,
|
|
122
133
|
"description": "Do not generate lower case / accent free versions of words.",
|
|
134
|
+
"markdownDescription": "Do not generate lower case / accent free versions of words.",
|
|
123
135
|
"type": "boolean"
|
|
124
136
|
},
|
|
125
137
|
"maxDepth": {
|
|
126
138
|
"description": "Maximum number of nested Hunspell Rules to apply. This is needed for recursive dictionaries like Hebrew.",
|
|
139
|
+
"markdownDescription": "Maximum number of nested Hunspell Rules to apply.\nThis is needed for recursive dictionaries like Hebrew.",
|
|
127
140
|
"type": "number"
|
|
128
141
|
},
|
|
129
142
|
"minCompoundLength": {
|
|
130
143
|
"default": 4,
|
|
131
144
|
"description": "Controls the minimum length of a compound word when storing words using `storeSplitWordsAsCompounds`. The compound words are prefixed / suffixed with `*`, to allow them to be combined with other compound words. If the length is too low, then the dictionary will consider many misspelled words as correct.",
|
|
145
|
+
"markdownDescription": "Controls the minimum length of a compound word when storing words using `storeSplitWordsAsCompounds`.\nThe compound words are prefixed / suffixed with `*`, to allow them to be combined with other compound words.\nIf the length is too low, then the dictionary will consider many misspelled words as correct.",
|
|
132
146
|
"type": "number"
|
|
133
147
|
},
|
|
134
148
|
"split": {
|
|
@@ -142,11 +156,13 @@
|
|
|
142
156
|
}
|
|
143
157
|
],
|
|
144
158
|
"default": false,
|
|
145
|
-
"description": "Split lines into words."
|
|
159
|
+
"description": "Split lines into words.",
|
|
160
|
+
"markdownDescription": "Split lines into words."
|
|
146
161
|
},
|
|
147
162
|
"storeSplitWordsAsCompounds": {
|
|
148
163
|
"default": false,
|
|
149
164
|
"description": "Camel case words that have been split using the `allowedSplitWords` are added to the dictionary as compoundable words. These words are prefixed / suffixed with `*`.",
|
|
165
|
+
"markdownDescription": "Camel case words that have been split using the `allowedSplitWords` are added to the dictionary as compoundable words.\nThese words are prefixed / suffixed with `*`.",
|
|
150
166
|
"type": "boolean"
|
|
151
167
|
}
|
|
152
168
|
},
|
|
@@ -155,11 +171,19 @@
|
|
|
155
171
|
],
|
|
156
172
|
"type": "object"
|
|
157
173
|
},
|
|
174
|
+
"ReplaceWith": {
|
|
175
|
+
"type": "string"
|
|
176
|
+
},
|
|
158
177
|
"Replacements": {
|
|
159
178
|
"additionalProperties": {
|
|
160
|
-
"
|
|
179
|
+
"$ref": "#/definitions/ReplaceWith"
|
|
180
|
+
},
|
|
181
|
+
"description": "Replacement rules to apply to the words in the dictionary. The key is the pattern to match, and the value is the replacement string. Note: Multiple patterns can be separated by the `|` character.\n\n- ``'|‘|`|’`` - with match all the single quotes.\n\nNote: the pattern is treated like a regular expression using the JavaScript `RegExp` constructor with the `g` and `v` flags.\n\nNote: replacements are applied in the order they are defined.",
|
|
182
|
+
"markdownDescription": "Replacement rules to apply to the words in the dictionary.\nThe key is the pattern to match, and the value is the replacement string.\nNote: Multiple patterns can be separated by the `|` character.\n\n- ``'|‘|`|’`` - with match all the single quotes.\n\nNote: the pattern is treated like a regular expression using the JavaScript `RegExp` constructor with the `g` and `v` flags.\n\nNote: replacements are applied in the order they are defined.",
|
|
183
|
+
"propertyNames": {
|
|
184
|
+
"description": "Pattern to match in the replacement rules. Multiple patterns can be separated by the `|` character.\n\n- ``'|‘|`|’`` - with match all the single quotes.",
|
|
185
|
+
"markdownDescription": "Pattern to match in the replacement rules. Multiple patterns can be separated by the `|` character.\n\n- ``'|‘|`|’`` - with match all the single quotes."
|
|
161
186
|
},
|
|
162
|
-
"description": "Replacement rules to apply to the words in the dictionary. The key is the pattern to match, and the value is the replacement string.",
|
|
163
187
|
"type": "object"
|
|
164
188
|
},
|
|
165
189
|
"Target": {
|
|
@@ -177,7 +201,8 @@
|
|
|
177
201
|
"type": "array"
|
|
178
202
|
}
|
|
179
203
|
],
|
|
180
|
-
"description": "Words in the `allowedSplitWords` are considered correct and can be used as a basis for splitting compound words.\n\nIf entries can be split so that all the words in the entry are allowed, then only the individual words are added, otherwise the entire entry is added. This is to prevent misspellings in CamelCase words from being introduced into the dictionary."
|
|
204
|
+
"description": "Words in the `allowedSplitWords` are considered correct and can be used as a basis for splitting compound words.\n\nIf entries can be split so that all the words in the entry are allowed, then only the individual words are added, otherwise the entire entry is added. This is to prevent misspellings in CamelCase words from being introduced into the dictionary.",
|
|
205
|
+
"markdownDescription": "Words in the `allowedSplitWords` are considered correct and can be used\nas a basis for splitting compound words.\n\nIf entries can be split so that all the words in the entry are allowed,\nthen only the individual words are added, otherwise the entire entry is added.\nThis is to prevent misspellings in CamelCase words from being introduced into the\ndictionary."
|
|
181
206
|
},
|
|
182
207
|
"bTrie": {
|
|
183
208
|
"anyOf": [
|
|
@@ -188,11 +213,13 @@
|
|
|
188
213
|
"$ref": "#/definitions/BTrieOptions"
|
|
189
214
|
}
|
|
190
215
|
],
|
|
191
|
-
"description": "Generate a `.btrie.gz` for the target."
|
|
216
|
+
"description": "Generate a `.btrie.gz` for the target.",
|
|
217
|
+
"markdownDescription": "Generate a `.btrie.gz` for the target."
|
|
192
218
|
},
|
|
193
219
|
"compress": {
|
|
194
220
|
"default": false,
|
|
195
221
|
"description": "Setting this value to true will create a `.gz` dictionary file. Use `keepUncompressed` to also keep an uncompressed version.",
|
|
222
|
+
"markdownDescription": "Setting this value to true will create a `.gz` dictionary file.\nUse `keepUncompressed` to also keep an uncompressed version.",
|
|
196
223
|
"type": "boolean"
|
|
197
224
|
},
|
|
198
225
|
"dictionaryDirectives": {
|
|
@@ -200,6 +227,7 @@
|
|
|
200
227
|
"items": {
|
|
201
228
|
"type": "string"
|
|
202
229
|
},
|
|
230
|
+
"markdownDescription": "Injects `cspell-dictionary` directives into the dictionary header.\n\nExample:\n\n```ini\n# cspell-dictionary: no-generate-alternatives\n```\n\nKnown Directives:\n```yaml\n- split # Tell the dictionary loader to split words\n- no-split # Tell the dictionary loader to not split words (default)\n- generate-alternatives # Tell the dictionary loader to generate alternate spellings (default)\n- no-generate-alternatives # Tell the dictionary loader to not generate alternate spellings\n```",
|
|
203
231
|
"type": "array"
|
|
204
232
|
},
|
|
205
233
|
"excludeWordsFrom": {
|
|
@@ -207,6 +235,7 @@
|
|
|
207
235
|
"items": {
|
|
208
236
|
"$ref": "#/definitions/FilePath"
|
|
209
237
|
},
|
|
238
|
+
"markdownDescription": "Words from the sources that are found in `excludeWordsFrom` files\nwill NOT be added to the dictionary.",
|
|
210
239
|
"type": "array"
|
|
211
240
|
},
|
|
212
241
|
"excludeWordsMatchingRegex": {
|
|
@@ -214,6 +243,7 @@
|
|
|
214
243
|
"items": {
|
|
215
244
|
"type": "string"
|
|
216
245
|
},
|
|
246
|
+
"markdownDescription": "Words from the sources that match the regex in `excludeWordsMatchingRegex`\nwill NOT be added to the dictionary.\n\nNote: The regex must be a valid JavaScript literal regex expression including the `/` delimiters.",
|
|
217
247
|
"type": "array"
|
|
218
248
|
},
|
|
219
249
|
"excludeWordsNotFoundIn": {
|
|
@@ -221,37 +251,45 @@
|
|
|
221
251
|
"items": {
|
|
222
252
|
"$ref": "#/definitions/FilePath"
|
|
223
253
|
},
|
|
254
|
+
"markdownDescription": "Words from the sources that are NOT found in `excludeWordsNotFoundIn` files\nwill NOT be added to the dictionary.",
|
|
224
255
|
"type": "array"
|
|
225
256
|
},
|
|
226
257
|
"format": {
|
|
227
258
|
"$ref": "#/definitions/DictionaryFormats",
|
|
228
|
-
"description": "Format of the dictionary."
|
|
259
|
+
"description": "Format of the dictionary.",
|
|
260
|
+
"markdownDescription": "Format of the dictionary."
|
|
229
261
|
},
|
|
230
262
|
"generateNonStrict": {
|
|
231
263
|
"default": false,
|
|
232
264
|
"description": "Generate lower case / accent free versions of words.",
|
|
265
|
+
"markdownDescription": "Generate lower case / accent free versions of words.",
|
|
233
266
|
"type": "boolean"
|
|
234
267
|
},
|
|
235
268
|
"keepUncompressed": {
|
|
236
269
|
"description": "If `compress` is true, setting this value to true will also keep an uncompressed version of the dictionary.",
|
|
270
|
+
"markdownDescription": "If `compress` is true, setting this value to true will also keep an uncompressed version of the dictionary.",
|
|
237
271
|
"type": "boolean"
|
|
238
272
|
},
|
|
239
273
|
"name": {
|
|
240
274
|
"description": "Name of target, used as the basis of target file name.",
|
|
275
|
+
"markdownDescription": "Name of target, used as the basis of target file name.",
|
|
241
276
|
"type": "string"
|
|
242
277
|
},
|
|
243
278
|
"removeDuplicates": {
|
|
244
279
|
"default": false,
|
|
245
280
|
"description": "Remove duplicate words, favor lower case words over mixed case words. Combine compound prefixes where possible.",
|
|
281
|
+
"markdownDescription": "Remove duplicate words, favor lower case words over mixed case words.\nCombine compound prefixes where possible.",
|
|
246
282
|
"type": "boolean"
|
|
247
283
|
},
|
|
248
284
|
"replacements": {
|
|
249
285
|
"$ref": "#/definitions/Replacements",
|
|
250
|
-
"description": "Replacement rules to apply to the words in the dictionary. The key is the pattern to match, and the value is the replacement string."
|
|
286
|
+
"description": "Replacement rules to apply to the words in the dictionary. The key is the pattern to match, and the value is the replacement string.",
|
|
287
|
+
"markdownDescription": "Replacement rules to apply to the words in the dictionary.\nThe key is the pattern to match, and the value is the replacement string."
|
|
251
288
|
},
|
|
252
289
|
"sort": {
|
|
253
290
|
"default": true,
|
|
254
291
|
"description": "Sort the words in the resulting dictionary. Does not apply to `trie` based formats.",
|
|
292
|
+
"markdownDescription": "Sort the words in the resulting dictionary.\nDoes not apply to `trie` based formats.",
|
|
255
293
|
"type": "boolean"
|
|
256
294
|
},
|
|
257
295
|
"sources": {
|
|
@@ -259,15 +297,18 @@
|
|
|
259
297
|
"items": {
|
|
260
298
|
"$ref": "#/definitions/DictionarySource"
|
|
261
299
|
},
|
|
300
|
+
"markdownDescription": "File sources used to build the dictionary.",
|
|
262
301
|
"type": "array"
|
|
263
302
|
},
|
|
264
303
|
"targetDirectory": {
|
|
265
304
|
"$ref": "#/definitions/FilePath",
|
|
266
305
|
"default": "current directory",
|
|
267
|
-
"description": "The target directory"
|
|
306
|
+
"description": "The target directory",
|
|
307
|
+
"markdownDescription": "The target directory"
|
|
268
308
|
},
|
|
269
309
|
"trieBase": {
|
|
270
310
|
"description": "Advanced: Set the trie base number. A value between 10 and 36 Set numeric base to use. 10 is the easiest to read. 16 is common hex format. 36 is the most compact.",
|
|
311
|
+
"markdownDescription": "Advanced: Set the trie base number. A value between 10 and 36\nSet numeric base to use.\n10 is the easiest to read.\n16 is common hex format.\n36 is the most compact.",
|
|
271
312
|
"type": "number"
|
|
272
313
|
}
|
|
273
314
|
},
|
|
@@ -283,6 +324,7 @@
|
|
|
283
324
|
"$schema": {
|
|
284
325
|
"default": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/packages/cspell-tools/cspell-tools.config.schema.json",
|
|
285
326
|
"description": "Url to JSON Schema",
|
|
327
|
+
"markdownDescription": "Url to JSON Schema",
|
|
286
328
|
"type": "string"
|
|
287
329
|
},
|
|
288
330
|
"allowedSplitWords": {
|
|
@@ -297,10 +339,12 @@
|
|
|
297
339
|
"type": "array"
|
|
298
340
|
}
|
|
299
341
|
],
|
|
300
|
-
"description": "Words in the `allowedSplitWords` are considered correct and can be used as a basis for splitting compound words.\n\nIf entries can be split so that all the words in the entry are allowed, then only the individual words are added, otherwise the entire entry is added. This is to prevent misspellings in CamelCase words from being introduced into the dictionary."
|
|
342
|
+
"description": "Words in the `allowedSplitWords` are considered correct and can be used as a basis for splitting compound words.\n\nIf entries can be split so that all the words in the entry are allowed, then only the individual words are added, otherwise the entire entry is added. This is to prevent misspellings in CamelCase words from being introduced into the dictionary.",
|
|
343
|
+
"markdownDescription": "Words in the `allowedSplitWords` are considered correct and can be used\nas a basis for splitting compound words.\n\nIf entries can be split so that all the words in the entry are allowed,\nthen only the individual words are added, otherwise the entire entry is added.\nThis is to prevent misspellings in CamelCase words from being introduced into the\ndictionary."
|
|
301
344
|
},
|
|
302
345
|
"checksumFile": {
|
|
303
346
|
"description": "Path to checksum file. `true` - defaults to `./checksum.txt`.",
|
|
347
|
+
"markdownDescription": "Path to checksum file. `true` - defaults to `./checksum.txt`.",
|
|
304
348
|
"type": [
|
|
305
349
|
"string",
|
|
306
350
|
"boolean"
|
|
@@ -311,39 +355,47 @@
|
|
|
311
355
|
"items": {
|
|
312
356
|
"type": "string"
|
|
313
357
|
},
|
|
358
|
+
"markdownDescription": "Injects `cspell-dictionary` directives into the dictionary header.\n\nExample:\n\n```ini\n# cspell-dictionary: no-generate-alternatives\n```\n\nKnown Directives:\n```yaml\n- split # Tell the dictionary loader to split words\n- no-split # Tell the dictionary loader to not split words (default)\n- generate-alternatives # Tell the dictionary loader to generate alternate spellings (default)\n- no-generate-alternatives # Tell the dictionary loader to not generate alternate spellings\n```",
|
|
314
359
|
"type": "array"
|
|
315
360
|
},
|
|
316
361
|
"generateNonStrict": {
|
|
317
362
|
"default": false,
|
|
318
363
|
"description": "Generate lower case / accent free versions of words.",
|
|
364
|
+
"markdownDescription": "Generate lower case / accent free versions of words.",
|
|
319
365
|
"type": "boolean"
|
|
320
366
|
},
|
|
321
367
|
"keepRawCase": {
|
|
322
368
|
"default": false,
|
|
323
369
|
"description": "Do not generate lower case / accent free versions of words.",
|
|
370
|
+
"markdownDescription": "Do not generate lower case / accent free versions of words.",
|
|
324
371
|
"type": "boolean"
|
|
325
372
|
},
|
|
326
373
|
"maxDepth": {
|
|
327
374
|
"description": "Maximum number of nested Hunspell Rules to apply. This is needed for recursive dictionaries like Hebrew.",
|
|
375
|
+
"markdownDescription": "Maximum number of nested Hunspell Rules to apply.\nThis is needed for recursive dictionaries like Hebrew.",
|
|
328
376
|
"type": "number"
|
|
329
377
|
},
|
|
330
378
|
"minCompoundLength": {
|
|
331
379
|
"default": 4,
|
|
332
380
|
"description": "Controls the minimum length of a compound word when storing words using `storeSplitWordsAsCompounds`. The compound words are prefixed / suffixed with `*`, to allow them to be combined with other compound words. If the length is too low, then the dictionary will consider many misspelled words as correct.",
|
|
381
|
+
"markdownDescription": "Controls the minimum length of a compound word when storing words using `storeSplitWordsAsCompounds`.\nThe compound words are prefixed / suffixed with `*`, to allow them to be combined with other compound words.\nIf the length is too low, then the dictionary will consider many misspelled words as correct.",
|
|
333
382
|
"type": "number"
|
|
334
383
|
},
|
|
335
384
|
"removeDuplicates": {
|
|
336
385
|
"default": false,
|
|
337
386
|
"description": "Remove duplicate words, favor lower case words over mixed case words. Combine compound prefixes where possible.",
|
|
387
|
+
"markdownDescription": "Remove duplicate words, favor lower case words over mixed case words.\nCombine compound prefixes where possible.",
|
|
338
388
|
"type": "boolean"
|
|
339
389
|
},
|
|
340
390
|
"rootDir": {
|
|
341
391
|
"description": "Specify the directory where all relative paths will resolved against. By default, all relative paths are relative to the location of the config file.",
|
|
392
|
+
"markdownDescription": "Specify the directory where all relative paths will resolved against.\nBy default, all relative paths are relative to the location of the\nconfig file.",
|
|
342
393
|
"type": "string"
|
|
343
394
|
},
|
|
344
395
|
"sort": {
|
|
345
396
|
"default": true,
|
|
346
397
|
"description": "Sort the words in the resulting dictionary. Does not apply to `trie` based formats.",
|
|
398
|
+
"markdownDescription": "Sort the words in the resulting dictionary.\nDoes not apply to `trie` based formats.",
|
|
347
399
|
"type": "boolean"
|
|
348
400
|
},
|
|
349
401
|
"split": {
|
|
@@ -357,11 +409,13 @@
|
|
|
357
409
|
}
|
|
358
410
|
],
|
|
359
411
|
"default": false,
|
|
360
|
-
"description": "Split lines into words."
|
|
412
|
+
"description": "Split lines into words.",
|
|
413
|
+
"markdownDescription": "Split lines into words."
|
|
361
414
|
},
|
|
362
415
|
"storeSplitWordsAsCompounds": {
|
|
363
416
|
"default": false,
|
|
364
417
|
"description": "Camel case words that have been split using the `allowedSplitWords` are added to the dictionary as compoundable words. These words are prefixed / suffixed with `*`.",
|
|
418
|
+
"markdownDescription": "Camel case words that have been split using the `allowedSplitWords` are added to the dictionary as compoundable words.\nThese words are prefixed / suffixed with `*`.",
|
|
365
419
|
"type": "boolean"
|
|
366
420
|
},
|
|
367
421
|
"targets": {
|
|
@@ -369,6 +423,7 @@
|
|
|
369
423
|
"items": {
|
|
370
424
|
"$ref": "#/definitions/Target"
|
|
371
425
|
},
|
|
426
|
+
"markdownDescription": "Optional Target Dictionaries to create.",
|
|
372
427
|
"type": "array"
|
|
373
428
|
}
|
|
374
429
|
},
|
package/dist/app.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { a as reportCheckChecksumFile, c as toError, i as logWithTimestamp, l as generateBTrie, n as compile, o as reportChecksumForFiles, r as setLogger, s as updateChecksumForFiles, t as build, u as compressFile } from "./build-
|
|
1
|
+
import { a as reportCheckChecksumFile, c as toError, i as logWithTimestamp, l as generateBTrie, n as compile, o as reportChecksumForFiles, r as setLogger, s as updateChecksumForFiles, t as build, u as compressFile } from "./build-Fod7lDHd.mjs";
|
|
2
2
|
import { readFileSync } from "node:fs";
|
|
3
3
|
import { CommanderError, Option } from "commander";
|
|
4
4
|
import { writeFile } from "node:fs/promises";
|
|
@@ -883,7 +883,10 @@ function parseFileLines(lines, options) {
|
|
|
883
883
|
function replacementsToMapOperator(replacements) {
|
|
884
884
|
if (!replacements) return void 0;
|
|
885
885
|
return opMap((word) => {
|
|
886
|
-
for (const [pattern, replacement] of Object.entries(replacements))
|
|
886
|
+
for (const [pattern, replacement] of Object.entries(replacements)) {
|
|
887
|
+
const r = new RegExp(pattern, "gv");
|
|
888
|
+
word = word.replaceAll(r, replacement);
|
|
889
|
+
}
|
|
887
890
|
return word;
|
|
888
891
|
});
|
|
889
892
|
}
|
|
@@ -1396,4 +1399,4 @@ function normalizeRequest(buildInfo, root) {
|
|
|
1396
1399
|
//#endregion
|
|
1397
1400
|
export { reportCheckChecksumFile as a, toError as c, logWithTimestamp as i, generateBTrie as l, compile as n, reportChecksumForFiles as o, setLogger as r, updateChecksumForFiles as s, build as t, compressFile as u };
|
|
1398
1401
|
|
|
1399
|
-
//# sourceMappingURL=build-
|
|
1402
|
+
//# sourceMappingURL=build-Fod7lDHd.mjs.map
|
package/dist/index.mjs
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { l as generateBTrie, t as build } from "./build-
|
|
1
|
+
import { l as generateBTrie, t as build } from "./build-Fod7lDHd.mjs";
|
|
2
2
|
export { build, generateBTrie };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cspell/cspell-tools",
|
|
3
|
-
"version": "10.3.1-alpha.
|
|
3
|
+
"version": "10.3.1-alpha.1",
|
|
4
4
|
"description": "Tools to assist with the development of cSpell",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public",
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
},
|
|
15
15
|
"scripts": {
|
|
16
16
|
"build": "pnpm run build-schema && pnpm run compile && pnpm build:check",
|
|
17
|
-
"build-schema": "ts-json-schema-generator --no-top-ref --path src/config/config.ts --type RunConfig --validation-keywords deprecated -o ./cspell-tools.config.schema.json",
|
|
17
|
+
"build-schema": "ts-json-schema-generator --no-top-ref --path src/config/config.ts --type RunConfig --validation-keywords deprecated --markdown-description -o ./cspell-tools.config.schema.json",
|
|
18
18
|
"compile": "tsdown",
|
|
19
19
|
"build:check": "tsc -p .",
|
|
20
20
|
"watch": "tsdown -w",
|
|
@@ -65,12 +65,12 @@
|
|
|
65
65
|
},
|
|
66
66
|
"homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-tools#readme",
|
|
67
67
|
"dependencies": {
|
|
68
|
-
"@cspell/cspell-pipe": "10.3.1-alpha.
|
|
68
|
+
"@cspell/cspell-pipe": "10.3.1-alpha.1",
|
|
69
69
|
"commander": "^15.0.0",
|
|
70
70
|
"cosmiconfig": "10.0.1",
|
|
71
|
-
"cspell-trie-lib": "10.3.1-alpha.
|
|
71
|
+
"cspell-trie-lib": "10.3.1-alpha.1",
|
|
72
72
|
"glob": "^13.0.6",
|
|
73
|
-
"hunspell-reader": "10.3.1-alpha.
|
|
73
|
+
"hunspell-reader": "10.3.1-alpha.1",
|
|
74
74
|
"yaml": "^2.9.0"
|
|
75
75
|
},
|
|
76
76
|
"engines": {
|
|
@@ -80,5 +80,5 @@
|
|
|
80
80
|
"lorem-ipsum": "^3.0.0",
|
|
81
81
|
"ts-json-schema-generator": "2.9.0"
|
|
82
82
|
},
|
|
83
|
-
"gitHead": "
|
|
83
|
+
"gitHead": "aa0576e5b7e666a7e8645939871bcfe4fa2a7eb5"
|
|
84
84
|
}
|