Skip to content

Commit 073a8e1

Browse files
street-side-software-automation[bot]street-side-software-automation[bot]
authored
feat: Update CSpell version (9.1.2) (#683)
1 parent d99a085 commit 073a8e1

File tree

6 files changed

+304
-261
lines changed

6 files changed

+304
-261
lines changed

‎README.md‎

Lines changed: 80 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -108,8 +108,10 @@ Commands:
108108
result. The full file is displayed in
109109
color.
110110
suggestions|sug [options] [words...] Spelling Suggestions for words.
111+
init [options] Initialize a CSpell configuration file.
111112
link Link dictionaries and other settings to
112113
the cspell global config.
114+
dictionaries [options] List dictionaries
113115
help [command] display help for command
114116
```
115117

@@ -146,65 +148,79 @@ Examples:
146148
Check spelling
147149
148150
Options:
149-
-c, --config <cspell.json> Configuration file to use. By default cspell
150-
looks for cspell.json in the current directory.
151-
-v, --verbose Display more information about the files being
152-
checked and the configuration.
153-
--locale <locale> Set language locales. i.e. "en,fr" for English
154-
and French, or "en-GB" for British English.
155-
--language-id <file-type> Force programming language for unknown
156-
extensions. i.e. "php" or "scala"
157-
--words-only Only output the words not found in the
158-
dictionaries.
159-
-u, --unique Only output the first instance of a word not
160-
found in the dictionaries.
161-
-e, --exclude <glob> Exclude files matching the glob pattern. This
162-
option can be used multiple times to add multiple
163-
globs.
164-
--file-list <path or stdin> Specify a list of files to be spell checked. The
165-
list is filtered against the glob file patterns.
166-
Note: the format is 1 file path per line.
167-
--file [file...] Specify files to spell check. They are filtered
168-
by the [globs...].
169-
--no-issues Do not show the spelling errors.
170-
--no-progress Turn off progress messages
171-
--no-summary Turn off summary message in console.
172-
-s, --silent Silent mode, suppress error messages.
173-
--no-exit-code Do not return an exit code if issues are found.
174-
--quiet Only show spelling issues or errors.
175-
--fail-fast Exit after first file with an issue or error.
176-
-r, --root <root folder> Root directory, defaults to current directory.
177-
--no-relative Issues are displayed with absolute path instead
178-
of relative to the root.
179-
--show-context Show the surrounding text around an issue.
180-
--show-suggestions Show spelling suggestions.
181-
--no-show-suggestions Do not show spelling suggestions or fixes.
182-
--no-must-find-files Do not error if no files are found.
183-
--cache Use cache to only check changed files.
184-
--no-cache Do not use cache.
185-
--cache-reset Reset the cache file.
186-
--cache-strategy <strategy> Strategy to use for detecting changed files.
187-
(choices: "content", "metadata", default:
188-
"content")
189-
--cache-location <path> Path to the cache file or directory. (default:
190-
".cspellcache")
191-
--dot Include files and directories starting with `.`
192-
(period) when matching globs.
193-
--gitignore Ignore files matching glob patterns found in
194-
.gitignore files.
195-
--no-gitignore Do NOT use .gitignore files.
196-
--gitignore-root <path> Prevent searching for .gitignore files past root.
197-
--validate-directives Validate in-document CSpell directives.
198-
--color Force color.
199-
--no-color Turn off color.
200-
--no-default-configuration Do not load the default configuration and
201-
dictionaries.
202-
--debug Output information useful for debugging
203-
cspell.json files.
204-
--reporter <module|path> Specify one or more reporters to use.
205-
--issue-template [template] Use a custom issue template. See --help
206-
--issue-template for details.
207-
-h, --help display help for command
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
208224

209225
More Examples:
210226

@@ -226,6 +242,9 @@ More Examples:
226242
Only spell check the "/*.md" files in $FILES,
227243
where $FILES is a shell variable that contains the list of files.
228244

245+
cspell --help --verbose
246+
Show all options including hidden options.
247+
229248
References:
230249
https://cspell.org
231250
https://github.com/streetsidesoftware/cspell
@@ -255,6 +274,8 @@ Options:
255274
--ignore-case Ignore case and accents when searching for words.
256275
--no-ignore-case Do not ignore case and accents when searching for
257276
words.
277+
--dictionary <name> Enable a dictionary by name. Can be used multiple
278+
times.
258279
--dictionary-path <format> Configure how to display the dictionary path.
259280
(choices: "hide", "short", "long", "full",
260281
default: Display most of the path.)

0 commit comments

Comments
 (0)