Installation
Getting started
Installation, verification, and the two commands used most frequently in daily work.
- Install and verify operation
- Fix a word with
Ctrl. - Add project-specific terminology
Documentation
Three entry points, according to what you need.
Behavior
What is reported
Identifiers are split into their component words. Symbols, hex values, and words of three characters or fewer are not reported.
const recieveMessage = ...
// the lenght of the queue
color: #3f8ac2; // not reported
Configuration
Configuration and directives
The complete settings reference, together with the in-document cSpell: directives.
- Languages & dictionaries
- Files, folders & workspaces
- Reporting, appearance, performance
Common tasks
The topics consulted most often.
Add a word to a dictionaryWhere added words are stored, and how to share them across a repository.Select a language or localeSet the locale, and install any of the 50+ additional language dictionaries.Exclude files and foldersIgnore paths such as node_modules and generated output.Fine-tune checking within a fileIn-document directives: cSpell:disable, ignore, words.Enable a file typeUse the status bar control, or configure it in the settings.Check a project in CIThe cspell command-line tool reads the same configuration.
Local
Dictionaries and checking are local to the machine. No document content is sent to an external service.
50+ languages
Additional language dictionaries, from Dutch and German to Ancient Greek, are available as separate extensions.
25+ file types
TypeScript, Python, Go, Rust, Markdown, LaTeX, YAML, and SQL are supported by default.
Since 2016
Developed and maintained openly by Street Side Software. Sponsorship →
In the editor
Unrecognized words are marked as the document is edited.
Installation and documentation
The extension operates with the default configuration; no setup is required to begin.