@cspell/dict-git
v3.1.0
CSpell configuration for GIT.
1.0M/weekUpdated 2 weeks agoMITUnpacked: 7.2 KB
Published by Street Side Software
npm install @cspell/dict-gitCSpell Git Configuration
Configuration for spell checking Git Commit messages.
Requirements
| Tool | Version |
| ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
| cspell | >= 8 |
| Code Spell Checker - Visual Studio Code | >= 4 |
Local Installation
This package is bundled with CSpell.
Configuration
VSCode Settings
Add the following to your VSCode settings:
.vscode/settings.json
``jsonc`
{
"cSpell.dictionaries": ["git"],
}
CSpell Settings
cspell.json
cspell.json
`jsonc`
{
"dictionaries": ["git"],
}
CSpell Settings
cspell.config.yaml
cspell.config.yaml
`yaml`
dictionaries:
- git
Local Installation using CDN
> NOTE: This package is bundled with CSpell.
Dictionary Information
| Name | Enabled | Description |
| ----- | ------- | ----------- |
| git | | Git Terms |
Language Settings
| Name | Locale | File Type |
| ----- | ------ | -------------------------- |
| git | | commit-msg, git-commit |git
| | | shellscript |
Contributing
Please help correct any mistakes in the dictionaries.
See: Contributing
Special thanks to all of our amazing contributors!
$3
See: How to Create a New Dictionary
Usage commit-msg
.git/hooks/commit-msg
`sh
#!/bin/sh
exec npx cspell --language-id commit-msg $1
``
License
MIT
> Some packages may have other licenses included.
---
Brought to you by 
Street Side Software