v9.1.1

Changes

Fixes

fix: Use the native JSON parser if possible (#7502)

fix: Use the native JSON parser if possible (#7502)

Some of the cspell settings have grow large. The fix is to use the native JSON parser instead of one that accepts comments.

---

v9.1.0

Changes

Features

feat: Add command `dictionaries` (#7445)

feat: Add command dictionaries (#7445)

Add new dictionaries command to the cli

Usage: cspell dictionaries [options]

List dictionaries

Options:
  -c, --config <cspell.json>  Configuration file to use.  By default cspell
                              looks for cspell.json in the current directory.
  --path-format <format>      Configure how to display the dictionary path.
                              (choices: "hide", "short", "long", "full",
                              default: Display most of the path.)
  --color                     Force color.
  --no-color                  Turn off color.
  --no-default-configuration  Do not load the default configuration and
                              dictionaries.
  -h, --help                  display help for command

---

feat: Add lint option `--dictionary` (#7441)

feat: Add lint option --dictionary (#7441)

Add lint options:

• --dictionary - enable a dictionary by name
• --disable-dictionary - disable a dictionary by name

---

feat: Add init command to command-line. (#7414)

feat: Add init command to command-line. (#7414)

New command:

Usage: cspell init [options]

Initialize a CSpell configuration file.

Options:
  -o, --output <path>        Define where to write file.
  --format <format>          Define the format of the file. (choices: "yaml",
                             "yml", "json", "jsonc", default: "yaml")
  --import <path|package>    Import a configuration file or dictionary package.
  --locale <locale>          Define the locale to use when spell checking (e.g.,
                             en, en-US, de).
  --dictionary <dictionary>  Enable a dictionary.
  --no-comments              Do not add comments to the config file.
  --no-schema                Do not add the schema reference to the config file.
  -h, --help                 display help for command

---

feat: Add command line option to set reporting level (#7380)

feat: Add command line option to set reporting level (#7380)

Command Line Option: --report

Option: --report
Choices:

• all - report everything (default)
• simple - only report issues with simple fixes.
• typos - only report issues with common typos.
• flagged - only report flagged issues.

Reporters - add opt-in feature flag

To support legacy reporters, it is necessary to check if they support new features.

Features:

/**
 * Allows the reporter to advertise which features it supports.
 */
interface FeaturesSupportedByReporter {
    /**
     * The reporter supports the {@link ReportingConfiguration.unknownWords} option and understands
     * how to filter issues based upon {@link Issue.isFlagged}, {@link Issue.hasSimpleSuggestions} and {@link Issue.hasPreferredSuggestions}.
     * - `true` - The `reporter.issue` method will be called for all spelling issues and it is expected to handle .
     * - `false | undefined` - the unknown words will be filtered out based upon the `unknownWords` setting before being passed to the reporter.
     */
    unknownWords?: boolean | undefined;

    /**
     * The reporter supports the {@link Issue.issueType} option.
     * - `true` - the reporter will be called with all issues types.
     * - `false | undefined` - only {@link IssueType.spelling} issues will be passed to the reporter.
     */
    issueType?: boolean | undefined;
}

---

Fixes

fix: Fix perf issue related to searching for the config. (#7483)

fix: Fix perf issue related to searching for the config. (#7483)

---

fix: Hide `--config-search` option (#7479)

fix: Hide --config-search option (#7479)

---

refactor: `isolatedDeclarations: true` (#7459)

refactor: isolatedDeclarations: true (#7459)

---

refactor: enable isolatedDeclarations (#7456)

refactor: enable isolatedDeclarations (#7456)

---

refactor: enable isolatedDeclarations (#7452)

refactor: enable isolatedDeclarations (#7452)

---

fix: Add option to continue on error (#7451)

fix: Add option to continue on error (#7451)

Add lint option:

  --continue-on-error          Continue processing files even if there is a configuration error.

---

fix: Improve dictionaries command (#7449)

fix: Improve dictionaries command (#7449)

Add options:

  --enabled                   Show only enabled dictionaries.
  --no-enabled                Do not show enabled dictionaries.
  --locale <locale>           Set language locales. i.e. "en,fr" for English and
                              French, or "en-GB" for British English.
  --file-type <fileType>      File type to use. i.e. "html", "golang", or
                              "javascript".
  --no-show-location          Do not show the location of the dictionary.
  --show-file-types           Show the file types supported by the dictionary.
                              (default: false)
  --show-locales              Show the language locales supported by the
                              dictionary. (default: false)

---

fix: Add trace option `--dictionary` (#7443)

fix: Add trace option --dictionary (#7443)

Usage: cspell trace [options] [words...]

Options:
  --dictionary <name>         Enable a dictionary by name. Can be used multiple
                              times.

---

fix: Add init options (#7436)

fix: Add init options (#7436)

New options:

  -c, --config <path>        Path to the CSpell configuration file. Conflicts
                             with --output and --format.
  --remove-comments          Remove all comments from the config file.
  --stdout                   Write the configuration to stdout instead of a
                             file.

Help:

Usage: cspell init [options]

Initialize a CSpell configuration file.

Options:
  -c, --config <path>        Path to the CSpell configuration file. Conflicts
                             with --output and --format.
  -o, --output <path>        Define where to write file.
  --format <format>          Define the format of the file. (choices: "yaml",
                             "yml", "json", "jsonc", default: "yaml")
  --import <path|package>    Import a configuration file or dictionary package.
  --locale <locale>          Define the locale to use when spell checking (e.g.,
                             en, en-US, de).
  --dictionary <dictionary>  Enable a dictionary. Can be used multiple times.
  --no-comments              Do not add comments to the config file.
  --remove-comments          Remove all comments from the config file.
  --no-schema                Do not add the schema reference to the config file.
  --stdout                   Write the configuration to stdout instead of a
                             file.
  -h, --help                 display help for command

---

fix: Allow init of `cspell.config.yml` files (#7432)

fix: Allow init of cspell.config.yml files (#7432)

Add yml to the init command format list.

cspell init --format=yml

It will create a cspell.config.yml file.

---

fix: Only generate the context if necessary (#7388)

fix: Only generate the context if necessary (#7388)

---

fix: Correct the schema generator (#7395)

fix: Correct the schema generator (#7395)

---

Dictionary Updates

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

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

Update Dictionaries (main)

Summary

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

---

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

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

Update Dictionaries (main)

Summary

 .../snapshots/AdaDoom3/AdaDoom3/report.yaml        |  1994 ++--
 .../Azure/azure-rest-api-specs/report.yaml         |    18 +-
 .../MartinThoma/LaTeX-examples/report.yaml         |   616 +-
 .../MicrosoftDocs/PowerShell-Docs/report.yaml      |   236 +-
 .../snapshots/RustPython/RustPython/report.yaml    |   442 +-
 .../SoftwareBrothers/admin-bro/report.yaml         |     2 +-
 .../snapshots/TheAlgorithms/Python/report.yaml     |   178 +-
 .../snapshots/alexiosc/megistos/report.yaml        |  1292 +--
 .../aspnetboilerplate/report.yaml                  |   244 +-
 .../snapshots/aws-amplify/docs/report.yaml         |    14 +-
 .../snapshots/caddyserver/caddy/report.yaml        |    36 +-
 .../snapshots/dart-lang/sdk/report.yaml            |   498 +-
 .../snapshots/django/django/report.yaml            |  1318 +--
 .../snapshots/eslint/eslint/report.yaml            |    76 +-
 .../snapshots/flutter/samples/report.yaml          | 10744 +++++++++----------
 .../snapshots/gitbucket/gitbucket/report.yaml      |     8 +-
 .../googleapis/google-cloud-cpp/report.yaml        |   114 +-
 .../iluwatar/java-design-patterns/report.yaml      |    52 +-
 .../snapshots/ktaran...

v9.0.2

Changes

Fixes

fix: Add eslint plugin helpers (#7352)

fix: Add eslint plugin helpers (#7352)

Add helper methods:

• defineCSpellPluginOptions
• defineCSpellConfig

Add some examples for supportNonStrictSearches

---

fix: Make it possible to define a strict dictionary. (#7351)

fix: Make it possible to define a strict dictionary. (#7351)

---

fix: Correct the Hunspell Reader usage. (#7325)

fix: Correct the Hunspell Reader usage. (#7325)

Add an example.

---

Dictionary Updates

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

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

Update Dictionaries (main)

Summary

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

---

v9.0.1

Changes

Fixes

fix: Add support to add words to config and keep comments. (#7295)

fix: Add support to add words to config and keep comments. (#7295)

---

Dictionary Updates

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

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

Update Dictionaries (main)

Summary

 .../snapshots/dart-lang/sdk/report.yaml            | 10 ++-----
 .../snapshots/dart-lang/sdk/snapshot.txt           |  4 +--
 .../snapshots/ktaranov/sqlserver-kit/report.yaml   |  2 +-
 .../snapshots/vitest-dev/vitest/report.yaml        |  4 +--
 .../snapshots/vitest-dev/vitest/snapshot.txt       |  3 +-
 packages/cspell-bundled-dicts/package.json         |  6 ++--
 pnpm-lock.yaml                                     | 33 +++++++++++++---------
 7 files changed, 29 insertions(+), 33 deletions(-)

---

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

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

Update Dictionaries (main)

Summary

 .../snapshots/AdaDoom3/AdaDoom3/report.yaml        |  3 +-
 .../snapshots/AdaDoom3/AdaDoom3/snapshot.txt       |  3 +-
 .../MicrosoftDocs/PowerShell-Docs/report.yaml      | 12 +++---
 .../MicrosoftDocs/PowerShell-Docs/snapshot.txt     |  4 +-
 .../snapshots/eslint/eslint/report.yaml            |  6 +--
 .../snapshots/eslint/eslint/snapshot.txt           |  3 +-
 packages/cspell-bundled-dicts/package.json         |  8 ++--
 pnpm-lock.yaml                                     | 45 ++++++++++++----------
 8 files changed, 40 insertions(+), 44 deletions(-)

---

v9.0.0

Changes

BREAKING

feat!: End support for Node 18 (#7275)

feat!: End support for Node 18 (#7275)

---

Fixes

fix: Update en-gb dictionary to en-gb-mit (#7278)

fix: Update en-gb dictionary to en-gb-mit (#7278)

---

Dictionary Updates

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

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

Update Dictionaries (main)

Summary

 .../snapshots/dart-lang/sdk/report.yaml            |  6 +--
 .../snapshots/dart-lang/sdk/snapshot.txt           |  3 +-
 .../snapshots/liriliri/licia/report.yaml           |  3 +-
 .../snapshots/liriliri/licia/snapshot.txt          |  3 +-
 .../microsoft/TypeScript-Website/report.yaml       |  5 +-
 .../microsoft/TypeScript-Website/snapshot.txt      |  3 +-
 .../snapshots/neovim/nvim-lspconfig/report.yaml    |  5 +-
 .../snapshots/neovim/nvim-lspconfig/snapshot.txt   |  3 +-
 .../snapshots/pycontribs/jira/report.yaml          |  3 +-
 .../snapshots/pycontribs/jira/snapshot.txt         |  3 +-
 .../snapshots/wireapp/wire-webapp/report.yaml      |  5 +-
 .../snapshots/wireapp/wire-webapp/snapshot.txt     |  3 +-
 packages/cspell-bundled-dicts/package.json         | 10 ++--
 pnpm-lock.yaml                                     | 60 +++++++++++++---------
 14 files changed, 57 insertions(+), 58 deletions(-)

---

v8.19.4

Changes

Fixes

fix(cspell-tools): Improve inclusion / exclusion support (#7271)

fix(cspell-tools): Improve inclusion / exclusion support (#7271)

---

fix: Reduce the flatpack JSON size (#7248)

fix: Reduce the flatpack JSON size (#7248)

---

v8.19.3

Changes

Fixes

fix: Adjust the meaning of CSPELL\_DEFAULT\_CONFIG\_PATH (#7240)

fix: Adjust the meaning of CSPELL_DEFAULT_CONFIG_PATH (#7240)

CSPELL_DEFAULT_CONFIG_PATH is used when no other config files have been found.

---

feat: resolve config from global path (#7234)

feat: resolve config from global path (#7234)

---

fix: Replace `get-stdin` with native alternative (#7229)

fix: Replace get-stdin with native alternative (#7229)

https://github.com/sindresorhus/get-stdin

Can't test on local, hope it won't break tests.

---

Dictionary Updates

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

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

Update Dictionaries (main)

Summary

 .../snapshots/php/php-src/report.yaml              |  4 +---
 .../snapshots/php/php-src/snapshot.txt             |  4 +---
 packages/cspell-bundled-dicts/package.json         |  4 ++--
 pnpm-lock.yaml                                     | 23 +++++++++++++---------
 4 files changed, 18 insertions(+), 17 deletions(-)

---

v8.19.2

Changes

Fixes

fix: improve eslint plugin perf (#7199)

fix: improve eslint plugin perf (#7199)

Do not send the AST to the worker thread.

This changed the local test from 8.4 seconds to 6 seconds.

Adjusting the WalkTree function got it down to less than 5 seconds.

Related to #6999

---

v8.19.1

Changes

Fixes

fix: Workaround picomatch bug (#7195)

fix: Workaround picomatch bug (#7195)

fixes #7194

---

Dictionary Updates

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

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

Update Dictionaries (main)

Summary

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

---

v8.19.0

Changes

Features

feat: Be able to ignore forbidden words in a dictionary (#7182)

feat: Be able to ignore forbidden words in a dictionary (#7182)

Related to:

• streetsidesoftware/vscode-spell-checker#3810
• streetsidesoftware/vscode-spell-checker#1765
• #7181

---

Dictionary Updates

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

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

Update Dictionaries (main)

Summary

 .../snapshots/AdaDoom3/AdaDoom3/report.yaml        | 17 +----------
 .../snapshots/AdaDoom3/AdaDoom3/snapshot.txt       | 21 ++-----------
 .../MartinThoma/LaTeX-examples/report.yaml         |  3 +-
 .../MartinThoma/LaTeX-examples/snapshot.txt        |  3 +-
 .../snapshots/TheAlgorithms/Python/report.yaml     |  6 ++--
 .../snapshots/TheAlgorithms/Python/snapshot.txt    |  4 +--
 integration-tests/snapshots/mdx-js/mdx/report.yaml |  7 +----
 .../snapshots/mdx-js/mdx/snapshot.txt              |  7 +----
 packages/cspell-bundled-dicts/package.json         |  6 ++--
 pnpm-lock.yaml                                     | 35 ++++++++++++----------
 10 files changed, 34 insertions(+), 75 deletions(-)

---

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

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

Update Dictionaries (main)

Summary

 .../snapshots/RustPython/RustPython/report.yaml    |  15 +-
 .../snapshots/RustPython/RustPython/snapshot.txt   |  12 +-
 .../snapshots/alexiosc/megistos/report.yaml        |  33 +++-
 .../snapshots/alexiosc/megistos/snapshot.txt       |  31 +++-
 .../googleapis/google-cloud-cpp/report.yaml        |   5 +-
 .../googleapis/google-cloud-cpp/snapshot.txt       |   3 +-
 .../snapshots/php/php-src/report.yaml              | 136 ++++++++++++++-
 .../snapshots/php/php-src/snapshot.txt             | 188 ++++++++++++++++++---
 packages/cspell-bundled-dicts/package.json         |   2 +-
 pnpm-lock.yaml                                     |  11 +-
 10 files changed, 392 insertions(+), 44 deletions(-)

---

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

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

Update Dictionaries (main)

Summary

 .../snapshots/AdaDoom3/AdaDoom3/report.yaml        |  8 +--
 .../snapshots/AdaDoom3/AdaDoom3/snapshot.txt       |  8 +--
 .../MartinThoma/LaTeX-examples/report.yaml         |  3 +-
 .../MartinThoma/LaTeX-examples/snapshot.txt        |  3 +-
 .../snapshots/caddyserver/caddy/report.yaml        | 17 +----
 .../snapshots/caddyserver/caddy/snapshot.txt       | 13 +---
 .../googleapis/google-cloud-cpp/report.yaml        |  9 +--
 .../googleapis/google-cloud-cpp/snapshot.txt       |  5 +-
 .../snapshots/liriliri/licia/report.yaml           |  3 +-
 .../snapshots/liriliri/licia/snapshot.txt          |  3 +-
 packages/cspell-bundled-dicts/package.json         | 12 ++--
 pnpm-lock.yaml                                     | 75 ++++++++++++----------
 12 files changed, 60 insertions(+), 99 deletions(-)

---

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

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

Update Dictionaries (main)

Summary

 .../snapshots/TheAlgorithms/Python/report.yaml     |  8 +---
 .../snapshots/TheAlgorithms/Python/snapshot.txt    |  6 +--
 .../snapshots/dart-lang/sdk/report.yaml            |  4 +-
 .../snapshots/dart-lang/sdk/snapshot.txt           |  3 +-
 .../googleapis/google-cloud-cpp/report.yaml        |  3 +-
 .../googleapis/google-cloud-cpp/snapshot.txt       |  3 +-
 .../snapshots/php/php-src/report.yaml              |  5 +-
 .../snapshots/php/php-src/snapshot.txt             |  5 +-
 .../snapshots/slint-ui/slint/report.yaml           | 12 +----
 .../snapshots/slint-ui/slint/snapshot.txt          | 11 +----
 packages/cspell-bundled-dicts/package.json         |  8 ++--
 pnpm-lock.yaml                                     | 54 +++++++++++++---------
 12 files changed, 48 insertions(+), 74 deletions(-)

---

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

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

Update Dictionaries (main)

Summary

 packages/cspell-bundled-dicts/package.json |  8 ++---
 pnpm-lock.yaml                             | 55 ++++++++++++++++--------------
 2 files changed, 34 insertions(+), 29 deletions(-)

---

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

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

Update Dictionaries (main)

Summary

 .../snapshots/eslint/eslint/report.yaml            |  6 +--
 .../snapshots/eslint/eslint/snapshot.txt           |  3 +-
 .../snapshots/ktaranov/sqlserver-kit/report.yaml   |  4 +-
 .../snapshots/ktaranov/sqlserver-kit/snapshot.txt  |  5 +-
 packages/cspell-bundled-dicts/package.json         | 10 ++--
 pnpm-lock.yaml                                     | 63 ++++++++++++----------
 6 files changed, 45 insertions(+), 46 deletions(-)

---