cspell-cli

Usage

To check all files under the current directory, run:

npx cspell-cli --gitignore .

Setup pre-commit Hook

This repository enables using cspell as a pre-commit hook.

# .pre-commit-config.yaml
repos:
  - repo: https://github.com/streetsidesoftware/cspell-cli
    rev: v9.7.0
    hooks:
      - id: cspell # Spell check changed files
      - id: cspell # Spell check the commit message
        name: check commit message spelling
        args:
          - --no-must-find-files
          - --no-progress
          - --no-summary
          - --files
          - .git/COMMIT_EDITMSG
        stages: [commit-msg]
        always_run: true # This might not be necessary.

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

dictionaryDefinitions:
  - name: myWords
    path: ./path/to/cSpell_dict.txt
    addWords: true
dictionaries:
  - myWords

cSpell.json

{
  "dictionaryDefinitions": [
    {
      "name": "myWords",
      "path": "./path/to/cSpell_dict.txt",
      "addWords": true
    }
  ],
  "dictionaries": ["myWords"]
}

If you installed the Code Spell Checker extension for VS Code, this can be done automatically from the command palette by running "Spell: Create a CSpell configuration file".

Install from GitHub

This repo also allows installing the cspell-cli directly from GitHub:

npm install -g git+https://github.com/streetsidesoftware/cspell-cli

Docker

Package cspell

docker run -v $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest .

See Extending the Docker Container to include German

Usage

cspell --help: