Link Search Menu Expand Document

Welcome to CSpell

A Spell Checker for Code!

cspell is a command line tool and library for spell checking code.

Support Future Development

Features

  • Spell Checks Code – Able to spell check code by parsing it into words before checking against the dictionaries.
  • Supports CamelCase, snake_case, and compoundwords naming styles.
  • Self contained – does not depend upon OS libraries like Hunspell or aspell. Nor does it depend upon online services.
  • Fast – checks 1000’s of lines of code in seconds.
  • Programming Language Specific Dictionaries – Has dedicated support for:
    • JavaScript, TypeScript, Python, PHP, C#, C++, LaTex, Go, HTML, CSS, etc.
  • Customizable – supports custom dictionaries and word lists.
  • Continuous Integration Support – Can easily be added as a linter to Travis-CI.

CSpell was initially built as the spell checking service for the spell checker extension for Visual Studio Code.

CSpell for Enterprise

Available as part of the Tidelift Subscription.

The maintainers of CSpell and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. Learn more.

Installation

npm install -g cspell

Basic Usage

Example: recursively spell check all JavaScript files in src

JavaScript files

cspell "src/**/*.js"
# or
cspell lint "src/**/*.js"

Check everything

cspell "**"

Getting Started

See: Getting Started

Requirements

  version Node
cspell 5.x 12.x
cspell 4.x 10.x