streetsidesoftwareCSpell 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
<summary>VSCode Settings</summary>
Add the following to your VSCode settings:
.vscode/settings.json
{
"cSpell.dictionaries": ["git"],
}
<summary>CSpell Settings
cspell.json</summary>
cspell.json
{
"dictionaries": ["git"],
}
<summary>CSpell Settings
cspell.config.yaml</summary>
cspell.config.yaml
dictionaries:
- gitLocal 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!
Dictionary Development
See: How to Create a New Dictionary
Usage commit-msg
.git/hooks/commit-msg
#!/bin/sh
exec npx cspell --language-id commit-msg $1License
MIT
Some packages may have other licenses included.
Brought to you by
Street Side Software