Skip to content

Files

Latest commit

 

History

History
57 lines (44 loc) · 1.48 KB

cspell.md

File metadata and controls

57 lines (44 loc) · 1.48 KB
title description layout
Trunk | How to run cspell
CSpell is a linter for identifying and fixing spelling errors in source code, documentation, and configuration files, enhancing overall project quality.
title description tableOfContents outline pagination
visible
true
visible
visible
true
visible
true
visible
true

cspell

cspell is a linter for All.

You can enable the cspell linter with:

trunk check enable cspell

cspell example output

Auto Enabling

cspell will never be auto-enabled. It must be enabled manually.

Settings

cspell supports the following config files:

  • .cspell.json
  • cspell.json
  • .cSpell.json
  • cSpell.json
  • cspell.config.js
  • cspell.config.cjs
  • cspell.config.json
  • cspell.config.yaml
  • cspell.config.yml
  • cspell.yaml
  • cspell.yml

You can move these files to .trunk/configs and trunk check will still find them. See Moving Linters for more info. Trunk Code Quality provides a default cspell.yaml if your project does not already have one.

Links