feat: ESLint-plugin -- Distinguish between Forbidden, Misspelled, and Unknown words. (#8337)

Pull request overview

This PR updates the eslint-plugin to report different types of spelling issues with improved categorization and messaging. The changes include upgrading ESLint from v8 to v9, introducing new issue severity levels (Forbidden, Misspelled, Unknown, Hint), and adding a report option to control the level of reporting.

Changes:

• Upgraded ESLint dependency from v8.57.1 to v9.39.2 across all fixtures and packages
• Introduced new severity level "Misspelled" to distinguish typos with suggestions from truly unknown words
• Added report option ('all', 'simple', 'typos', 'flagged') to control which types of issues are reported
• Enhanced error messages to include suggestions directly in the message text

feat: ESLint-plugin -- Add report option to be able to control the reporting level (matching the CLI): "all", "simple", "typos", "flagged". (#8273)

Pull request overview

This PR adds support for unknown word reporting options to the cspell ESLint plugin, allowing users to control which types of spelling issues are reported (all unknown words, simple typos, common typos, or only flagged words).

Changes:

• Added a new report option to the ESLint plugin configuration with values: 'all', 'simple', 'typos', and 'flagged'
• Implemented mapping from the report option to CSpell's unknownWords setting
• Added unit tests for the new report filtering functionality

This PR contains the changes required to resolve cspell ESLint plugin: support typos-only reporting (CLI --report typos / unknownWords report-common-typos) #8261

feat: support storing suggestions in trie (#8228)

Pull request overview

This PR adds support for storing word suggestions directly in trie data structures, enabling dictionaries to provide preferred spelling suggestions for words. The implementation introduces a new suggestionPrefix field (default :) to TrieInfo and a hasPreferredSuggestions characteristic flag.

Key Changes:

• Adds suggestion storage capability to trie structures with a new suggestionPrefix field
• Removes the isCaseAware field from TrieInfo (minor breaking change since it was no longer used)
• Implements suggestion parsing logic in dictionary parsers to handle formats like word:suggestion and word->suggestion

Details

Add support to have suggestion in normal word lists:

Note: : or -> separators can be used in the word list.

Examples:

colour:color # colour is allowed, but color is preferred.
:colour:color # this is just a suggestion to use `color` instead of `colour`.
:colour->color # same as `:colour:color`
!colour:color # `colour` will be flagged and `color` will be suggested as the fix.

You can add more than one suggestion, but auto-fix won't be possible since
the spell checker cannot determine which one you want.

!incase:encase, in case # two suggestions

feat: Add Support reading / writing bTrie files (#8204)

Pull request overview

This pull request adds support for reading and writing binary Trie (bTrie) files, which is a more efficient binary format for storing trie data structures. The changes make the cspell-trie-lib package more platform-neutral by replacing Node.js-specific APIs (like Buffer and os.endianness()) with Web standard APIs (Uint8Array, TextEncoder/TextDecoder, and a custom endianness detection function).

Changes:

• Implemented a new binary format specification system with encoder/decoder classes
• Added bTrie file format support with proper endianness handling
• Made cspell-trie-lib platform-neutral by removing Node.js dependencies from production code
• Added new CLI command btrie to cspell-tools for generating bTrie files
• Enhanced readers in cspell-tools to handle multiple file formats including bTrie

refactor: extract processFile from lint.ts (#8344)

fix: Improve word lookup performance when not found (#8330)

Pull request overview

This PR improves word lookup performance when words are not found by optimizing how the spell checker generates different word forms for dictionary lookups. The key optimization is to avoid expensive Unicode normalization and replacement mapping operations when they're not needed.

Changes:

• Converted mapWord from required to optional on SpellingDictionary interface, using undefined for dictionaries that don't need word mapping
• Added early-exit optimization for ASCII words to skip Unicode normalization
• Added test-before-apply optimization for replacement mappers to avoid expensive operations when the word won't match
• Enhanced dictionary logging to track cache misses and improved the public API for logging functions
• Added comprehensive tests including integration test with real German dictionary

When a word is not found, the spell checker tries many different forms to find the word. This can be expensive if a lot of words are not found.

fix: Improve loading time of dictionaries (#8318)

Pull request overview

This pull request aims to improve the loading time of dictionaries by optimizing the internal data structures and sorting algorithms used in the trie builder. The changes focus on:

• Removing unused timer utility functions and tests
• Simplifying performance measurement infrastructure
• Optimizing node sorting by avoiding unnecessary Uint32Array conversions
• Adding an optional batch sorting feature for dictionary parsing
• Generalizing types to work with both regular arrays and Uint32Arrays

fix: Reduce loading time of dictionaries. (#8316)

fix: Support loading btrie dictionaries in cspell-lib (#8311)

Pull request overview

This PR adds support for loading btrie (binary trie) dictionaries in cspell-lib, enabling more efficient dictionary storage and loading. The changes also include enhancements to the table utility for better formatting and a refactoring of performance measurement tracking to use a hierarchical structure.

• Added btrie path resolution and loading support in DictionarySettings and DictionaryLoader
• Enhanced the table utility with column alignment, indentation, and title support
• Refactored performance measurements to use a hierarchical tree structure instead of flat key-based tracking
• Improved performance reporting with color coding and additional metrics

fix: Improve loading performance a bit. (#8309)

fix: Prepare tools to generate btrie files. (#8298)

fix: Optimize btrie files when building (#8285)

Have CSpell Tools optimize the Trie while building. We are trying to reduce the size of the file.

fix: Add btrie path to dictionary definition (#8284)

Make it possible for a dictionary to specify a btrie path in addition to the normal path.

fix: Work towards support prefixes when walking ITrie (#8276)

fix: Fix CStyleHexValue to handle BigInt values. (#8282)

Example: 0xffff_ffff_ffffn

refactor: Remove FastTrieBlob (#8267)

fix: Make endian required when encoding a StringTable (#8265)

refactor: Removed FastTrieBlob part 1 (#8266)

FastTrieBlob served it purpose. It is now time for it to be retired since it is too difficult to maintain in parallel with TrieBlob.

fix: Support string prefixes when walking nodes (#8259)

refactor: Document TrieBlob format (#8256)

• Document TrieBlob format
• Add TribBlob node optimizer to make DAWGs
• Test out StringTables
• Remove some dead code

fix: adjust error message (#8249)

fix: Add StringT...

feat: Report errors with nested config files (#8155)

fixes: #7837

Errors in nested configuration files were ignored. This lead to unexpected behavior.

Note: this is a fix, but since it can impact existing installs, it is marked as a feature change.

fix: Enable cts config support (#8152)

Add support for .cts config files.

Update docs with ts, mts, and cts config.

fix: Add cspell-tools option keepUncompressed (#8163)

fix: Improve CSpell Tools (#8160)

Generate both compressed and non-compressed files when compress: true. This allows cspell-dicts to keep track of changes and have compressed files at the same time.

fix: Make sure cspell exports defineConfig for CommonJS (#8156)

fix: Workflow Bot -- Update Dictionaries (main) (#8149)

Update Dictionaries (main)

Summary

 .../snapshots/AdaDoom3/AdaDoom3/report.yaml        |   7 +-
 .../snapshots/AdaDoom3/AdaDoom3/snapshot.txt       |   7 +-
 .../snapshots/TheAlgorithms/Python/report.yaml     |   5 +-
 .../snapshots/TheAlgorithms/Python/snapshot.txt    |   5 +-
 .../snapshots/dart-lang/sdk/report.yaml            |   8 +-
 .../snapshots/dart-lang/sdk/snapshot.txt           |   4 +-
 .../snapshots/django/django/report.yaml            |  13 +--
 .../snapshots/django/django/snapshot.txt           |  44 ++++----
 .../iluwatar/java-design-patterns/report.yaml      |   3 +-
 .../iluwatar/java-design-patterns/snapshot.txt     |   3 +-
 .../snapshots/ktaranov/sqlserver-kit/report.yaml   |   4 +-
 .../snapshots/ktaranov/sqlserver-kit/snapshot.txt  |   3 +-
 .../snapshots/neovim/nvim-lspconfig/report.yaml    |   5 +-
 .../snapshots/neovim/nvim-lspconfig/snapshot.txt   |   3 +-
 .../snapshots/slint-ui/slint/report.yaml           |   8 +-
 .../snapshots/slint-ui/slint/snapshot.txt          |   7 +-
 .../snapshots/sveltejs/svelte/report.yaml          |   3 +-
 .../snapshots/sveltejs/svelte/snapshot.txt         |   3 +-
 packages/cspell-bundled-dicts/package.json         |  20 ++--
 pnpm-lock.yaml                                     | 120 +++++++++++----------
 20 files changed, 115 insertions(+), 160 deletions(-)

feat: Add option to skip large files (#8040)

New command line option: --max-file-size <value>
The value can be <number>[units], number with optional units.
Supported units:

• K, KB - value * 1024
• M, MB - value * 2^20
• G, GB - value * 2^30

There is also a new setting called maxFileSize. At the moment, it only takes numbers in bytes.

This allows for setting a global value and overrides based upon glob settings.

Note: the command line value will override any value found in the configuration files.

fix: turn off gpg when publishing for now (#8104)

fix: Turnoff signing for now (#8102)

fix: Sign tags and commits when publishing (#8096)

fix: Clean up verbose output (#8053)

fix: allow string based maxFileSize (#8047)

• Support allowing string based maxFileSize in config files.
• Report the number of skipped files.

fix: Workflow Bot -- Update Dictionaries (main) (#8091)

Update Dictionaries (main)

Summary

 packages/cspell-bundled-dicts/package.json |  2 +-
 pnpm-lock.yaml                             | 11 ++++++++---
 2 files changed, 9 insertions(+), 4 deletions(-)

fix: Workflow Bot -- Update Dictionaries (main) (#8080)

Update Dictionaries (main)

Summary

 .../snapshots/django/django/report.yaml            |  25 +--
 .../snapshots/django/django/snapshot.txt           |  20 +-
 .../snapshots/php/php-src/report.yaml              | 237 ++++++++++-----------
 .../snapshots/php/php-src/snapshot.txt             |   7 +-
 packages/cspell-bundled-dicts/package.json         |  10 +-
 pnpm-lock.yaml                                     |  64 +++---
 6 files changed, 163 insertions(+), 200 deletions(-)

fix: Workflow Bot -- Update Dictionaries (main) (#8058)

Update Dictionaries (main)

Summary

 integration-tests/snapshots/slint-ui/slint/report.yaml  | 11 +++--------
 integration-tests/snapshots/slint-ui/slint/snapshot.txt |  7 +------
 packages/cspell-bundled-dicts/package.json              |  2 +-
 pnpm-lock.yaml                                          | 12 ++++++------
 4 files changed, 11 insertions(+), 21 deletions(-)

fix: Workflow Bot -- Update Dictionaries (main) (#8036)

Update Dictionaries (main)

Summary

 .../snapshots/TheAlgorithms/Python/report.yaml     |  7 +--
 .../snapshots/TheAlgorithms/Python/snapshot.txt    |  5 +--
 .../snapshots/eslint/eslint/report.yaml            |  6 +--
 .../snapshots/eslint/eslint/snapshot.txt           |  3 +-
 .../microsoft/TypeScript-Website/report.yaml       |  5 +--
 .../microsoft/TypeScript-Website/snapshot.txt      |  3 +-
 .../snapshots/slint-ui/slint/report.yaml           |  7 ++-
 .../snapshots/slint-ui/slint/snapshot.txt          |  3 +-
 packages/cspell-bundled-dicts/package.json         |  8 ++--
 pnpm-lock.yaml                                     | 51 ++++++++++++----------
 10 files changed, 46 insertions(+), 52 deletions(-)

fix: Add Zig programming language dictionary (#7998)

fix: Search for TypeScript config files. (#7997)

TypeScript files were allowed, but would not be automatically found.

fix: Workflow Bot -- Update Dictionaries (main) (#8004)

Update Dictionaries (main)

Summary

 .../snapshots/ktaranov/sqlserver-kit/report.yaml   |  4 +--
 .../snapshots/ktaranov/sqlserver-kit/snapshot.txt  |  5 ++-
 packages/cspell-bundled-dicts/package.json         |  6 ++--
 pnpm-lock.yaml                                     | 36 +++++++++++-----------
 4 files changed, 24 insertions(+), 27 deletions(-)

fix: Support Deno (#7966)

Deno

This should enable running:

deno run -A cspell lint -c ./cspell.config.mts src

Bun

I tried bun, but it failed with:

WIP

Note: this is a work in progress. Deno does not support NodeJS's Buffer for decoding compressed binary data. I'll investigate a workaround.

Current issue:

It also blows up with encountering yarn blobs, but that is to be expected.

feat: Support loading .ts and .mts config files. (#7961)

This PR add support to read TypeScript cspell config files.

Note: TypeScript config files will fail to load when NodeJS version is less than v22.18.0.

See: Node.js — Running TypeScript Natively

fix: Workflow Bot -- Update Dictionaries (main) (#7950)

Update Dictionaries (main)

Summary

 .../snapshots/sveltejs/svelte/report.yaml          |  3 +-
 .../snapshots/sveltejs/svelte/snapshot.txt         |  7 +--
 packages/cspell-bundled-dicts/package.json         | 12 ++--
 pnpm-lock.yaml                                     | 68 +++++++++++++---------
 4 files changed, 49 insertions(+), 41 deletions(-)

fix: Workflow Bot -- Update Dictionaries (main) (#7940)

Update Dictionaries (main)

Summary

 .../snapshots/AdaDoom3/AdaDoom3/report.yaml        |   3 +-
 .../snapshots/AdaDoom3/AdaDoom3/snapshot.txt       |  17 ++-
 .../Azure/azure-rest-api-specs/report.yaml         |   6 +-
 .../Azure/azure-rest-api-specs/snapshot.txt        |  14 +--
 .../MartinThoma/LaTeX-examples/report.yaml         |   5 +-
 .../MartinThoma/LaTeX-examples/snapshot.txt        |   5 +-
 .../MicrosoftDocs/PowerShell-Docs/report.yaml      |  55 +++------
 .../MicrosoftDocs/PowerShell-Docs/snapshot.txt     |  21 +---
 .../snapshots/TheAlgorithms/Python/report.yaml     |   9 +-
 .../snapshots/TheAlgorithms/Python/snapshot.txt    |   7 +-
 .../snapshots/caddyserver/caddy/report.yaml        |   4 +-
 .../snapshots/caddyserver/caddy/snapshot.txt       |   4 +-
 .../snapshots/dart-lang/sdk/report.yaml            |  20 +---
 .../snapshots/dart-lang/sdk/snapshot.txt           |   9 +-
 .../snapshots/django/django/report.yaml            |   6 +-
 .../snapshots/django/django/snapshot.txt           |   5 +-
 .../snapshots/eslint/eslint/report.yaml            |   4 +-
 .../snapshots/eslint/eslint/snapshot.txt           |   3 +-
 .../snapshots/flutter/samples/report.yaml          |  31 +----
 .../snapshots/flutter/samples/snapshot.txt         |  29 +----
 .../googleapis/google-cloud-cpp/report.yaml        |  17 +--
 .../googleapis/google-cloud-cpp/snapshot.txt       |  15 +--
 .../snapshots/ktaranov/sqlserver-kit/report.yaml   |  12 +-
 .../snapshots/ktaranov/sqlserver-kit/snapshot.txt  |  25 ++--
 .../snapshots/neovim/nvim-lspconfig/report.yaml    |   7 +-
 .../snapshots/neovim/nvim-lspconfig/snapshot.txt   |   9 +-
 .../snapshots/php/php-src/report.yaml              |  31 +----
 .../snapshots/php/php-src/snapshot.txt             |  31 +----
 .../snapshots/pycontribs/jira/report.yaml          |   3 +-
 .../snapshots/pycontribs/jira/snapshot.txt         |   3 +-
 .../snapshots/slint-ui/slint/report.yaml           |  51 +-------
 .../snapshots/slint-ui/slint/snapshot.txt          |  36 +-----
 .../snapshots/wireapp/wire-webapp/report.yaml      |  35 +++---
 .../snapshots/wireapp/wire-webapp/snapshot.txt     |  19 ++-
 packages/cspell-bundled-dicts/package.json         |  22 ++--
 pnpm-lock.yaml                                     | 133 ++++++++++++---------
 36 files changed, 184 insertions(+), 522 deletions(-)

fix: Workflow Bot -- Update Dictionaries (main) (#7933)

Update Dictionaries (main)

Summary

 .../snapshots/ktaranov/sqlserver-kit/report.yaml   |  8 +++-
 .../snapshots/ktaranov/sqlserver-kit/snapshot.txt  |  7 +++-
 .../snapshots/slint-ui/slint/report.yaml           |  4 +-
 .../snapshots/slint-ui/slint/snapshot.txt          |  3 +-
 packages/cspell-bundled-dicts/package.json         |  8 ++--
 pnpm-lock.yaml                                     | 45 ++++++++++++----------
 6 files changed, 44 insertions(+), 31 deletions(-)

fix: Wait for the cache to save (#7926)

This fixes a flaky cache situation caused by not waiting for the cache to save before moving on.

fix: Workflow Bot -- Update Dictionaries (main) (#7915)

Update Dictionaries (main)

Summary

 .../MicrosoftDocs/PowerShell-Docs/report.yaml      |   3 +-
 .../MicrosoftDocs/PowerShell-Docs/snapshot.txt     |   3 +-
 .../snapshots/TheAlgorithms/Python/report.yaml     |   3 +-
 .../snapshots/TheAlgorithms/Python/snapshot.txt    |   3 +-
 .../snapshots/flutter/samples/report.yaml          |   4 +-
 .../snapshots/flutter/samples/snapshot.txt         |   3 +-
 .../snapshots/gitbucket/gitbucket/report.yaml      |   4 +-
 .../snapshots/gitbucket/gitbucket/snapshot.txt     |   4 +-
 .../snapshots/neovim/nvim-lspconfig/report.yaml    |   6 +-
 .../snapshots/neovim/nvim-lspconfig/snapshot.txt   |   6 +-
 .../snapshots/php/php-src/report.yaml              |  92 +------------------
 .../snapshots/php/php-src/snapshot.txt             | 102 ++-------------------
 .../snapshots/slint-ui/slint/report.yaml           |  33 ++-----
 .../snapshots/slint-ui/slint/snapshot.txt          |  11 +--
 .../snapshots/sveltejs/svelte/report.yaml          |   3 +-
 .../snapshots/sveltejs/svelte/snapshot.txt         |   3 +-
 packages/cspell-bundled-dicts/package.json         |  16 ++--
 pnpm-lock.yaml                                     |  96 ++++++++++---------
 18 files changed, 96 insertions(+), 299 deletions(-)

fix: Workflow Bot -- Update Dictionaries (main) (#7835)

Update Dictionaries (main)

Summary

 packages/cspell-bundled-dicts/package.json |   4 +-
 packages/cspell-lib/api/api.d.ts           |   9 --
 pnpm-lock.yaml                             | 207 ++++++++++++++++-------------
 3 files changed, 118 insertions(+), 102 deletions(-)

fix: Workflow Bot -- Update Dictionaries (main) (#7822)

Update Dictionaries (main)

Summary

 .../snapshots/vitest-dev/vitest/report.yaml        |  4 +-
 .../snapshots/vitest-dev/vitest/snapshot.txt       |  3 +-
 packages/cspell-bundled-dicts/package.json         |  8 ++--
 pnpm-lock.yaml                                     | 45 ++++++++++++----------
 4 files changed, 31 insertions(+), 29 deletions(-)

fix: Workflow Bot -- Update Dictionaries (main) (#7795)

Update Dictionaries (main)

Summary

 .../snapshots/graphql/graphql-spec/report.yaml     | 108 ++++++++++-----------
 .../snapshots/wireapp/wire-desktop/report.yaml     |   2 +-
 packages/cspell-bundled-dicts/package.json         |   8 +-
 packages/cspell/src/__snapshots__/app.test.ts.snap |  15 +--
 pnpm-lock.yaml                                     |  44 +++++----
 5 files changed, 95 insertions(+), 82 deletions(-)

fix: Workflow Bot -- Update Dictionaries (main) (#7791)

Update Dictionaries (main)

Summary

 packages/cspell-bundled-dicts/package.json         |  8 ++--
 packages/cspell/src/__snapshots__/app.test.ts.snap | 22 +++++-----
 pnpm-lock.yaml                                     | 47 ++++++++++++----------
 3 files changed, 41 insertions(+), 36 deletions(-)

fix: Workflow Bot -- Update Dictionaries (main) (#7768)

Update Dictionaries (main)

Summary

 packages/cspell-bundled-dicts/package.json |  2 +-
 pnpm-lock.yaml                             | 11 ++++++++---
 2 files changed, 9 insertions(+), 4 deletions(-)

fix: Workflow Bot -- Update Dictionaries (main) (#7764)

Update Dictionaries (main)

Summary

 .../snapshots/django/django/report.yaml            |  4 +-
 .../snapshots/django/django/snapshot.txt           |  3 +-
 .../snapshots/php/php-src/report.yaml              |  3 +-
 .../snapshots/php/php-src/snapshot.txt             |  3 +-
 packages/cspell-bundled-dicts/package.json         | 10 ++--
 pnpm-lock.yaml                                     | 57 ++++++++++++----------
 6 files changed, 40 insertions(+), 40 deletions(-)

fix: Workflow Bot -- Update Dictionaries (main) (#7745)

Update Dictionaries (main)

Summary

 .../snapshots/TheAlgorithms/Python/report.yaml     |   3 +-
 .../snapshots/TheAlgorithms/Python/snapshot.txt    |   3 +-
 packages/cspell-bundled-dicts/package.json         |   2 +-
 pnpm-lock.yaml                                     | 162 ++++++++++-----------
 4 files changed, 84 insertions(+), 86 deletions(-)

fix: Workflow Bot -- Update Dictionaries (main) (#7728)

Update Dictionaries (main)

Summary

 integration-tests/snapshots/mdx-js/mdx/report.yaml |  3 +--
 .../snapshots/mdx-js/mdx/snapshot.txt              |  3 +--
 .../snapshots/vitest-dev/vitest/report.yaml        |  6 +-----
 .../snapshots/vitest-dev/vitest/snapshot.txt       |  4 +---
 packages/cspell-bundled-dicts/package.json         |  4 ++--
 pnpm-lock.yaml                                     | 24 +++++++++++-----------
 6 files changed, 18 insertions(+), 26 deletions(-)

fix: Workflow Bot -- Update Dictionaries (main) (#7672)

Update Dictionaries (main)

Summary

 packages/cspell-bundled-dicts/package.json |  6 ++---
 pnpm-lock.yaml                             | 36 +++++++++++++++---------------
 2 files changed, 21 insertions(+), 21 deletions(-)

fix: Workflow Bot -- Update Dictionaries (main) (#7662)

Update Dictionaries (main)

Summary

 packages/cspell-bundled-dicts/package.json |  6 ++---
 pnpm-lock.yaml                             | 36 +++++++++++++++---------------
 2 files changed, 21 insertions(+), 21 deletions(-)

refactor: Support url based cache entries (#7639)

fix: Support remote dependencies in cache (#7642)

fix: Remove flat-cache dependency (#7636)

flat-cache v6 is not compatible with the cspell cache. Since flat-cache was mostly a pass through to flatted, it was better to just replace it.

refactor: move towards caching URLs (#7634)

fix: Support async cache (#7631)

fix: Replace file-entry-cache (#6579)

Deprecating the use of file-entry-cache.

v10 of file-entry-cache breaks the spell checker and bloats the cache size.

This PR is the first step in reducing the dependency upon file-entry-cache and its dependencies.

fix: Clean cspell-lib type exports (#7615)

fix: Workflow Bot -- Update Dictionaries (main) (#7618)

Update Dictionaries (main)

Summary

 integration-tests/snapshots/vitest-dev/vitest/report.yaml  | 10 ++--------
 integration-tests/snapshots/vitest-dev/vitest/snapshot.txt |  5 +----
 packages/cspell-bundled-dicts/package.json                 |  2 +-
 pnpm-lock.yaml                                             | 12 ++++++------
 4 files changed, 10 insertions(+), 19 deletions(-)

fix: Compile before publish (#7610)