Package detail

@cspell/cspell-pipe

streetsidesoftware2.2mMIT8.17.2

Library to make working with Iterators/AsyncIterators easier.

cspell, pipe, Iterator, Iterable, AsyncIterator, AsyncIterable

readme

CSpell

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

Support Future Development

Documentation

Documentation - CSpell

Third-Party Video Presentations

Some videos related to CSpell and the Code Spell Checker for VS Code.

Spell Checking Documentation in DevOps Pipelines by Houssem Dellai
Don't Worry About Spelling...VS Code Can Do It For You!! by James Q Quick
Spell Checking In VSCode - VSCode Pro Tips
Spell Check in VS Code with Code Spell Checker - Extension Highlight
Spell check your code from the command line with Cspell
How to Use VS Code Spell Checker - Detailed walkthrough to setup and use multiple languages
Code Spell Checker Extension for Visual Studio Code

Packages

cspell -- cspell command-line application
@cspell/eslint-plugin -- CSpell ESLint Plugin
cspell-bundled-dicts -- collection of dictionaries bundled with cspell.
cspell-glob -- glob library.
cspell-io -- i/o library.
cspell-lib -- cspell library used for code driven spelling checking (used by the application).
cspell-types -- cspell types and JSON schema for cspell configuration files.
cspell-tools -- tool used to compile dictionaries.
cspell-trie-lib -- trie data structure used to store words.
cspell-trie -- trie data tool used to store words.
hunspell-reader -- reads Hunspell files and outputs words.

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.

Live Discussions

Join us on:

cspell.zulipchat.com

RFCs

Link	Description	Status
rfc-0001	Fixing common misspellings	Done
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 email security@streetsidesoftware.com or use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Versions

| | version | Node | Status | Maintenance | End of Free Support | | :----- | :------ | :------ | :-------------------- | :---------- | :------------------ | | cspell | 8.x | 18.x | In Active Development | TBD | TBD | | cspell | 7.x | 16.x | Maintenance | 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

Contributing

Contributions are welcome! See our contribution notes. Note: To add or remove words in a dictionary, visit cspell-dicts.

🙏 Special thanks to all of our amazing contributors! 🥰

Brought to you by Street Side Software Logo Street Side Software

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

8.17.2 (2025-01-13)

