cspell-config

A CSpell shareable config.

Installation

Run the following command (this will also install dependencies):

pnpm add --save-dev @its-tailtime/cspell-config

Then, create a cspell.config.json file at the root of your repository containing the following:

{
  "version": "0.2",
  "import": "@its-tailtime/cspell-config"
}

You can override settings from the shareable config by adding them directly into your cspell.config.json file.

CI Integration

To enforce spellchecking in your pipelines, add the following to package.json's scripts section':

  "scripts": {
    // ...
    "spellcheck": "cspell lint \"src/**/*.{js,ts,vue}\" \"src/locales/en-gb/**/*\"",
    // And add it to the lint script:
    "lint": "pnpm run spellcheck ..."
    // ...
  }