cspell-cli 6.24.0 → 6.27.0

package/README.md

@@ -63,38 +63,49 @@ docker run -v $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest "**"
 
 ## Usage
 
+<!--- @@inject: static/lint-help.txt --->
+
 ```
-Usage: cspell-cli lint [options] [globs...]
+Usage: cspell lint [options] [globs...] [file://<path> ...] [stdin[://<path>]]
+
+Patterns:
+ - [globs...]            Glob Patterns
+ - [stdin]               Read from "stdin" assume text file.
+ - [stdin://<path>]      Read from "stdin", use <path> for file type and config.
+ - [file://<path>]       Check the file at <path>
+
+Examples:
+    cspell .                        Recursively check all files.
+    cspell lint .                   The same as "cspell ."
+    cspell "*.js"                   Check all .js files in the current directory
+    cspell "**/*.js"                Check all .js files recursively
+    cspell "src/**/*.js"            Only check .js under src
+    cspell "**/*.txt" "**/*.js"     Check both .js and .txt files.
+    cspell "**/*.{txt,js,md}"       Check .txt, .js, and .md files.
+    cat LICENSE | cspell stdin      Check stdin
+    cspell stdin://docs/doc.md      Check stdin as if it was "./docs/doc.md"
 
 Check spelling
 
 Options:
   -c, --config <cspell.json>   Configuration file to use.  By default cspell
                                looks for cspell.json in the current directory.
-
   -v, --verbose                Display more information about the files being
                                checked and the configuration.
-
   --locale <locale>            Set language locales. i.e. "en,fr" for English
                                and French, or "en-GB" for British English.
-
   --language-id <language>     Force programming language for unknown
                                extensions. i.e. "php" or "scala"
-
   --words-only                 Only output the words not found in the
                                dictionaries.
-
   -u, --unique                 Only output the first instance of a word not
                                found in the dictionaries.
-
   -e, --exclude <glob>         Exclude files matching the glob pattern. This
                                option can be used multiple times to add
                                multiple globs.
-
   --file-list <path or stdin>  Specify a list of files to be spell checked. The
                                list is filtered against the glob file patterns.
                                Note: the format is 1 file path per line.
-
   --no-issues                  Do not show the spelling errors.
   --no-progress                Turn off progress messages
   --no-summary                 Turn off summary message in console.
@@ -119,24 +130,37 @@ Options:
   --no-gitignore               Do NOT use .gitignore files.
   --gitignore-root <path>      Prevent searching for .gitignore files past
                                root.
+  --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-default-configuration   Do not load the default configuration and
                                dictionaries.
   --debug                      Output information useful for debugging
                                cspell.json files.
+  --reporter <module|path>     Specify one or more reporters to use.
   -h, --help                   display help for command
 
+More Examples:
 
-Examples:
-    cspell "*.js"                   Check all .js files in the current directory
-    cspell "**/*.js"                Check all .js files from the current directory
-    cspell "src/**/*.js"            Only check .js under src
-    cspell "**/*.txt" "**/*.js"     Check both .js and .txt files.
-    cspell "**/*.{txt,js,md}"       Check .txt, .js, and .md files.
-    cat LICENSE | cspell stdin      Check stdin
+    cspell "**/*.js" --reporter @cspell/cspell-json-reporter
+        This will spell check all ".js" files recursively and use
+        "@cspell/cspell-json-reporter".
+
+    cspell . --reporter default
+        This will force the default reporter to be used overriding
+        any reporters defined in the configuration.
+
+    cspell . --reporter ./<path>/reporter.cjs
+        Use a custom reporter. See API for details.
+
+References:
+    https://cspell.org
+    https://github.com/streetsidesoftware/cspell
 ```
 
+<!--- @@inject-end: static/lint-help.txt --->
+
 ## Versioning
 
 The major version of `cspell-cli` tries to match the major version of `cspell`.

package/index.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
 
-'use strict';
+"use strict";
 
-require('cspell/bin');
+require("cspell/bin");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "cspell-cli",
-  "version": "6.24.0",
-  "description": "CLI for cspell: A Spelling Checker for Code!",
+  "version": "6.27.0",
+  "description": "CLI for cspell; A Spelling Checker for Code!",
   "main": "index.js",
   "bin": {
     "cspell-cli": "index.js"
@@ -11,7 +11,10 @@
     "version-release-minor": "npx standard-version -r minor",
     "version-release-patch": "npx standard-version -r patch",
     "version-release": "npx standard-version",
-    "test": "node ./index.js \"**\""
+    "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",
+    "test": "node ./index.js ."
   },
   "repository": {
     "type": "git",
@@ -34,6 +37,10 @@
     "node": ">=14"
   },
   "dependencies": {
-    "cspell": "^6.24.0"
+    "cspell": "^6.27.0"
+  },
+  "devDependencies": {
+    "inject-markdown": "^1.5.0",
+    "prettier": "^2.8.4"
   }
 }