cspell-cli 9.0.0 → 9.1.0
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 +81 -60
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -18,7 +18,7 @@ This repository enables using [cspell](https://github.com/streetsidesoftware/csp
|
|
|
18
18
|
# .pre-commit-config.yaml
|
|
19
19
|
repos:
|
|
20
20
|
- repo: https://github.com/streetsidesoftware/cspell-cli
|
|
21
|
-
rev: v9.
|
|
21
|
+
rev: v9.1.0
|
|
22
22
|
hooks:
|
|
23
23
|
- id: cspell # Spell check changed files
|
|
24
24
|
- id: cspell # Spell check the commit message
|
|
@@ -108,8 +108,10 @@ Commands:
|
|
|
108
108
|
result. The full file is displayed in
|
|
109
109
|
color.
|
|
110
110
|
suggestions|sug [options] [words...] Spelling Suggestions for words.
|
|
111
|
+
init [options] Initialize a CSpell configuration file.
|
|
111
112
|
link Link dictionaries and other settings to
|
|
112
113
|
the cspell global config.
|
|
114
|
+
dictionaries [options] List dictionaries
|
|
113
115
|
help [command] display help for command
|
|
114
116
|
```
|
|
115
117
|
|
|
@@ -146,65 +148,79 @@ Examples:
|
|
|
146
148
|
Check spelling
|
|
147
149
|
|
|
148
150
|
Options:
|
|
149
|
-
-c, --config <cspell.json>
|
|
150
|
-
|
|
151
|
-
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
--
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
--
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
--
|
|
180
|
-
--
|
|
181
|
-
|
|
182
|
-
--no-
|
|
183
|
-
--
|
|
184
|
-
--
|
|
185
|
-
--
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
--
|
|
192
|
-
|
|
193
|
-
--
|
|
194
|
-
|
|
195
|
-
--no-
|
|
196
|
-
--
|
|
197
|
-
--
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
--
|
|
201
|
-
|
|
202
|
-
--
|
|
203
|
-
|
|
204
|
-
--
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
-
|
|
151
|
+
-c, --config <cspell.json> Configuration file to use. By default cspell
|
|
152
|
+
looks for cspell.json in the current directory.
|
|
153
|
+
--no-config-search Disable automatic searching for additional
|
|
154
|
+
configuration files in parent directories. Only
|
|
155
|
+
the specified config file (if any) will be
|
|
156
|
+
used.
|
|
157
|
+
--stop-config-search-at <dir> Specify a directory at which to stop searching
|
|
158
|
+
for configuration files when walking up from
|
|
159
|
+
the files being checked. Useful for limiting
|
|
160
|
+
config inheritance.
|
|
161
|
+
-v, --verbose Display more information about the files being
|
|
162
|
+
checked and the configuration.
|
|
163
|
+
--locale <locale> Set language locales. i.e. "en,fr" for English
|
|
164
|
+
and French, or "en-GB" for British English.
|
|
165
|
+
--language-id <file-type> Force programming language for unknown
|
|
166
|
+
extensions. i.e. "php" or "scala"
|
|
167
|
+
--words-only Only output the words not found in the
|
|
168
|
+
dictionaries.
|
|
169
|
+
-u, --unique Only output the first instance of a word not
|
|
170
|
+
found in the dictionaries.
|
|
171
|
+
-e, --exclude <glob> Exclude files matching the glob pattern. This
|
|
172
|
+
option can be used multiple times to add
|
|
173
|
+
multiple globs.
|
|
174
|
+
--file-list <path or stdin> Specify a list of files to be spell checked.
|
|
175
|
+
The list is filtered against the glob file
|
|
176
|
+
patterns. Note: the format is 1 file path per
|
|
177
|
+
line.
|
|
178
|
+
--file [file...] Specify files to spell check. They are filtered
|
|
179
|
+
by the [globs...].
|
|
180
|
+
--no-issues Do not show the spelling errors.
|
|
181
|
+
--no-progress Turn off progress messages
|
|
182
|
+
--no-summary Turn off summary message in console.
|
|
183
|
+
-s, --silent Silent mode, suppress error messages.
|
|
184
|
+
--no-exit-code Do not return an exit code if issues are found.
|
|
185
|
+
--quiet Only show spelling issues or errors.
|
|
186
|
+
--fail-fast Exit after first file with an issue or error.
|
|
187
|
+
--continue-on-error Continue processing files even if there is a
|
|
188
|
+
configuration error.
|
|
189
|
+
-r, --root <root folder> Root directory, defaults to current directory.
|
|
190
|
+
--no-relative Issues are displayed with absolute path instead
|
|
191
|
+
of relative to the root.
|
|
192
|
+
--show-context Show the surrounding text around an issue.
|
|
193
|
+
--show-suggestions Show spelling suggestions.
|
|
194
|
+
--no-show-suggestions Do not show spelling suggestions or fixes.
|
|
195
|
+
--no-must-find-files Do not error if no files are found.
|
|
196
|
+
--cache Use cache to only check changed files.
|
|
197
|
+
--no-cache Do not use cache.
|
|
198
|
+
--cache-reset Reset the cache file.
|
|
199
|
+
--cache-strategy <strategy> Strategy to use for detecting changed files.
|
|
200
|
+
(choices: "content", "metadata", default:
|
|
201
|
+
"content")
|
|
202
|
+
--cache-location <path> Path to the cache file or directory. (default:
|
|
203
|
+
".cspellcache")
|
|
204
|
+
--dot Include files and directories starting with `.`
|
|
205
|
+
(period) when matching globs.
|
|
206
|
+
--gitignore Ignore files matching glob patterns found in
|
|
207
|
+
.gitignore files.
|
|
208
|
+
--no-gitignore Do NOT use .gitignore files.
|
|
209
|
+
--gitignore-root <path> Prevent searching for .gitignore files past
|
|
210
|
+
root.
|
|
211
|
+
--validate-directives Validate in-document CSpell directives.
|
|
212
|
+
--color Force color.
|
|
213
|
+
--no-color Turn off color.
|
|
214
|
+
--no-default-configuration Do not load the default configuration and
|
|
215
|
+
dictionaries.
|
|
216
|
+
--dictionary <name> Enable a dictionary by name.
|
|
217
|
+
--disable-dictionary <name> Disable a dictionary by name.
|
|
218
|
+
--reporter <module|path> Specify one or more reporters to use.
|
|
219
|
+
--report <level> Set how unknown words are reported (choices:
|
|
220
|
+
"all", "simple", "typos", "flagged")
|
|
221
|
+
--issue-template [template] Use a custom issue template. See --help
|
|
222
|
+
--issue-template for details.
|
|
223
|
+
-h, --help display help for command
|
|
208
224
|
|
|
209
225
|
More Examples:
|
|
210
226
|
|
|
@@ -226,6 +242,9 @@ More Examples:
|
|
|
226
242
|
Only spell check the "/*.md" files in $FILES,
|
|
227
243
|
where $FILES is a shell variable that contains the list of files.
|
|
228
244
|
|
|
245
|
+
cspell --help --verbose
|
|
246
|
+
Show all options including hidden options.
|
|
247
|
+
|
|
229
248
|
References:
|
|
230
249
|
https://cspell.org
|
|
231
250
|
https://github.com/streetsidesoftware/cspell
|
|
@@ -255,6 +274,8 @@ Options:
|
|
|
255
274
|
--ignore-case Ignore case and accents when searching for words.
|
|
256
275
|
--no-ignore-case Do not ignore case and accents when searching for
|
|
257
276
|
words.
|
|
277
|
+
--dictionary <name> Enable a dictionary by name. Can be used multiple
|
|
278
|
+
times.
|
|
258
279
|
--dictionary-path <format> Configure how to display the dictionary path.
|
|
259
280
|
(choices: "hide", "short", "long", "full",
|
|
260
281
|
default: Display most of the path.)
|
package/package.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"access": "public",
|
|
5
5
|
"provenance": true
|
|
6
6
|
},
|
|
7
|
-
"version": "9.
|
|
7
|
+
"version": "9.1.0",
|
|
8
8
|
"description": "CLI for cspell; A Spelling Checker for Code!",
|
|
9
9
|
"type": "module",
|
|
10
10
|
"module": "index.js",
|
|
@@ -47,10 +47,10 @@
|
|
|
47
47
|
"node": ">=20"
|
|
48
48
|
},
|
|
49
49
|
"dependencies": {
|
|
50
|
-
"cspell": "^9.
|
|
50
|
+
"cspell": "^9.1.3"
|
|
51
51
|
},
|
|
52
52
|
"devDependencies": {
|
|
53
|
-
"inject-markdown": "^
|
|
54
|
-
"prettier": "^3.
|
|
53
|
+
"inject-markdown": "^4.0.0",
|
|
54
|
+
"prettier": "^3.6.2"
|
|
55
55
|
}
|
|
56
56
|
}
|