cspell-cli - npm Package Compare versions

Comparing version 7.3.1 to 7.3.2

package.json

 {
   "name": "cspell-cli",
-  "version": "7.3.1",
+  "version": "7.3.2",
   "description": "CLI for cspell; A Spelling Checker for Code!",
@@ -16,4 +16,9 @@ "type": "module",
     "lint:fix": "prettier -w .",
-    "build:readme": "npm run build:help && inject-markdown README.md",
-    "build:help": "node index.js lint --help > static/lint-help.txt",
+    "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",
+    "build:help": "node index.js --help > static/help.txt",
+    "build:help-lint": "node index.js lint --help > static/help-lint.txt",
+    "build:help-trace": "node index.js trace --help > static/help-trace.txt",
+    "build:help-check": "node index.js check --help > static/help-check.txt",
+    "build:help-suggestions": "node index.js suggestions --help > static/help-suggestions.txt",
+    "build:help-link": "node index.js link --help > static/help-link.txt",
     "test": "node ./index.js ."
@@ -42,3 +47,3 @@ },
   "dependencies": {
-    "cspell": "^7.3.7"
+    "cspell": "^7.3.8"
   },
@@ -45,0 +50,0 @@ "devDependencies": {

README.md

@@ -13,3 +13,3 @@ # cspell-cli
   - repo: https://github.com/streetsidesoftware/cspell-cli
-    rev: v7.3.1
+    rev: v7.3.2
     hooks:
@@ -71,5 +71,39 @@ - id: cspell
 
-<!--- @@inject: static/lint-help.txt --->
+`cspell --help`:
 
+<!--- @@inject: static/help.txt --->
+
 ```
+Usage: cspell [options] [command]
+
+Spelling Checker for Code
+
+Options:
+  -V, --version                         output the version number
+  -h, --help                            display help for command
+
+Commands:
+  lint [options] [globs...]             Check spelling
+  trace [options] [words...]            Trace words -- Search for words in the
+                                        configuration and dictionaries.
+  check [options] <files...>            Spell check file(s) and display the
+                                        result. The full file is displayed in
+                                        color.
+  suggestions|sug [options] [words...]  Spelling Suggestions for words.
+  link                                  Link dictionaries and other settings to
+                                        the cspell global config.
+  help [command]                        display help for command
+```
+
+<!--- @@inject-end: static/help.txt --->
+
+### Lint
+
+`lint` is the default command.
+
+`cspell lint --help`:
+
+<!--- @@inject: static/help-lint.txt --->
+
+```
 Usage: cspell lint [options] [globs...] [file://<path> ...] [stdin[://<path>]]
@@ -172,4 +206,137 @@
 
-<!--- @@inject-end: static/lint-help.txt --->
+<!--- @@inject-end: static/help-lint.txt --->
 
+### Trace
+
+`cspell trace --help`:
+
+<!--- @@inject: static/help-trace.txt --->
+
+```
+Usage: cspell trace [options] [words...]
+
+Trace words -- Search for words in the configuration and dictionaries.
+
+Options:
+  -c, --config <cspell.json>  Configuration file to use.  By default cspell
+                              looks for cspell.json in the current directory.
+  --locale <locale>           Set language locales. i.e. "en,fr" for English
+                              and French, or "en-GB" for British English.
+  --language-id <language>    Use programming language. i.e. "php" or "scala".
+  --allow-compound-words      Turn on allowCompoundWords
+  --no-allow-compound-words   Turn off allowCompoundWords
+  --ignore-case               Ignore case and accents when searching for words.
+  --no-ignore-case            Do not ignore case and accents when searching for
+                              words.
+  --dictionary-path <format>  Configure how to display the dictionary path.
+                              (choices: "hide", "short", "long", "full",
+                              default: Display most of the path.)
+  --stdin                     Read words from stdin.
+  --all                       Show all dictionaries.
+  --only-found                Show only dictionaries that have the words.
+  --no-color                  Turn off color.
+  --color                     Force color
+  --no-default-configuration  Do not load the default configuration and
+                              dictionaries.
+  -h, --help                  display help for command
+```
+
+<!--- @@inject-end: static/help-trace.txt --->
+
+### Check
+
+`cspell check --help`:
+
+<!--- @@inject: static/help-check.txt --->
+
+```
+Usage: cspell check [options] <files...>
+
+Spell check file(s) and display the result. The full file is displayed in
+color.
+
+Options:
+  -c, --config <cspell.json>  Configuration file to use.  By default cspell
+                              looks for cspell.json in the current directory.
+  --validate-directives       Validate in-document CSpell directives.
+  --no-validate-directives    Do not validate in-document CSpell directives.
+  --no-color                  Turn off color.
+  --color                     Force color
+  --no-exit-code              Do not return an exit code if issues are found.
+  --no-default-configuration  Do not load the default configuration and
+                              dictionaries.
+  -h, --help                  display help for command
+```
+
+<!--- @@inject-end: static/help-check.txt --->
+
+### Suggestions
+
+`cspell suggestions --help`:
+
+<!--- @@inject: static/help-suggestions.txt --->
+
+```
+Usage: cspell suggestions|sug [options] [words...]
+
+Spelling Suggestions for words.
+
+Options:
+  -c, --config <cspell.json>            Configuration file to use.  By default
+                                        cspell looks for cspell.json in the
+                                        current directory.
+  --locale <locale>                     Set language locales. i.e. "en,fr" for
+                                        English and French, or "en-GB" for
+                                        British English.
+  --language-id <language>              Use programming language. i.e. "php" or
+                                        "scala".
+  -s, --no-strict                       Ignore case and accents when searching
+                                        for words.
+  --ignore-case                         Alias of --no-strict.
+  --num-changes <number>                Number of changes allowed to a word
+                                        (default: 4)
+  --num-suggestions <number>            Number of suggestions (default: 8)
+  --no-include-ties                     Force the number of suggested to be
+                                        limited, by not including suggestions
+                                        that have the same edit cost.
+  --stdin                               Use stdin for input.
+  --repl                                REPL interface for looking up
+                                        suggestions.
+  -v, --verbose                         Show detailed output.
+  -d, --dictionary <dictionary name>    Use the dictionary specified. Only
+                                        dictionaries specified will be used.
+  --dictionaries <dictionary names...>  Use the dictionaries specified. Only
+                                        dictionaries specified will be used.
+  --no-color                            Turn off color.
+  --color                               Force color
+  -h, --help                            display help for command
+```
+
+<!--- @@inject-end: static/help-suggestions.txt --->
+
+### Link
+
+`cspell link --help`:
+
+<!--- @@inject: static/help-link.txt --->
+
+```
+Usage: cspell link [options] [command]
+
+Link dictionaries and other settings to the cspell global config.
+
+Options:
+  -h, --help               display help for command
+
+Commands:
+  list|ls                  List currently linked configurations.
+  add|a <dictionaries...>  Add dictionaries any other settings to the cspell
+                           global config.
+  remove|r <paths...>      Remove matching paths / packages from the global
+                           config.
+  help [command]           display help for command
+```
+
+<!--- @@inject-end: static/help-link.txt --->
+
 ## Versioning
@@ -179,2 +346,2 @@
 
-`minor` and `patch` versioning goes up independently from `cspell`.
+`minor` and `patch` versioning goes up independently from `cspell`. Where possible, the `minor` version should match `cspell`.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

16699

increased by72.12%

Number of lines in readme file

344

increased by94.35%

Dependency changes

• + Added@cspell/dict-en_us@4.3.27(transitive)

• + Added@cspell/dict-npm@5.1.13(transitive)

• - Removed@cspell/dict-en_us@4.3.28(transitive)

• - Removed@cspell/dict-npm@5.1.14(transitive)

• Updatedcspell@^7.3.8