cspell  6.10.1
About: CSpell is a command line tool and library for spell checking code (requires Node.js 14.x).
  Fossies Dox: cspell-6.10.1.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

Loading...
Searching...
No Matches
cspell Documentation

Some Fossies usage hints in advance:

  1. To see the Doxygen generated documentation please click on one of the items in the steelblue colored "quick index" bar above or use the side panel at the left which displays a hierarchical tree-like index structure and is adjustable in width.
  2. If you want to search for something by keyword rather than browse for it you can use the client side search facility (using Javascript and DHTML) that provides live searching, i.e. the search results are presented and adapted as you type in the Search input field at the top right.
  3. Doxygen doesn't incorporate all member files but just a definable subset (basically the main project source code files that are written in a supported language). So to search and browse all member files you may visit the Fossies cspell-6.10.1.tar.gz contents page and use the Fossies standard member browsing features (also with source code highlighting and additionally with optional code folding).
README.md

CSpell

unit tests integration tests lint coverage

codecov Coverage Status

The cspell mono-repo, a spell checker for code.

Support Future Development

Documentation

Documentation - CSpell

Packages

  • cspell-cli -- cspell-cli is useful for including cspell directly from GitHub.

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

    This will add the cspell-cli command, which is an alias of the cspell command.

RFCs

Link Description Status
rfc-0001 Fixing common misspellings Not started
rfc-0002 Improving Generated Suggestions Done
rfc-0003 Plug-ins: Adding file parsers In Progress
rfc-0004 Support Marking Issues as Known Not started

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.

Security contact information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Versions

version Node Support End-Of-Life
cspell 6.x 14.x In Active Development TBD
cspell 5.x 12.x Security and bug fixes 2023-05-01
cspell 4.x 10.x Paid support only1 2022-05-01

  1. Support - Street Side Software↩︎