fix: Dump stack on error when verbose (#6782) (df0026c), closes #6782

8.17.1 (2024-12-16)

chore: Update Integration Test Performance Data (#6681) (4b19439), closes #6681

8.17.0 (2024-12-15)

chore: Update Integration Test Performance Data (#6676) (f9cb45f), closes #6676

8.16.1 (2024-11-26)

chore: Update Integration Test Performance Data (#6602) (5d667a7), closes #6602

8.16.0 (2024-11-07)

chore: Update Integration Test Performance Data (#6505) (fb78a40), closes #6505

8.15.7 (2024-11-03)

ci: Workflow Bot -- Update ALL Dependencies (main) (#6456) (d4bd0dd), closes #6456

8.15.6 (2024-11-02)

chore: Update Integration Test Performance Data (#6455) (be8b15a), closes #6455

8.15.5 (2024-10-30)

ci: Workflow Bot -- Update ALL Dependencies (main) (#6442) (70f43cc), closes #6442

8.15.4 (2024-10-18)

chore: Update Integration Test Performance Data (#6389) (7ece6a7), closes #6389

8.15.3 (2024-10-16)

chore: Update Integration Test Performance Data (#6377) (7ff6781), closes #6377

8.15.2 (2024-10-14)

chore: Update Integration Test Performance Data (#6361) (d639368), closes #6361

8.15.1 (2024-10-11)

fix: Sign Published Packages (#6350) (633b060), closes #6350

8.15.0 (2024-10-11)

chore: bump eslint-plugin-unicorn from 55.0.0 to 56.0.0 (#6332) (67d1e92), closes #6332

8.14.4 (2024-09-18)

fix: Remove object from cache (#6257) (ea24297), closes #6257

8.14.3 (2024-09-17)

chore: Update Integration Test Performance Data (#6254) (189ac16), closes #6254

8.14.2 (2024-08-20)

chore: Update Integration Test Performance Data (#6126) (012c897), closes #6126

8.14.1 (2024-08-17)

fix: Fix publishing (8a56148)

8.14.0 (2024-08-17)

chore: Update Integration Test Performance Data (#6113) (c3eb155), closes #6113

8.13.3 (2024-08-12)

chore: Update Integration Test Performance Data (#6079) (dd28ef5), closes #6079

8.13.2 (2024-08-08)

chore: Update Integration Test Performance Data (#6060) (c766d18), closes #6060

8.13.1 (2024-08-02)

chore: Update Integration Test Performance Data (#6028) (738d2a9), closes #6028

8.13.0 (2024-07-30)

chore: Update Integration Test Performance Data (#6011) (135838a), closes #6011

8.12.1 (2024-07-22)

fix: make sure the version is up to date (f6ab018)

8.12.0 (2024-07-22)

chore: Update Integration Test Performance Data (#5959) (ea71b8a), closes #5959

8.11.0 (2024-07-16)

refactor: char index (#5926) (077b3ba), closes #5926

8.10.4 (2024-07-05)

chore: force 8.10.3 (f18b8c7)

8.10.2 (2024-07-05)

ci: Workflow Bot -- Update ALL Dependencies (main) (#5862) (814e15c), closes #5862

8.10.1 (2024-07-05)

fix(cspell-tools): support adding directives (#5860) (b2e014f), closes #5860

8.10.0 (2024-07-02)

chore: Update Integration Test Performance Data (#5859) (898e806), closes #5859

8.9.1 (2024-06-20)

docs: format tables in generated docs (#5776) (02e0359), closes #5776

8.9.0 (2024-06-18)

Note: Version bump only for package cspell-monorepo

8.9.0-alpha.0 (2024-06-18)

ci: Fix Lint -- Workflow Bot (#5770) (b21032f), closes #5770

8.8.4 (2024-06-03)

ci: Fix Lint -- Workflow Bot (#5699) (211113a), closes #5699

8.8.3 (2024-05-23)

chore: Update Integration Test Performance Data (#5663) (b605dd3), closes #5663

8.8.2 (2024-05-22)

ci: Workflow Bot -- Update ALL Dependencies (main) (#5659) (5d93673), closes #5659

8.8.1 (2024-05-10)

chore: Do not stop update if it fails to lint. (64ba085)

8.8.0 (2024-05-03)

Note: Version bump only for package cspell-monorepo

8.7.0 (2024-04-10)

Note: Version bump only for package cspell-monorepo

8.6.1 (2024-03-25)

Note: Version bump only for package cspell-monorepo

8.6.0 (2024-03-05)

Note: Version bump only for package cspell-monorepo

8.5.0 (2024-03-01)

Note: Version bump only for package cspell-monorepo

8.4.1 (2024-02-20)

Note: Version bump only for package cspell-monorepo

8.4.0 (2024-02-19)

Note: Version bump only for package cspell-monorepo

8.3.2 (2024-01-02)

Bug Fixes

cspell-tools - support excluding words (#5140) (3fcdd89)

8.3.1 (2024-01-01)

Note: Version bump only for package cspell-monorepo

8.3.0 (2023-12-30)

Note: Version bump only for package cspell-monorepo

8.2.4 (2023-12-28)

Note: Version bump only for package cspell-monorepo

8.2.3 (2023-12-21)

Bug Fixes

Improve performance by reducing FS requests (#5103) (3f31569)

8.2.2 (2023-12-21)

Note: Version bump only for package cspell-monorepo

8.2.1 (2023-12-20)

Note: Version bump only for package cspell-monorepo

8.2.0 (2023-12-20)

Note: Version bump only for package cspell-monorepo

8.1.3 (2023-12-06)

Bug Fixes

Resolve relative imports without a leading ./ or ../. (#5035) (a28393b)

8.1.2 (2023-12-04)

Bug Fixes

expose ConfigLoader API (#5032) (e839990)

8.1.1 (2023-12-04)

Note: Version bump only for package cspell-monorepo

8.1.0 (2023-12-01)

Note: Version bump only for package cspell-monorepo

8.0.0 (2023-11-07)

ci: Workflow Bot -- Update ALL Dependencies (main) (#4959) (096066d), closes #4959

7.3.9 (2023-11-07)

refactor: remove debug code (#4951) (4972a77), closes #4951

7.3.8 (2023-10-13)

ci: Workflow Bot -- Update ALL Dependencies (main) (#4894) (2a4e1d8), closes #4894

7.3.7 (2023-09-28)

test: Add sample package to test dictionaries in eslint (#4875) (06c9e18), closes #4875

7.3.6 (2023-09-13)

Note: Version bump only for package cspell-monorepo

7.3.5 (2023-09-10)

Bug Fixes

Remove [@markdown](https://github.com/markdown)Description from types (#4818) (3ba8eed)

7.3.4 (2023-09-10)

Note: Version bump only for package cspell-monorepo

7.3.3 (2023-09-09)

Note: Version bump only for package cspell-monorepo

7.3.2 (2023-09-01)

Note: Version bump only for package cspell-monorepo

7.3.1 (2023-09-01)

Note: Version bump only for package cspell-monorepo

7.3.0 (2023-08-31)

Note: Version bump only for package cspell-monorepo

7.2.0 (2023-08-29)

Note: Version bump only for package cspell-monorepo

7.1.1 (2023-08-28)

Note: Version bump only for package cspell-monorepo

7.0.2 (2023-08-28)

Note: Version bump only for package cspell-monorepo

7.0.1 (2023-08-21)

Bug Fixes

Workflow Bot -- Update Dictionaries (main) (#4733) (221b59b)

7.0.0 (2023-08-10)

Note: Version bump only for package cspell-monorepo

7.0.1-alpha.9 (2023-08-10)

Note: Version bump only for package cspell-monorepo

7.0.1-alpha.8 (2023-07-21)

Bug Fixes

cspell-tools: support conditional builds. (#4668) (de4d897)

7.0.1-alpha.7 (2023-07-19)

Note: Version bump only for package cspell-monorepo

7.0.1-alpha.6 (2023-07-14)

Bug Fixes

cspell-tools: be able to update shasum checksum files. (#4634) (a67ea47)

7.0.1-alpha.5 (2023-07-13)

Bug Fixes

support automatic creation of cspell-tools.config.yaml (#4631) (f9fea67)

7.0.1-alpha.4 (2023-07-12)

Bug Fixes

Fix empty build target (#4627) (1fcbf98)

7.0.1-alpha.3 (2023-07-11)

Bug Fixes

support globs with gzip command. (#4625) (17fbc11)

7.0.1-alpha.2 (2023-07-09)

Features

Add gzip and shasum command to cspell-tools (#4614) (cc28a8a)

Bug Fixes

Workflow Bot -- Update Dictionaries (main) (#4603) (51cca40)
Workflow Bot -- Update Dictionaries (main) (#4606) (f5601ce)
Workflow Bot -- Update Dictionaries (main) (#4607) (841ffdc)

Reverts

Revert "v7.1.0-alpha.0" (4835da6)

7.0.1-alpha.1 (2023-07-03)

Note: Version bump only for package cspell-monorepo

7.0.1-alpha.0 (2023-06-09)

Note: Version bump only for package cspell-monorepo

7.0.0-alpha.2 (2023-05-07)

Note: Version bump only for package cspell-monorepo

7.0.0-alpha.1 (2023-04-14)

Note: Version bump only for package cspell-monorepo

6.31.2 (2023-04-14)

Note: Version bump only for package cspell-monorepo

6.31.1 (2023-03-24)

Note: Version bump only for package cspell-monorepo

6.31.0 (2023-03-24)

Note: Version bump only for package cspell-monorepo

6.30.2 (2023-03-18)

Bug Fixes

lock cosmiconfig to 8.0.0 (#4335) (0f37e2c)

6.30.1 (2023-03-17)

Bug Fixes

Update cosmiconfig to fix config loading issue. (#4330) (4a0bae5)

6.30.0 (2023-03-16)

Note: Version bump only for package cspell-monorepo

6.29.3 (2023-03-14)

Bug Fixes

Add option to not auto stem during split (#4310) (23059da)

6.29.2 (2023-03-13)

Bug Fixes

(cspell-tools) Delay splitting _ till later (#4309) (0e517d1)

6.29.1 (2023-03-13)

Note: Version bump only for package cspell-monorepo

6.29.0 (2023-03-11)

Note: Version bump only for package cspell-monorepo

6.28.0 (2023-03-03)

Features

Support multiple repMap combinations (#4270) (bbc3ed4)

6.27.0 (2023-02-26)

Features

Support spell checking utf16 files with BOM (#4232) (8062f62)

6.26.3 (2023-02-16)

Bug Fixes

Be able to read cache format from config (#4190) (6029893)

6.26.2 (2023-02-16)

Bug Fixes

node:worker_threads breaks on node 14 (#4185) (8654ac7)

6.26.1 (2023-02-15)

Bug Fixes

improve Dynamic Import README.md (#4178) (4ad1133)

6.26.0 (2023-02-15)

Features

All flagWords and suggestWords suggestions are preferred. (#4176) (abfb09c)

6.25.0 (2023-02-14)

Bug Fixes

Add .webm to know file types (#4171) (eeb9497)

6.24.0 (2023-02-13)

Note: Version bump only for package cspell-monorepo

6.23.1 (2023-02-12)

Note: Version bump only for package cspell-monorepo

6.23.0 (2023-02-11)

Note: Version bump only for package cspell-monorepo

6.22.0 (2023-02-05)

Note: Version bump only for package cspell-monorepo

6.21.0 (2023-02-03)

Note: Version bump only for package cspell-monorepo

6.20.1 (2023-02-01)

Bug Fixes

Correct .gitignore comment detection (#4083) (cadfbc4)

6.20.0 (2023-02-01)

Note: Version bump only for package cspell-monorepo

6.19.2 (2023-01-17)

Note: Version bump only for package cspell-monorepo

6.19.1 (2023-01-17)

Bug Fixes

Remove vitest as a dependency (#4031) (2784b75)

6.19.0 (2023-01-16)

Note: Version bump only for package cspell-monorepo

6.18.1 (2022-12-29)

Note: Version bump only for package cspell-monorepo

6.18.0 (2022-12-21)

Note: Version bump only for package cspell-monorepo

6.17.0 (2022-12-05)

Note: Version bump only for package cspell-monorepo

6.16.0 (2022-12-02)

Note: Version bump only for package cspell-monorepo

6.15.1 (2022-11-30)

Note: Version bump only for package cspell-monorepo

6.15.0 (2022-11-25)

Features

Preferred suggestions are listed first (#3869) (1b7a65d)

6.14.3 (2022-11-17)

Bug Fixes

trie-lib - fix issue with reference radix. (#3849) (73af697)

6.14.2 (2022-11-11)

Note: Version bump only for package cspell-monorepo

6.14.1 (2022-11-07)

Note: Version bump only for package cspell-monorepo

6.14.0 (2022-11-03)

Note: Version bump only for package cspell-monorepo

6.13.3 (2022-10-31)

Bug Fixes

Update dictionaries (#3795) (ae8de27)

6.13.2 (2022-10-31)

Bug Fixes

Do not generate duplicate entries by default (#3793) (f27d3c6)

6.13.1 (2022-10-28)

Note: Version bump only for package cspell-monorepo

6.13.0 (2022-10-28)

Bug Fixes

make sure all forms are generated. (#3783) (70949a5)

6.12.0 (2022-09-30)

Features

Use cspell-dictionary Module (#3686) (6441f4b)

6.11.1 (2022-09-30)

Bug Fixes

Fix export of SpellingDictionaryCollection (#3683) (7665cdb)

6.11.0 (2022-09-30)

Note: Version bump only for package cspell-monorepo

6.10.1 (2022-09-20)

Note: Version bump only for package cspell-monorepo

6.10.0 (2022-09-19)

Note: Version bump only for package cspell-monorepo

6.9.1 (2022-09-18)

Note: Version bump only for package cspell-monorepo

6.9.0 (2022-09-15)

Note: Version bump only for package cspell-monorepo

6.8.2 (2022-09-12)

Note: Version bump only for package cspell-monorepo

6.8.1 (2022-08-26)

Note: Version bump only for package cspell-monorepo

6.8.0 (2022-08-21)

Bug Fixes

Enable cli option --validate-directives (#3461) (52a5337)

6.7.0 (2022-08-18)

Features

Adjust .trie formatting (e2643c0), closes #3443 #3430

6.6.1 (2022-08-10)

Note: Version bump only for package cspell-monorepo

6.6.1-alpha.9 (2022-08-10)

Note: Version bump only for package cspell-monorepo

6.6.1-alpha.8 (2022-08-10)

Note: Version bump only for package cspell-monorepo

6.6.1-alpha.7 (2022-08-10)

Note: Version bump only for package cspell-monorepo

6.6.1-alpha.6 (2022-08-10)

Note: Version bump only for package cspell-monorepo

6.6.1-alpha.5 (2022-08-10)

Note: Version bump only for package cspell-monorepo

6.6.1-alpha.4 (2022-08-10)

Note: Version bump only for package cspell-monorepo

6.6.1-alpha.3 (2022-08-10)

Note: Version bump only for package cspell-monorepo

6.6.1-alpha.2 (2022-08-10)

Note: Version bump only for package cspell-monorepo

6.6.1-alpha.1 (2022-08-10)

Note: Version bump only for package cspell-monorepo

6.6.1-alpha.0 (2022-08-10)

Bug Fixes

Workflow Bot -- Update Dictionaries (#3378) (f672cf4)

6.6.0 (2022-08-08)

Bug Fixes

add tests for yarn3 (#3324) (3a86e26)
Workflow Bot -- Update Dictionaries (#3337) (cf0b465)

Features

Support spell checking of JSX/TSX Text (#3346) (943932e), closes #3342
Use CSpellIO as the default file read layer. (#3323) (c1ebd70)

6.5.0 (2022-07-29)

Bug Fixes

Workflow Bot -- Update Dictionaries (#3307) (252c738)

Features

Support Ignoring characters before checking (#3311) (d3fbe6c)

6.4.2 (2022-07-26)

Bug Fixes

Add SQL dictionary (#3277) (ee716b8)
Add SQL integration test (#3279) (da7d1ba)
Workflow Bot -- Update Dictionaries (#3276) (e5fdc72)
Workflow Bot -- Update Dictionaries (#3278) (47afb2b)
Workflow Bot -- Update Dictionaries (#3282) (4ade361)

6.4.1 (2022-07-23)

Bug Fixes

Fix ESLint schema (#3272) (05bb8ed), closes #3269

6.4.0 (2022-07-19)

Bug Fixes

Mark adding words to custom dictionary experimental (#3266) (ec0dcd8)

6.4.0-alpha.0 (2022-07-18)

Bug Fixes

Workflow Bot -- Update Dictionaries (#3239) (384e4c9)

Features

cspell-eslint-plugin: Experimental Add word to dictionary (#3247) (22a514b)

6.3.0 (2022-07-17)

Bug Fixes

Add SystemServiceBus (#3234) (ebf666d)

Features

Support a default reporter when linting. (#3236) (ffcaeff)

6.2.4-alpha.0 (2022-07-13)

Bug Fixes

Workflow Bot -- Update Dictionaries (#3206) (a99525b)

6.2.3 (2022-07-07)

Note: Version bump only for package cspell-monorepo

6.2.2 (2022-07-01)

Bug Fixes

Do not late bind parsers (#3175) (d71607c)

6.2.1 (2022-07-01)

Bug Fixes

#3172 (#3173) (82227a5)

6.2.0 (2022-06-30)

Bug Fixes

Pull out plugins to avoid conflict (#3169) (e5b7f09)

6.2.0-alpha.1 (2022-06-29)

Bug Fixes

Do not allow nested Parser functions. (#3155) (8083c95)

Features

Support global globs (#3157) (7c0ee59)

6.2.0-alpha.0 (2022-06-28)

Features

Support reading dictionary files over http. (#3150) (7ba81e6)

6.1.3 (2022-06-28)

Bug Fixes

Update reporter README (#3113) (bdaf3a8), closes #3111

6.1.3-alpha.1 (2022-06-15)

Note: Version bump only for package cspell-monorepo

6.1.3-alpha.0 (2022-06-15)

Bug Fixes

fix cspell-types (#3067) (71a9fc7)
Update grammar app (#3070) (9e0860f)

6.1.2 (2022-06-09)

Bug Fixes

Remove .txt restriction from dictionary files. (#3033) (ee706be), closes #2001

6.1.1 (2022-06-02)

Bug Fixes

missing language-id (#2999) (0e6b241), closes #2998

6.1.0 (2022-05-31)

Bug Fixes

integration tests cspell version (#2957) (3786ae2)

Features

Upgrade Java Dictionary (#2992) (e3059aa)

6.1.0-alpha.0 (2022-05-28)

Bug Fixes

add docker by default (#2931) (15e8e17)
be able to identify Docker files (#2924) (6561c3e)
integrations list - add json format (#2908) (d98f9e2)

Features

Upgrade npm and node dictionaries (#2949) (bedc60c)

Reverts

Revert "ci: Move reusable workflows to reusable" (55a7121)

6.0.0 (2022-05-21)

Note: Version bump only for package cspell-monorepo

6.0.0-alpha.0 (2022-05-20)

Note: Version bump only for package cspell-monorepo

5.21.1 (2022-05-20)

Note: Version bump only for package cspell-monorepo

5.21.0 (2022-05-17)

Bug Fixes

comments in CSpellSettingsDef.ts (#2821) (b1f296d)

Features

Upgrade cpp dictionary (#2794) (e51f7f4)
Upgrade go dictionary (#2792) (778b8fe)
Upgrade C# dictionary (#2791) (64c11da)

5.20.0 (2022-05-02)

Bug Fixes

Roll back glob to 7.2.0 to fix Windows (#2706) (b42bbdd)
Update to glob 8 (#2707) (07567cd), closes #2706

Features

Upgrade python dictionary (#2763) (2a86f54)

5.19.7 (2022-04-09)

Bug Fixes

Ignore directories when checking files (#2680) (fa777f0)

5.19.6 (2022-04-08)

Bug Fixes

add --cache-reset option (#2677) (631073b)
add configuration for git commit messages (#2674) (42740a9)
fix issue with stale cache entries (#2673) (15995a8)
fix minor typo. (#2647) (a151ccc)
relative path name (#2675) (51fc55b)

5.19.5 (2022-04-01)

Bug Fixes

Be able to disable the default configuration (#2643) (46c1e4f)

5.19.4 (2022-04-01)

Bug Fixes

Performance - only serialize config if in debug mode (#2640) (d16c4f9)

5.19.3 (2022-03-24)

Bug Fixes

eslint-plugin improve performance (#2616) (b1a9bed)
Invalidate the cache if cspell version has changed. (#2580) (2174928)
prepare to publish eslint-plugin (#2620) (e5495c4)
Update English dictionary to remove British words (#2612) (5a6f143)

5.19.2 (2022-03-14)

Bug Fixes

eslint-plugin - fix issue with document directives (#2576) (54cb12c)

5.19.1 (2022-03-13)

Bug Fixes

ESLint Plugin to support ignoring imported properties (#2573) (ee4cc20)

5.19.0 (2022-03-12)

Bug Fixes

integration-tests/package.json & integration-tests/package-lock.json to reduce vulnerabilities (#2567) (19f5c37)
Use exactOptionalPropertyTypes (#2493) (ffde5ac)

Features

Use pipe instead of GenSequence (#2491) (65cb6f0)

5.18.5 (2022-02-15)

Bug Fixes

Add dart language support (#2444) (bbcf793)
Add to Case Sensitive docs (#2432) (5891600)
Improve suggestions (#2426) (51d5a71)
Make it easier to work with RTL languages. (#2410) (91b035f)
Make sure ext .R is detected as an R file. (#2425) (e9ae045), closes #2424
Make sure suggestions are within limits (#2428) (d9f7943)
Upgrade bundled dictionaries (#2431) (de1d68f)

5.18.4 (2022-02-07)

Bug Fixes

Add simple repl feature to suggestions. (#2403) (f9835b7)
Improve speed of suggestions for long words. (#2406) (6c76907)

5.18.3 (2022-02-04)

Bug Fixes

Add support for R (#2394) (6888d48)
Improve cli summary and progress (#2396) (d52d68a)
Upgrade to commend-json 4.2.2 (#2399) (e5f643e)

5.18.2 (2022-02-03)

Bug Fixes

fix suggestion output (#2390) (bda442d)

Reverts

Revert "ci: Workflow Bot -- Update ALL Dependencies (#2388)" (#2391) (7f093f9), closes #2388 #2391

5.18.1 (2022-02-03)

Bug Fixes

Ensure Weighted Suggestions are generated (#2384) (7e72b91)
Fix first letter insert costs on suggestions. (#2385) (e5b7ed5)
Improve suggestions when using weights. (#2387) (c9d070d)
Make sure cspell-tool-cli keeps accents (#2381) (f6f17d0)
Update publish script to clean first (60811f0)
Upgrade to commander 9.0.0 (#2367) (f255b70)

5.18.0 (2022-01-31)

Note: Version bump only for package cspell-monorepo

5.18.0-alpha.0 (2022-01-30)

Bug Fixes

Show an error if a glob starts/ends with a single quote (#2357) (924200e), closes #2350
Speed up dictionaries from (#2363) (76c41ad)
Speed up spell checking with large config files. (#2362) (41c061c)

Features

Enable support to dictionary alphabet and accents. (#2355) (b33453b)

5.17.0 (2022-01-26)

Bug Fixes

do not depend upon @types/glob in exports. (#2346) (7740f55)

5.17.0-alpha.0 (2022-01-26)

Bug Fixes

(cspell-glob) Make sure cwd can be set. (#2316) (80087ac)
(cspell) Mark forbidden and no suggest words (#2302) (c474cec)
add --fail-fast to cspell README.md (#2340) (5554ecb)
Explicitly import types (#2343) (7131001), closes #2341
Make sure ${cwd}/ works in globs. (#2315) (2dbe93e)
Move suggestionEditCosts into dictionaryInformation (#2296) (021e781)

Features

add --fail-fast cli option (#2338) (7c17c22), closes #2294
Add failFast config option to exit as soon as an issue encountered (#2307) (26dd25a)
Add cli command to show suggestions. (#2299) (1db4777)
Support REPL style reading from stdin (#2342) (78bf751), closes #2294
Support using stdin for trace. (#2300) (7967ffe)

5.16.0 (2022-01-20)

Bug Fixes

Add ability to discourage certain types of suggestions. (#2291) (a6e1bf6)

5.15.3 (2022-01-20)

Bug Fixes

Handle missing files when spell checking from a file list. (#2286) (fd1e7e2), closes #2285
Implement Weighted Distance Algorithm (#2255) (3a4f9db)
Lock in typedoc till it is fixed. (#2277) (417fe32)

5.15.2 (2022-01-11)

Bug Fixes

Fix backwards compatibility for Reporters (#2229) (38d17b2)
Fix issue with maxDuplicateProblems setting (#2237) (fbb3593)

5.15.1 (2022-01-07)

Bug Fixes

Fix type for some older TypeScript parsers. (#2191) (b195499)

5.15.0 (2022-01-07)

Bug Fixes

Invalidate cache when config has changed (#2160) (705c638)
make config file version 0.2 by default. (#2186) (ed8af60)
Update dictionaries (#2173) (d82aeb6)

Features

Add support for cache options in config files. (#2184) (7256919)
Remove 40 character limit on spell checking words (#2175) (5769a0e)

5.14.0 (2021-12-29)

Note: Version bump only for package cspell-monorepo

5.14.0-alpha.0 (2021-12-29)

Bug Fixes

#2077 (#2114) (a3336b4)
Make sure help is not shown if the file list is empty. (#2150) (67c975a)
Upgrade HTML dictionary (#2131) (874ac37)

Features

Support --file-list cli option (#2130) (eef7b92), closes #1850

5.13.4 (2021-12-18)

Bug Fixes

hunspell - honor minimum compound word length (#2091) (c67f7b8)

Features

report error and fail for unsupported NodeJS versions (#1984) (#2111) (52bb33e)

5.13.3 (2021-12-11)

Bug Fixes

cspell-tools - limit memory usage when build dictionaries (#2087) (591860e)
Hunspell make sure COMPOUNDFLAG is supported (#2088) (3bd772e)

5.13.2 (2021-12-07)

Bug Fixes

jest/expect-expect warning (#2062) (7366b54)
make cspell aware of PureScript and Dhall (#2067) (53c8457)
Update TypeScript extensions (#2051) (6a97177)

5.13.1 (2021-11-24)

Bug Fixes

fix #2011 (#2013) (15abecb)

5.13.0 (2021-11-17)

Bug Fixes

Add enableCaseSensitive/disableCaseSensitive (#1951) (93387b7)
integration - turn off case sensitivity for German (#1952) (2465964)

Features

Support --dot command line option. (#1985) (fa1aa11)

5.12.6 (2021-11-04)

Bug Fixes

Include configuration for VUE and Swift by default. (#1946) (b57e86d)

5.12.5 (2021-11-02)

Bug Fixes

Add trace options (#1939) (191fc52)
Fix reading dictionary test to use path (#1938) (fa4ea3f)
Make sure flaggedWords are always checked. (#1935) (dfbfddd), closes #1895
prevent suggesting word break characters (#1933) (42ffb98)

5.12.4 (2021-10-31)

Bug Fixes

adjust the AWS integration test to match repo changes. (#1912) (5918f32)
Change --wordsOnly option to --words-only (#1928) (aac621f)
In Document settings. (#1925) (01c12ce), closes #1628 #1629
Remove unnecessary dependency (#1929) (8bc7b1c)
Update software terms (#1909) (b9c8263)
Update software terms and integration snapshots. (#1916) (0248330)

5.12.3 (2021-10-08)

Bug Fixes

Fix .gitignore glob matching (#1847) (d36449b), closes #1846
Use the repository root by default when no root is specified. (#1851) (81d005e), closes #1846

5.12.2 (2021-10-06)

Note: Version bump only for package cspell-monorepo

5.12.1 (2021-10-06)

Bug Fixes

fix #1807 (#1837) (9608b77)

5.12.0 (2021-10-05)

Note: Version bump only for package cspell-monorepo

5.12.0-alpha.0 (2021-10-05)

Bug Fixes

fix home page reference. (#1817) (b074603)
support --no-gitignore option (#1833) (0b89fed)
Update gitignore README and normalize roots (#1832) (b9df331)

Features

Add support for .gitignore (#1823) (9b0dfe4)

5.11.1 (2021-09-29)

Bug Fixes

Move [@types](https://github.com/types) dependencies to dev (#1811) (c29fdcb)

5.11.0 (2021-09-28)

Note: Version bump only for package cspell-monorepo

5.11.0-alpha.0 (2021-09-28)

Bug Fixes

Allow config file version to be a number. (#1730) (9fa2eee), closes #1729
Display filenames instead of URI's (#1773) (5a9542e)
Ensure cli-reporter displays the correct message. (#1774) (c0aaf45)
Improve Patterns and RegExp handling (#1743) (100866e), closes #1699
make sure issue.uri is actually a URI. (#1746) (4268057)
Patterns - only add u if no flags are given (#1745) (a75c370), closes #1699
Reduce the cost of regexp exclusions (#1800) (4544c25), closes #1775
Update Python dictionary (#1778) (6359145)

Features

add --cache option to lint only changed files (#1763) (4bdfd09)

Reverts

Revert "ci: Disable Coveralls - their API has been down for a couple of days. (#1731)" (#1732) (102ef73), closes #1731 #1732

5.10.1 (2021-09-17)

Bug Fixes

Use process directly instead of importing it. (#1714) (db18a52), closes #1704

5.10.0 (2021-09-17)

Bug Fixes

Roll back update to @cspell/dict-en-gb@2 (#1712) (edb1814)

5.10.0-alpha.6 (2021-09-17)

Bug Fixes

Make dict-en-gb version 2 optional because of license. (#1710) (046a704)

5.10.0-alpha.5 (2021-09-16)

Note: Version bump only for package cspell-monorepo

5.10.0-alpha.4 (2021-09-16)

Note: Version bump only for package cspell-monorepo

5.10.0-alpha.3 (2021-09-16)

Bug Fixes

Fix accidental promise returned by reporters. (#1702) (8c125c2)
Fix strange spelling of Custom (4a93456)

5.10.0-alpha.2 (2021-09-13)

Note: Version bump only for package cspell-monorepo

5.10.0-alpha.0 (2021-09-13)

Bug Fixes

Delete .pre-commit-hooks.yaml (#1686) (cc58b45)

Features

Custom reporters support (#1643) (3b9ac1b)

5.9.1 (2021-09-12)

Reverts

Revert "test: fix github-actions (#1665)" (#1666) (baaeab6), closes #1665 #1666

5.9.1-alpha.1 (2021-09-12)

Reverts

Revert "enable incremental typescript builds (#1671)" (65664b2), closes #1671

5.9.1-alpha.0 (2021-09-11)

Bug Fixes

Change the suggestions to not include ties by default. (#1678) (0efbd58)
drop need for iconv-lite and iterable-to-stream (#1677) (c7ffcc7)
Fix suggestions when working with case aware dictionaries. (#1674) (0ba056d)
Fix version number reference (#1640) (1c18b36), closes #1638
Perf - Try improving suggestion performance. (#1639) (aad4352)
sample more often to make sure the suggest stops on time. (#1669) (2bb6c82)
Support Suggestion timeouts (#1668) (1698aaf)
Upgrade British English dictionary to v2. (#1633) (907d3eb)

5.9.0 (2021-08-31)

Note: Version bump only for package cspell-monorepo

5.9.0-alpha.0 (2021-08-31)

Bug Fixes

Update packages and fix schema lint issue. (#1591) (f849ecb)

Features

Upgrade to the newest, (case sensitive), English dictionary (#1545) (581fc4d)

5.8.2 (2021-08-25)

Bug Fixes

fix issue where some dictionaries (nl-nl) could cause slow suggestions (#1583) (8c8d0ee)

5.8.1 (2021-08-24)

Bug Fixes

Fix some minor issues (#1562) (8512920)
fix wrapping issue in trace command with compound words. (#1574) (e6ebda8)

5.8.0 (2021-08-21)

Bug Fixes

clean up find results (#1550) (80cb6a3)
fix allowCompoundWords find in case aware dictionaries. (#1549) (769de0b)

Features

Add support for noSuggest dictionaries. (#1554) (f0ccda5)
Improve trace words command results. (#1558) (ed8a5dc)

5.7.2 (2021-08-16)

Bug Fixes

Add software licenses dictionary (#1523) (43910d5)
Detect when module default is used with cspell.config.js files. (#1529) (e05aeff)
Update cspell README.md (#1530) (9c0dfd6)

5.7.1 (2021-08-14)

Bug Fixes

do not return forbidden words in suggestions (#1519) (a9936d6)
Make sure hyphenated words work in ignoreWords (#1520) (81a86c7), closes #1497

5.7.0 (2021-08-14)

Note: Version bump only for package cspell-monorepo

5.7.0-alpha.0 (2021-08-14)

Features

Support forbidden words in dictionaries (#1516) (8d7596b)

Making Words Forbidden

There are several ways to mark a word as forbidden:

In a custom word list with words beginning with !.
```
 !forbiddenWord
```

In words section of cspell configuration:

 "words": [
     "!forbiddenWord",
     "configstore"
 ],

In flagWords section of cspell configuration:
```
 "flagWords": ["forbiddenWord"]
```

Overriding Forbidden words

Sometimes it is necessary to allow a word even if it is forbidden.

In a comment

/**
 * Do not mark `forbiddenWord` as incorrect.
 * cspell:ignore forbiddenWord
 */

In the `cspell` configuration

{
    "ignoreWords": ["forbiddenWord"]
}

5.6.7 (2021-08-13)

Bug Fixes

error output when configstore dir not accessible. (#1512) (68a63d1), closes #1510
Fix issue with suggestions. (#1507) (6a44e26)
ignore TrueTypeFont files (#1445) (336c77f)

Reverts

Revert "build(deps): bump codecov/codecov-action from 1.5.2 to 2.0.1 (#1438)" (#1446) (cbffbb8), closes #1438 #1446

5.6.6 (2021-06-18)

Bug Fixes

publishing issue with cspell-bundled-dicts (8a43bc5)

5.6.5 (2021-06-18)

Bug Fixes

fix regression related to trailing accents missing in legacy dicts (#1345) (b8d8810)

5.6.4 (2021-06-15)

Bug Fixes

#1336 (#1342) (7a0b278)
early out on checking binary files. (#1337) (a948808)
Fix issue with missing suggestions (#1339) (cfecde8)

5.6.3 (2021-06-11)

Bug Fixes

fix issue with legacy dictionaries that do not have some accents (5a9aa27)
make sure cspell-tools does not collide with old version. (00e360c)
support case sensitive document checking. (527de4a)

5.6.2 (2021-06-10)

Bug Fixes

minor breaking fix issues with accents and the word splitter (#1330) (845c314)

5.6.1 (2021-06-09)

Bug Fixes

Fix issues with accent characters (#1322) (4d65dfb), closes #1321
Use a dictionary for ignoreWords to be consistent with words (#1326) (ee3897d)

5.6.0 (2021-06-05)

Features

support .pnp.js when loading configurations. (#1307) (76da68c)

5.5.2 (2021-05-30)

Bug Fixes

Ignore hash links like [abcdefa] (#1293) (888e25d)

5.5.1 (2021-05-29)

Bug Fixes

Update CHANGELOG.md (#1291) (7129c1b)

5.5.0 (2021-05-29)

Bug Fixes

Fix Performance issue when checking long strings of non-words (#1285) (bdb43d6)

Features

Remove incorrect Ignore Hex Digits Regexp (#1277) (2621eb0), closes #1276 #1276

5.4.1 (2021-05-11)

Bug Fixes

correct how dictionaries are disabled (#1229) (60975ea), closes #1215

5.4.0 (2021-05-05)

Features

Support package.json as a configuration location. (#1178) (2ce2410)

Reverts

Revert "Revert "fix: Correctly handle leading and trailing single quote"" (#1203) (1738993), closes #1203

5.3.12 (2021-04-06)

Bug Fixes

Update dictionaries (#1136) (64eba51)

5.3.11 (2021-04-03)

Bug Fixes

Fix command line exclusions (#1119) (c191fc5)

5.3.10 (2021-04-02)

Bug Fixes

file globs listed on the command line override files in the config. (#1117) (25c501d), closes #1115
issue #1114 (#1116) (77ae68a)

5.3.9 (2021-03-19)

Bug Fixes

If the global config is not found, do not pretend it was. (#1079) (fb07679)

5.3.8 (2021-03-17)

Bug Fixes

export default configuration filenames (#1070) (8c3b65e)
update schema generator (#1074) (528b7d0)

5.3.7 (2021-03-05)

Bug Fixes

build issue due to spelling (#1041) (11cb0c0)

5.3.7-alpha.3 (2021-03-05)

Note: Version bump only for package cspell-monorepo

5.3.7-alpha.2 (2021-03-05)

Note: Version bump only for package cspell-monorepo

5.3.7-alpha.1 (2021-03-05)

Note: Version bump only for package cspell-monorepo

5.3.7-alpha.0 (2021-03-05)

Note: Version bump only for package cspell-monorepo

5.3.6 (2021-03-05)

Bug Fixes

issue cause by commit d1a7fa7 (#1040) (da9ca51), closes /github.com/streetsidesoftware/cspell/commit/d1a7fa78759257d692598bf712254201ed0dd126#commitcomment-47719278

5.3.5 (2021-03-05)

Bug Fixes

adjust order in which files are loaded. (#1037) (84c7aa1)
fix schema pattern for language IDs. (#1034) (591dde2)
make sure glob patterns match on windows (#1039) (1e58e4c)

5.3.4 (2021-03-01)

Bug Fixes

Adjust the way glob roots are calculated (d1a7fa7)

5.3.3 (2021-02-26)

Bug Fixes

Report the root cause of a dictionary error. (#1014) (8c1debd)

5.3.2 (2021-02-26)

Bug Fixes

do not check binary files and add Ada dictionary (#1011) (af04ead)

5.3.1 (2021-02-25)

Bug Fixes

Make sure relative globRoot is resolved correctly. (#1004) (29977c4)
make sure to export all needed cspell types. (#1006) (c625479)

5.3.0 (2021-02-25)

Note: Version bump only for package cspell-monorepo

5.3.0-alpha.4 (2021-02-25)

Bug Fixes

#1000 (#1002) (d82a4a2)
be able to report on glob source. (#1001) (1020d56)

5.3.0-alpha.3 (2021-02-23)

Bug Fixes

Improve reporting on files matching glob patterns. (#994) (da991f9)

5.3.0-alpha.2 (2021-02-22)

Bug Fixes

Add schema support for enableFiletypes. (#979) (d18706e)
Add support for custom dictionaries (#982) (196921d)

5.3.0-alpha.1 (2021-02-19)

Bug Fixes

Display suggestions -- regression (#976) (e3970c7)
Fix schema generation to use deprecatedMessage (#972) (492dca9)

5.3.0-alpha.0 (2021-02-18)

Bug Fixes

Working towards a standard way to spell check files. (#900) (5d38b2a)

Features

Be able to specify files to spell check within the config. (#948) (23f7a48), closes #571
cspell-glob matches only files under the root (#913) (a2d700d)
Part 1 - glob patterns are relative to the config file. (#921) (a250448)
Support local configuration files (#966) (0ccc5fe)
Support negation matches in languageSettings for languageIds (#967) (cea9114)

5.2.4 (2021-01-28)

Note: Version bump only for package cspell-monorepo

5.2.3 (2021-01-27)

Bug Fixes

support cspell.config.js and remove support for cspell.js (#895) (6fbb4b2)

5.2.2 (2021-01-26)

Note: Version bump only for package cspell-monorepo

5.2.1 (2021-01-23)

Bug Fixes

make sure version and help do not exit with non-zero code. (#883) (b8e91f3), closes #880

5.2.0 (2021-01-23)

Bug Fixes

Improve suggestions for short words (#872) (9c62d04), closes #753

Features

Add options --show-context and --relative (#878) (1fddaac)
improve word splitting options (#846) (b4dc108)
support .yaml and .js configuration files (#875) (4a07acc)
support displaying suggestions (#881) (e3f207f)

5.1.3 (2021-01-05)

Bug Fixes

Support dictionaries having words with numbers. (#828) (856f04a)

5.1.2 (2020-12-31)

Note: Version bump only for package cspell-monorepo

5.1.1 (2020-12-28)

Bug Fixes

remove dependency upon @types/glob (#810) (03fab52)

5.1.0 (2020-12-27)

Bug Fixes

Improve speed of testing for email (#779) (be1329d)

Features

improve spell checking speed and allow multiple exclude arguments (#806) (7a4c8f8)

5.0.8 (2020-12-17)

Bug Fixes

Docs and minor edits (#757) (e5f4567)
issue with importing cspell (ff32d0c)

5.0.7 (2020-12-16)

Note: Version bump only for package cspell-monorepo

5.0.6 (2020-12-15)

Bug Fixes

missing cspell-default.json file (#752) (e13b2e0)

5.0.5 (2020-12-15)

Note: Version bump only for package cspell-monorepo

5.0.4 (2020-12-15)

Note: Version bump only for package cspell-monorepo

5.0.3 (2020-12-04)

Bug Fixes

cleanup folder for cspell-glob (#698) (7081eb5)
Expose Emitter types (#718) (3ef9030)
improve resolve search logic (#697) (75be89b)
use node resolver by default (#695) (0d95869)

5.0.2 (2020-11-26)

Note: Version bump only for package cspell-monorepo

5.0.1 (2020-11-20)

Bug Fixes

make sure the error code is correctly set (#619) (09e358c)

5.0.1-alpha.15 (2020-11-18)

Bug Fixes

force new version (3ab08ab)

5.0.1-alpha.14 (2020-11-17)

Note: Version bump only for package cspell-monorepo

Package detail

readme

CSpell

Support Future Development

Documentation

Third-Party Video Presentations

Packages

Related Packages

Live Discussions

RFCs

CSpell for enterprise

Security contact information

Versions

Contributing

changelog

Change Log

8.17.2 (2025-01-13)

8.17.1 (2024-12-16)

8.17.0 (2024-12-15)

8.16.1 (2024-11-26)

8.16.0 (2024-11-07)

8.15.7 (2024-11-03)

8.15.6 (2024-11-02)

8.15.5 (2024-10-30)

8.15.4 (2024-10-18)

8.15.3 (2024-10-16)

8.15.2 (2024-10-14)

8.15.1 (2024-10-11)

8.15.0 (2024-10-11)

8.14.4 (2024-09-18)

8.14.3 (2024-09-17)

8.14.2 (2024-08-20)

8.14.1 (2024-08-17)

8.14.0 (2024-08-17)

8.13.3 (2024-08-12)

8.13.2 (2024-08-08)

8.13.1 (2024-08-02)

8.13.0 (2024-07-30)

8.12.1 (2024-07-22)

8.12.0 (2024-07-22)

8.11.0 (2024-07-16)

8.10.4 (2024-07-05)

8.10.2 (2024-07-05)

8.10.1 (2024-07-05)

8.10.0 (2024-07-02)

8.9.1 (2024-06-20)

8.9.0 (2024-06-18)

8.9.0-alpha.0 (2024-06-18)

8.8.4 (2024-06-03)

8.8.3 (2024-05-23)

8.8.2 (2024-05-22)

8.8.1 (2024-05-10)

8.8.0 (2024-05-03)

8.7.0 (2024-04-10)

8.6.1 (2024-03-25)

8.6.0 (2024-03-05)

8.5.0 (2024-03-01)

8.4.1 (2024-02-20)

8.4.0 (2024-02-19)

8.3.2 (2024-01-02)

Bug Fixes

8.3.1 (2024-01-01)

8.3.0 (2023-12-30)

8.2.4 (2023-12-28)

8.2.3 (2023-12-21)

Bug Fixes

8.2.2 (2023-12-21)

8.2.1 (2023-12-20)

8.2.0 (2023-12-20)

8.1.3 (2023-12-06)

Bug Fixes

8.1.2 (2023-12-04)

Bug Fixes

8.1.1 (2023-12-04)

8.1.0 (2023-12-01)

8.0.0 (2023-11-07)

7.3.9 (2023-11-07)

7.3.8 (2023-10-13)

7.3.7 (2023-09-28)

7.3.6 (2023-09-13)