-
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move using a custom dictionary to file under 'docs'
This is more consistent with the other dictionary examples and how-tos. Signed-off-by: Daniel F. Dickinson <[email protected]>
- Loading branch information
1 parent
fcdc2a6
commit 228514b
Showing
2 changed files
with
33 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# 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"] | ||
} | ||
``` | ||
|
||
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". | ||
|