cspell-cli 5.6.6 → 5.6.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.pre-commit-hooks.yaml +15 -0
- package/CHANGELOG.md +6 -0
- package/README.md +47 -4
- package/package.json +3 -2
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
# For use with pre-commit.
|
|
3
|
+
# See usage instructions at http://pre-commit.com
|
|
4
|
+
|
|
5
|
+
- id: cspell
|
|
6
|
+
name: cspell
|
|
7
|
+
description: This hook runs CSpell spellchecker
|
|
8
|
+
entry: cspell-cli
|
|
9
|
+
language: node
|
|
10
|
+
types: [text]
|
|
11
|
+
args:
|
|
12
|
+
- --no-must-find-files
|
|
13
|
+
- --no-progress
|
|
14
|
+
- --no-summary
|
|
15
|
+
- --gitignore
|
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
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.
|
|
4
4
|
|
|
5
|
+
### [5.6.10](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.9...v5.6.10) (2021-10-06)
|
|
6
|
+
|
|
7
|
+
### [5.6.9](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.8...v5.6.9) (2021-09-24)
|
|
8
|
+
|
|
9
|
+
### [5.6.7](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.6...v5.6.7) (2021-09-13)
|
|
10
|
+
|
|
5
11
|
### [5.6.6](https://github.com/streetsidesoftware/cspell-cli/compare/v5.6.5...v5.6.6) (2021-09-13)
|
|
6
12
|
|
|
7
13
|
|
package/README.md
CHANGED
|
@@ -1,11 +1,54 @@
|
|
|
1
1
|
# cspell-cli
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
## Setup [pre-commit](https://pre-commit.com) Hook
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
This repository enables using [cspell](https://github.com/streetsidesoftware/cspell) as a [pre-commit](https://pre-commit.com) hook.
|
|
6
6
|
|
|
7
|
+
```yaml
|
|
8
|
+
# .pre-commit-config.yaml
|
|
9
|
+
repos:
|
|
10
|
+
- repo: https://github.com/streetsidesoftware/cspell-cli
|
|
11
|
+
rev: v5.6.10
|
|
12
|
+
hooks:
|
|
13
|
+
- id: cspell
|
|
7
14
|
```
|
|
8
|
-
|
|
15
|
+
|
|
16
|
+
## Setup Custom Dictionary
|
|
17
|
+
|
|
18
|
+
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.
|
|
19
|
+
|
|
20
|
+
`cspell.config.yaml`
|
|
21
|
+
|
|
22
|
+
```yaml
|
|
23
|
+
dictionaryDefinitions:
|
|
24
|
+
- name: myWords
|
|
25
|
+
path: ./path/to/cSpell_dict.txt
|
|
26
|
+
addWords: true
|
|
27
|
+
dictionaries:
|
|
28
|
+
- myWords
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
`cSpell.json`
|
|
32
|
+
|
|
33
|
+
```json
|
|
34
|
+
{
|
|
35
|
+
"dictionaryDefinitions": [
|
|
36
|
+
{
|
|
37
|
+
"name": "myWords",
|
|
38
|
+
"path": "./path/to/cSpell_dict.txt",
|
|
39
|
+
"addWords": true
|
|
40
|
+
}
|
|
41
|
+
],
|
|
42
|
+
"dictionaries": ["myWords"]
|
|
43
|
+
}
|
|
9
44
|
```
|
|
10
45
|
|
|
11
|
-
|
|
46
|
+
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".
|
|
47
|
+
|
|
48
|
+
## Install from GitHub
|
|
49
|
+
|
|
50
|
+
This repo also allows installing the `cspell-cli` directly from GitHub:
|
|
51
|
+
|
|
52
|
+
```
|
|
53
|
+
npm install -g git+https://github.com/streetsidesoftware/cspell-cli
|
|
54
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cspell-cli",
|
|
3
|
-
"version": "5.6.
|
|
3
|
+
"version": "5.6.10",
|
|
4
4
|
"description": "CLI for cspell: A Spelling Checker for Code!",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"bin": {
|
|
@@ -25,12 +25,13 @@
|
|
|
25
25
|
},
|
|
26
26
|
"homepage": "https://github.com/streetsidesoftware/cspell-cli#readme",
|
|
27
27
|
"files": [
|
|
28
|
+
".pre-commit-hooks.yaml",
|
|
28
29
|
"index.js"
|
|
29
30
|
],
|
|
30
31
|
"engines": {
|
|
31
32
|
"node": ">=12.13.0"
|
|
32
33
|
},
|
|
33
34
|
"dependencies": {
|
|
34
|
-
"cspell": "^5.
|
|
35
|
+
"cspell": "^5.12.1"
|
|
35
36
|
}
|
|
36
37
|
}
|