lix-website/themes/lix/assets/bootstrap/node_modules/@cspell/dict-git/README.md
2024-04-26 22:49:34 -06:00

712 B

CSpell Git Configuration

Configuration for spell checking Git Commit messages.

Installation

Global Install and add to cspell global settings.

npm install -g @cspell/dict-git
cspell link add @cspell/dict-git

Uninstall from cspell

cspell link remove @cspell/dict-git

Manual Installation

The cspell-ext.json file in this package should be added to the import section in your cspell.json file.

{
    // …
    "import": ["@cspell/dict-git/cspell-ext.json"],
    // …
}

Usage commit-msg

.git/hooks/commit-msg

#!/bin/sh

exec npx cspell --language-id commit-msg $1

License

MIT

Some packages may have other licenses included.