cspell-cli 5.6.7 → 5.6.11

package/.pre-commit-hooks.yaml

@@ -7,5 +7,9 @@
   description: This hook runs CSpell spellchecker
   entry: cspell-cli
   language: node
-  types: [file]
-  verbose: true
+  types: [text]
+  args:
+    - --no-must-find-files
+    - --no-progress
+    - --no-summary
+    - --gitignore

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [5.6.11](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.10...v5.6.11) (2021-12-02)
+
+### [5.6.10](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.9...v5.6.10) (2021-10-06)
+
+### [5.6.9](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.8...v5.6.9) (2021-09-24)
+
 ### [5.6.7](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.6...v5.6.7) (2021-09-13)
 
 ### [5.6.6](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.5...v5.6.6) (2021-09-13)

package/README.md

@@ -1,11 +1,54 @@
 # cspell-cli
 
-This is just a simple repository that allows [cspell](https://github.com/streetsidesoftware/cspell) to be installed from github.
+## Setup [pre-commit](https://pre-commit.com) Hook
 
-To install:
+This repository enables using [cspell](https://github.com/streetsidesoftware/cspell) as a [pre-commit](https://pre-commit.com) hook.
 
+```yaml
+# .pre-commit-config.yaml
+repos:
+  - repo: https://github.com/streetsidesoftware/cspell-cli
+    rev: v5.6.10
+    hooks:
+      - id: cspell
 ```
-npm install -g git+https://github.com/streetsidesoftware/cspell-cli
+
+## Setup Custom Dictionary
+
+To use a custom dictionary with the `pre-commit` hook, create either a `cspell.config.yaml` or `cspell.json` file in your project's root directory.
+
+`cspell.config.yaml`
+
+```yaml
+dictionaryDefinitions:
+  - name: myWords
+    path: ./path/to/cSpell_dict.txt
+    addWords: true
+dictionaries:
+  - myWords
+```
+
+`cSpell.json`
+
+```json
+{
+  "dictionaryDefinitions": [
+    {
+      "name": "myWords",
+      "path": "./path/to/cSpell_dict.txt",
+      "addWords": true
+    }
+  ],
+  "dictionaries": ["myWords"]
+}
 ```
 
-This will add the `cspell-cli` command to npm.
+If you installed the [Code Spell Checker extension](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) for VS Code, this can be done automatically from the command palette by running "Spell: Create a CSpell configuration file".
+
+## Install from GitHub
+
+This repo also allows installing the `cspell-cli` directly from GitHub:
+
+```
+npm install -g git+https://github.com/streetsidesoftware/cspell-cli
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cspell-cli",
-  "version": "5.6.7",
+  "version": "5.6.11",
   "description": "CLI for cspell: A Spelling Checker for Code!",
   "main": "index.js",
   "bin": {
@@ -32,6 +32,6 @@
     "node": ">=12.13.0"
   },
   "dependencies": {
-    "cspell": "^5.9.1"
+    "cspell": "^5.13.1"
   }
 }