cspell-cli 8.16.1 → 8.17.1

package/README.md

@@ -18,9 +18,19 @@ This repository enables using [cspell](https://github.com/streetsidesoftware/csp
 # .pre-commit-config.yaml
 repos:
   - repo: https://github.com/streetsidesoftware/cspell-cli
-    rev: v8.16.1
+    rev: v8.17.1
     hooks:
-      - id: cspell
+      - id: cspell # Spell check changed files
+      - id: cspell # Spell check the commit message
+        name: check commit message spelling
+        args:
+          - --no-must-find-files
+          - --no-progress
+          - --no-summary
+          - --files
+          - .git/COMMIT_EDITMSG
+        stages: [commit-msg]
+        always_run: true # This might not be necessary.
 ```
 
 <!-- x-release-please-end -->
@@ -149,8 +159,8 @@ Options:
   -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.
+                               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.
@@ -183,8 +193,7 @@ Options:
   --gitignore                  Ignore files matching glob patterns found in
                                .gitignore files.
   --no-gitignore               Do NOT use .gitignore files.
-  --gitignore-root <path>      Prevent searching for .gitignore files past
-                               root.
+  --gitignore-root <path>      Prevent searching for .gitignore files past root.
   --validate-directives        Validate in-document CSpell directives.
   --color                      Force color.
   --no-color                   Turn off color.
@@ -238,8 +247,8 @@ 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.
+  --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
@@ -270,8 +279,7 @@ Options:
 ```
 Usage: cspell check [options] <files...>
 
-Spell check file(s) and display the result. The full file is displayed in
-color.
+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

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "provenance": true
   },
-  "version": "8.16.1",
+  "version": "8.17.1",
   "description": "CLI for cspell; A Spelling Checker for Code!",
   "type": "module",
   "module": "index.js",
@@ -47,10 +47,10 @@
     "node": ">=18"
   },
   "dependencies": {
-    "cspell": "^8.16.1"
+    "cspell": "^8.17.2"
   },
   "devDependencies": {
     "inject-markdown": "^3.1.4",
-    "prettier": "^3.3.3"
+    "prettier": "^3.4.2"
   }
 }