cspell-cli 7.3.1 → 7.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +171 -4
- package/package.json +10 -5
package/README.md
CHANGED
|
@@ -10,7 +10,7 @@ This repository enables using [cspell](https://github.com/streetsidesoftware/csp
|
|
|
10
10
|
# .pre-commit-config.yaml
|
|
11
11
|
repos:
|
|
12
12
|
- repo: https://github.com/streetsidesoftware/cspell-cli
|
|
13
|
-
rev: v7.3.
|
|
13
|
+
rev: v7.3.3
|
|
14
14
|
hooks:
|
|
15
15
|
- id: cspell
|
|
16
16
|
```
|
|
@@ -67,7 +67,41 @@ docker run -v $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest "**"
|
|
|
67
67
|
|
|
68
68
|
## Usage
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
`cspell --help`:
|
|
71
|
+
|
|
72
|
+
<!--- @@inject: static/help.txt --->
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
Usage: cspell [options] [command]
|
|
76
|
+
|
|
77
|
+
Spelling Checker for Code
|
|
78
|
+
|
|
79
|
+
Options:
|
|
80
|
+
-V, --version output the version number
|
|
81
|
+
-h, --help display help for command
|
|
82
|
+
|
|
83
|
+
Commands:
|
|
84
|
+
lint [options] [globs...] Check spelling
|
|
85
|
+
trace [options] [words...] Trace words -- Search for words in the
|
|
86
|
+
configuration and dictionaries.
|
|
87
|
+
check [options] <files...> Spell check file(s) and display the
|
|
88
|
+
result. The full file is displayed in
|
|
89
|
+
color.
|
|
90
|
+
suggestions|sug [options] [words...] Spelling Suggestions for words.
|
|
91
|
+
link Link dictionaries and other settings to
|
|
92
|
+
the cspell global config.
|
|
93
|
+
help [command] display help for command
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
<!--- @@inject-end: static/help.txt --->
|
|
97
|
+
|
|
98
|
+
### Lint
|
|
99
|
+
|
|
100
|
+
`lint` is the default command.
|
|
101
|
+
|
|
102
|
+
`cspell lint --help`:
|
|
103
|
+
|
|
104
|
+
<!--- @@inject: static/help-lint.txt --->
|
|
71
105
|
|
|
72
106
|
```
|
|
73
107
|
Usage: cspell lint [options] [globs...] [file://<path> ...] [stdin[://<path>]]
|
|
@@ -167,10 +201,143 @@ References:
|
|
|
167
201
|
https://github.com/streetsidesoftware/cspell
|
|
168
202
|
```
|
|
169
203
|
|
|
170
|
-
<!--- @@inject-end: static/lint
|
|
204
|
+
<!--- @@inject-end: static/help-lint.txt --->
|
|
205
|
+
|
|
206
|
+
### Trace
|
|
207
|
+
|
|
208
|
+
`cspell trace --help`:
|
|
209
|
+
|
|
210
|
+
<!--- @@inject: static/help-trace.txt --->
|
|
211
|
+
|
|
212
|
+
```
|
|
213
|
+
Usage: cspell trace [options] [words...]
|
|
214
|
+
|
|
215
|
+
Trace words -- Search for words in the configuration and dictionaries.
|
|
216
|
+
|
|
217
|
+
Options:
|
|
218
|
+
-c, --config <cspell.json> Configuration file to use. By default cspell
|
|
219
|
+
looks for cspell.json in the current directory.
|
|
220
|
+
--locale <locale> Set language locales. i.e. "en,fr" for English
|
|
221
|
+
and French, or "en-GB" for British English.
|
|
222
|
+
--language-id <language> Use programming language. i.e. "php" or "scala".
|
|
223
|
+
--allow-compound-words Turn on allowCompoundWords
|
|
224
|
+
--no-allow-compound-words Turn off allowCompoundWords
|
|
225
|
+
--ignore-case Ignore case and accents when searching for words.
|
|
226
|
+
--no-ignore-case Do not ignore case and accents when searching for
|
|
227
|
+
words.
|
|
228
|
+
--dictionary-path <format> Configure how to display the dictionary path.
|
|
229
|
+
(choices: "hide", "short", "long", "full",
|
|
230
|
+
default: Display most of the path.)
|
|
231
|
+
--stdin Read words from stdin.
|
|
232
|
+
--all Show all dictionaries.
|
|
233
|
+
--only-found Show only dictionaries that have the words.
|
|
234
|
+
--no-color Turn off color.
|
|
235
|
+
--color Force color
|
|
236
|
+
--no-default-configuration Do not load the default configuration and
|
|
237
|
+
dictionaries.
|
|
238
|
+
-h, --help display help for command
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
<!--- @@inject-end: static/help-trace.txt --->
|
|
242
|
+
|
|
243
|
+
### Check
|
|
244
|
+
|
|
245
|
+
`cspell check --help`:
|
|
246
|
+
|
|
247
|
+
<!--- @@inject: static/help-check.txt --->
|
|
248
|
+
|
|
249
|
+
```
|
|
250
|
+
Usage: cspell check [options] <files...>
|
|
251
|
+
|
|
252
|
+
Spell check file(s) and display the result. The full file is displayed in
|
|
253
|
+
color.
|
|
254
|
+
|
|
255
|
+
Options:
|
|
256
|
+
-c, --config <cspell.json> Configuration file to use. By default cspell
|
|
257
|
+
looks for cspell.json in the current directory.
|
|
258
|
+
--validate-directives Validate in-document CSpell directives.
|
|
259
|
+
--no-validate-directives Do not validate in-document CSpell directives.
|
|
260
|
+
--no-color Turn off color.
|
|
261
|
+
--color Force color
|
|
262
|
+
--no-exit-code Do not return an exit code if issues are found.
|
|
263
|
+
--no-default-configuration Do not load the default configuration and
|
|
264
|
+
dictionaries.
|
|
265
|
+
-h, --help display help for command
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
<!--- @@inject-end: static/help-check.txt --->
|
|
269
|
+
|
|
270
|
+
### Suggestions
|
|
271
|
+
|
|
272
|
+
`cspell suggestions --help`:
|
|
273
|
+
|
|
274
|
+
<!--- @@inject: static/help-suggestions.txt --->
|
|
275
|
+
|
|
276
|
+
```
|
|
277
|
+
Usage: cspell suggestions|sug [options] [words...]
|
|
278
|
+
|
|
279
|
+
Spelling Suggestions for words.
|
|
280
|
+
|
|
281
|
+
Options:
|
|
282
|
+
-c, --config <cspell.json> Configuration file to use. By default
|
|
283
|
+
cspell looks for cspell.json in the
|
|
284
|
+
current directory.
|
|
285
|
+
--locale <locale> Set language locales. i.e. "en,fr" for
|
|
286
|
+
English and French, or "en-GB" for
|
|
287
|
+
British English.
|
|
288
|
+
--language-id <language> Use programming language. i.e. "php" or
|
|
289
|
+
"scala".
|
|
290
|
+
-s, --no-strict Ignore case and accents when searching
|
|
291
|
+
for words.
|
|
292
|
+
--ignore-case Alias of --no-strict.
|
|
293
|
+
--num-changes <number> Number of changes allowed to a word
|
|
294
|
+
(default: 4)
|
|
295
|
+
--num-suggestions <number> Number of suggestions (default: 8)
|
|
296
|
+
--no-include-ties Force the number of suggested to be
|
|
297
|
+
limited, by not including suggestions
|
|
298
|
+
that have the same edit cost.
|
|
299
|
+
--stdin Use stdin for input.
|
|
300
|
+
--repl REPL interface for looking up
|
|
301
|
+
suggestions.
|
|
302
|
+
-v, --verbose Show detailed output.
|
|
303
|
+
-d, --dictionary <dictionary name> Use the dictionary specified. Only
|
|
304
|
+
dictionaries specified will be used.
|
|
305
|
+
--dictionaries <dictionary names...> Use the dictionaries specified. Only
|
|
306
|
+
dictionaries specified will be used.
|
|
307
|
+
--no-color Turn off color.
|
|
308
|
+
--color Force color
|
|
309
|
+
-h, --help display help for command
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
<!--- @@inject-end: static/help-suggestions.txt --->
|
|
313
|
+
|
|
314
|
+
### Link
|
|
315
|
+
|
|
316
|
+
`cspell link --help`:
|
|
317
|
+
|
|
318
|
+
<!--- @@inject: static/help-link.txt --->
|
|
319
|
+
|
|
320
|
+
```
|
|
321
|
+
Usage: cspell link [options] [command]
|
|
322
|
+
|
|
323
|
+
Link dictionaries and other settings to the cspell global config.
|
|
324
|
+
|
|
325
|
+
Options:
|
|
326
|
+
-h, --help display help for command
|
|
327
|
+
|
|
328
|
+
Commands:
|
|
329
|
+
list|ls List currently linked configurations.
|
|
330
|
+
add|a <dictionaries...> Add dictionaries any other settings to the cspell
|
|
331
|
+
global config.
|
|
332
|
+
remove|r <paths...> Remove matching paths / packages from the global
|
|
333
|
+
config.
|
|
334
|
+
help [command] display help for command
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
<!--- @@inject-end: static/help-link.txt --->
|
|
171
338
|
|
|
172
339
|
## Versioning
|
|
173
340
|
|
|
174
341
|
The major version of `cspell-cli` tries to match the major version of `cspell`.
|
|
175
342
|
|
|
176
|
-
`minor` and `patch` versioning goes up independently from `cspell`.
|
|
343
|
+
`minor` and `patch` versioning goes up independently from `cspell`. Where possible, the `minor` version should match `cspell`.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cspell-cli",
|
|
3
|
-
"version": "7.3.
|
|
3
|
+
"version": "7.3.3",
|
|
4
4
|
"description": "CLI for cspell; A Spelling Checker for Code!",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"module": "index.js",
|
|
@@ -13,8 +13,13 @@
|
|
|
13
13
|
"version-release-patch": "npx standard-version -r patch",
|
|
14
14
|
"version-release": "npx standard-version",
|
|
15
15
|
"lint:fix": "prettier -w .",
|
|
16
|
-
"build:readme": "npm run build:help && inject-markdown README.md",
|
|
17
|
-
"build:help": "node index.js
|
|
16
|
+
"build:readme": "npm run build:help && npm run build:help-lint && npm run build:help-trace && npm run build:help-check && npm run build:help-suggestions && npm run build:help-link && inject-markdown README.md",
|
|
17
|
+
"build:help": "node index.js --help > static/help.txt",
|
|
18
|
+
"build:help-lint": "node index.js lint --help > static/help-lint.txt",
|
|
19
|
+
"build:help-trace": "node index.js trace --help > static/help-trace.txt",
|
|
20
|
+
"build:help-check": "node index.js check --help > static/help-check.txt",
|
|
21
|
+
"build:help-suggestions": "node index.js suggestions --help > static/help-suggestions.txt",
|
|
22
|
+
"build:help-link": "node index.js link --help > static/help-link.txt",
|
|
18
23
|
"test": "node ./index.js ."
|
|
19
24
|
},
|
|
20
25
|
"repository": {
|
|
@@ -38,10 +43,10 @@
|
|
|
38
43
|
"node": ">=16"
|
|
39
44
|
},
|
|
40
45
|
"dependencies": {
|
|
41
|
-
"cspell": "^7.3.
|
|
46
|
+
"cspell": "^7.3.9"
|
|
42
47
|
},
|
|
43
48
|
"devDependencies": {
|
|
44
|
-
"inject-markdown": "^2.
|
|
49
|
+
"inject-markdown": "^2.1.0",
|
|
45
50
|
"prettier": "^3.0.3"
|
|
46
51
|
}
|
|
47
52
|
}
|