# CSpell [![unit tests](https://github.com/streetsidesoftware/cspell/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/streetsidesoftware/cspell/actions) [![integration tests](https://github.com/streetsidesoftware/cspell/actions/workflows/integration-test.yml/badge.svg?branch=main)](https://github.com/streetsidesoftware/cspell/actions) [![lint](https://github.com/streetsidesoftware/cspell/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/streetsidesoftware/cspell/actions) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/11469/badge)](https://www.bestpractices.dev/projects/11469) [![coverage](https://github.com/streetsidesoftware/cspell/actions/workflows/coverage.yml/badge.svg?branch=main)](https://github.com/streetsidesoftware/cspell/actions) [![codecov](https://codecov.io/gh/streetsidesoftware/cspell/branch/main/graph/badge.svg?token=Dr4fi2Sy08)](https://codecov.io/gh/streetsidesoftware/cspell) [![Coverage Status](https://coveralls.io/repos/github/streetsidesoftware/cspell/badge.svg?branch=main)](https://coveralls.io/github/streetsidesoftware/cspell) The CSpell mono-repo, a spell checker for code. ## Support Future Development [![GitHub Sponsors](https://img.shields.io/badge/-Street_Side_Software-black?style=for-the-badge&logo=githubsponsors&label=GitHub%20Sponsor%3A)](https://github.com/sponsors/streetsidesoftware) [![Open Collective](https://img.shields.io/badge/-CSpell-black?style=for-the-badge&logo=opencollective&label=Open%20Collective%3A)](https://opencollective.com/cspell) [![Street Side Software](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fstreetsidesoftware%2Fcspell%2Frefs%2Fheads%2Fmain%2Fstatic%2Fcspell-badge.json)](https://streetsidesoftware.com/sponsor/) [![PayPal](https://img.shields.io/badge/-Street_Side_Software-black?style=for-the-badge&logo=paypal&label=PayPal%20Donate%3A)](https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY) ## Documentation [Documentation - CSpell](https://cspell.org/docs/getting-started) ## Third-Party Video Presentations Some videos related to CSpell and the [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) for VS Code. - [Spell Checking Documentation in DevOps Pipelines](https://www.youtube.com/watch?v=w8gGi3aeVpc) by Houssem Dellai - [Don't Worry About Spelling...VS Code Can Do It For You!!](https://www.youtube.com/watch?v=MfxFMFMsBP4) by [James Q Quick](https://www.youtube.com/@JamesQQuick) - [Spell Checking In VSCode - VSCode Pro Tips](https://www.youtube.com/watch?v=_GwpPJgH1Gw) - [Spell Check in VS Code with Code Spell Checker - Extension Highlight](https://www.youtube.com/watch?v=ZxNnOjWetH4) - [Spell check your code from the command line with Cspell](https://www.youtube.com/watch?v=nwmJ9h_zPJc) - [How to Use VS Code Spell Checker](https://www.youtube.com/watch?v=Ix5bMd0kZeY) - Detailed walkthrough to setup and use multiple languages - [Code Spell Checker Extension for Visual Studio Code](https://www.youtube.com/watch?v=dUn1mrJYMrM) ## Packages - [cspell](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell) -- cspell command-line application - [@cspell/eslint-plugin](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin) -- CSpell ESLint Plugin - [cspell-bundled-dicts](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-bundled-dicts) -- collection of dictionaries bundled with cspell. - [cspell-glob](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-glob) -- glob library. - [cspell-io](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-io) -- i/o library. - [cspell-lib](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-lib) -- cspell library used for code driven spelling checking (used by the application). - [cspell-types](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-types) -- cspell types and JSON schema for cspell configuration files. - [cspell-tools](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-tools) -- tool used to compile dictionaries. - [cspell-trie-lib](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-trie-lib) -- trie data structure used to store words. - [cspell-trie](https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-trie) -- trie data tool used to store words. - [hunspell-reader](https://github.com/streetsidesoftware/cspell/tree/main/packages/hunspell-reader) -- reads Hunspell files and outputs words. ## Related Packages - [cspell-cli](https://github.com/streetsidesoftware/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](https://github.com/streetsidesoftware/cspell/tree/main/rfc/rfc-0001%20suggestions/) | Fixing common misspellings | Done | | [rfc-0002](https://github.com/streetsidesoftware/cspell/tree/main/rfc/rfc-0002%20improve%20dictionary%20suggestions/) | Improving Generated Suggestions | Done | | [rfc-0003](https://github.com/streetsidesoftware/cspell/tree/main/rfc/rfc-0003%20parsing%20files/) | Plug-ins: Adding file parsers | In Progress | | [rfc-0004](https://github.com/streetsidesoftware/cspell/tree/main/rfc/rfc-0004%20known%20issues/) | 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.](https://tidelift.com/subscription/pkg/npm-cspell?utm_source=npm-cspell&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) ## Security contact information To report a security vulnerability, please email or use the [Tidelift security contact](https://tidelift.com/security). Tidelift will coordinate the fix and disclosure. ## Versions | | version | Node | Status | Maintenance | End of Free Support | | :----- | :------ | :------ | :-------------------- | :---------- | :------------------ | | cspell | 10.x | 22.18.x | In Active Development | TBD | TBD | | cspell | 9.x | 20.x | Maintenance | 2026-04-05 | 2026-10-01 | | cspell | 8.x | 18.x | Maintenance | 2025-05-01 | 2025-06-01 | | cspell | 7.x | 16.x | Paid support only[^1] | 2023-10-01 | 2023-11-07 | | cspell | 6.x | 14.14.x | Paid support only[^1] | 2023-04-01 | 2023-05-01 | | cspell | 5.x | 12.x | Paid support only[^1] | - | 2022-10-01 | | cspell | 4.x | 10.x | Paid support only[^1] | - | 2022-05-01 | [^1]: [Support - Street Side Software](https://streetsidesoftware.com/support/#maintenance-agreements) ## Contributing Contributions are welcome! See our [contribution notes](CONTRIBUTING.md). **Note:** To add or remove words in a dictionary, visit [cspell-dicts](https://github.com/streetsidesoftware/cspell-dicts/issues). 🙏 _**Special thanks to all of our amazing contributors!**_ 🥰 [Contributor Jason3S](https://github.com/Jason3S) [Contributor NaufalK25](https://github.com/NaufalK25) [Contributor Subharup-31](https://github.com/Subharup-31) [Contributor FengYun0611](https://github.com/FengYun0611) [Contributor mrksbnc](https://github.com/mrksbnc) [Contributor coliff](https://github.com/coliff) [Contributor LuckyWindsck](https://github.com/LuckyWindsck) [Contributor thompson-tomo](https://github.com/thompson-tomo) [Contributor nschonni](https://github.com/nschonni) [Contributor amanoji](https://github.com/amanoji) [Contributor jrylan](https://github.com/jrylan) [Contributor mad-gooze](https://github.com/mad-gooze) [Contributor snyk-bot](https://github.com/snyk-bot) [Contributor zo](https://github.com/zo) [Contributor dsanders11](https://github.com/dsanders11) [Contributor benmccann](https://github.com/benmccann) [Contributor fisker](https://github.com/fisker) [Contributor dakotaJang](https://github.com/dakotaJang) [Contributor aimagic](https://github.com/aimagic) [Contributor abdusabri](https://github.com/abdusabri) [Contributor tlindsay42](https://github.com/tlindsay42) [Contributor caaatisgood](https://github.com/caaatisgood) [Contributor pzmarzly](https://github.com/pzmarzly) [Contributor naveensrinivasan](https://github.com/naveensrinivasan) [Contributor thebolarin](https://github.com/thebolarin) [Contributor matt9ucci](https://github.com/matt9ucci) [Contributor JounQin](https://github.com/JounQin) [Contributor lostintangent](https://github.com/lostintangent) [Contributor Zamiell](https://github.com/Zamiell) [Contributor dflock](https://github.com/dflock) [Contributor DenysVuika](https://github.com/DenysVuika) [Contributor amir-rahmanii](https://github.com/amir-rahmanii) [Contributor AhmedAlaa4611](https://github.com/AhmedAlaa4611) [Contributor ScottRudiger](https://github.com/ScottRudiger) [Contributor rivy](https://github.com/rivy) [Contributor rasa](https://github.com/rasa) [Contributor roman-petrov](https://github.com/roman-petrov) [Contributor orta](https://github.com/orta) [Contributor ollelauribostrom](https://github.com/ollelauribostrom) [Contributor alexandear](https://github.com/alexandear) [Contributor ndelangen](https://github.com/ndelangen) [Contributor nvuillam](https://github.com/nvuillam) [Contributor charpeni](https://github.com/charpeni) [Contributor exhuma](https://github.com/exhuma) [Contributor 74th](https://github.com/74th) [Contributor ssbarnea](https://github.com/ssbarnea) [Contributor regseb](https://github.com/regseb) [Contributor zwaldowski](https://github.com/zwaldowski) [Contributor cylewaitforit](https://github.com/cylewaitforit) [Contributor hzhu](https://github.com/hzhu) [Contributor jonz94](https://github.com/jonz94) [Contributor mrazauskas](https://github.com/mrazauskas) [Contributor richbeck2](https://github.com/richbeck2) [Contributor wtgtybhertgeghgtwtg](https://github.com/wtgtybhertgeghgtwtg) [Contributor wujekbogdan](https://github.com/wujekbogdan) [Contributor siosio34](https://github.com/siosio34) [Contributor ADTC](https://github.com/ADTC) [Contributor kachkaev](https://github.com/kachkaev) [Contributor AlexJameson](https://github.com/AlexJameson) [Contributor AlekSi](https://github.com/AlekSi) [Contributor alicewriteswrongs](https://github.com/alicewriteswrongs) [Contributor aminya](https://github.com/aminya) [Contributor bluwy](https://github.com/bluwy) [Contributor screendriver](https://github.com/screendriver) [Contributor Namchee](https://github.com/Namchee) [Contributor valcosmos](https://github.com/valcosmos) [Contributor d2s](https://github.com/d2s) [Contributor dimitropoulos](https://github.com/dimitropoulos) [Contributor evenstensberg](https://github.com/evenstensberg) [Contributor tribut](https://github.com/tribut) [Contributor HoussemDellai](https://github.com/HoussemDellai) [Contributor jmatsuzawa](https://github.com/jmatsuzawa) [Contributor joshje](https://github.com/joshje) [Contributor kamontat](https://github.com/kamontat) [Contributor kenji-miyake](https://github.com/kenji-miyake) [Contributor fughilli](https://github.com/fughilli) [Contributor Ki-er](https://github.com/Ki-er) [Contributor Jason-Rev](https://github.com/Jason-Rev) [Contributor Maxim-Mazurok](https://github.com/Maxim-Mazurok) [Contributor bisubus](https://github.com/bisubus)
---

Brought to you byStreet Side Software Logo Street Side Software