chore: Prepare Release v9.1.0 (auto-deploy) by street-side-software-automation[bot] · Pull Request #7487 · streetsidesoftware/cspell

street-side-software-automation · 2025-06-12T21:05:38Z

Release v9.1.0

Release Notes

Details

Changes

Features

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)

Add lint options:

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

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)

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: Hide `--config-search` option (#7479)

refactor: `isolatedDeclarations: true` (#7459)

refactor: enable isolatedDeclarations (#7456)

refactor: enable isolatedDeclarations (#7452)

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)

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)

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

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

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)

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: Correct the schema generator (#7395)

Dictionary Updates

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)

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/ktaranov/sqlserver-kit/report.yaml   |  7542 ++++++-------
 .../snapshots/liriliri/licia/report.yaml           |   148 +-
 integration-tests/snapshots/mdx-js/mdx/report.yaml |    58 +-
 .../microsoft/TypeScript-Website/report.yaml       |    98 +-
 .../snapshots/neovim/nvim-lspconfig/report.yaml    |   844 +-
 .../snapshots/pagekit/pagekit/report.yaml          |    17 +-
 .../snapshots/pagekit/pagekit/snapshot.txt         |     3 +-
 .../snapshots/php/php-src/report.yaml              |  4260 ++++----
 .../snapshots/pycontribs/jira/report.yaml          |     4 +-
 .../snapshots/slint-ui/slint/report.yaml           |   518 +-
 .../snapshots/sveltejs/svelte/report.yaml          |  2548 ++---
 .../typescript-cheatsheets/react/report.yaml       |     6 +-
 .../snapshots/vitest-dev/vitest/report.yaml        |    62 +-
 .../snapshots/wireapp/wire-webapp/report.yaml      |   994 +-
 packages/cspell-bundled-dicts/package.json         |     8 +-
 .../__snapshots__/validator.test.ts.snap           |     4 +-
 .../cspell/src/app/__snapshots__/app.test.ts.snap  |    96 +-
 pnpm-lock.yaml                                     |    52 +-
 36 files changed, 17573 insertions(+), 17571 deletions(-)

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

Update Dictionaries (main)

Summary

 .../MicrosoftDocs/PowerShell-Docs/report.yaml      |  3 +-
 .../MicrosoftDocs/PowerShell-Docs/snapshot.txt     |  3 +-
 .../snapshots/ktaranov/sqlserver-kit/report.yaml   | 10 +--
 .../snapshots/ktaranov/sqlserver-kit/snapshot.txt  |  9 +--
 .../microsoft/TypeScript-Website/report.yaml       |  6 +-
 .../microsoft/TypeScript-Website/snapshot.txt      |  4 +-
 .../snapshots/neovim/nvim-lspconfig/report.yaml    |  5 +-
 .../snapshots/neovim/nvim-lspconfig/snapshot.txt   |  3 +-
 .../webdeveric/webpack-assets-manifest/report.yaml |  7 +-
 .../webpack-assets-manifest/snapshot.txt           |  5 +-
 packages/cspell-bundled-dicts/package.json         | 16 ++--
 .../cspell/src/app/__snapshots__/app.test.ts.snap  | 30 +++----
 pnpm-lock.yaml                                     | 93 ++++++++++++----------
 13 files changed, 95 insertions(+), 99 deletions(-)

Documentation

fix: Correct the schema generator (#7395)

Version Information

Tag: v9.1.0
Version: 9.1.0

Summary

 .release.json                                |   6 +-
 CHANGELOG.md                                 | 424 +++++++++++++++++++++++++++
 packages/Samples/CHANGELOG.md                |  43 +++
 packages/cspell-bundled-dicts/CHANGELOG.md   |  43 +++
 packages/cspell-code-snippets/CHANGELOG.md   |  43 +++
 packages/cspell-config-lib/CHANGELOG.md      |  43 +++
 packages/cspell-dictionary/CHANGELOG.md      |  43 +++
 packages/cspell-eslint-plugin/CHANGELOG.md   |  43 +++
 packages/cspell-filetypes/CHANGELOG.md       |  43 +++
 packages/cspell-gitignore/CHANGELOG.md       |  43 +++
 packages/cspell-glob/CHANGELOG.md            |  43 +++
 packages/cspell-grammar/CHANGELOG.md         |  43 +++
 packages/cspell-io/CHANGELOG.md              |  43 +++
 packages/cspell-json-reporter/CHANGELOG.md   |  43 +++
 packages/cspell-lib/CHANGELOG.md             |  43 +++
 packages/cspell-normalize-json/CHANGELOG.md  |  43 +++
 packages/cspell-pipe/CHANGELOG.md            |  43 +++
 packages/cspell-resolver/CHANGELOG.md        |  43 +++
 packages/cspell-service-bus/CHANGELOG.md     |  43 +++
 packages/cspell-strong-weak-map/CHANGELOG.md |  43 +++
 packages/cspell-tools-alias/CHANGELOG.md     |  43 +++
 packages/cspell-tools/CHANGELOG.md           |  43 +++
 packages/cspell-trie-lib/CHANGELOG.md        |  43 +++
 packages/cspell-trie/CHANGELOG.md            |  43 +++
 packages/cspell-types/CHANGELOG.md           |  43 +++
 packages/cspell-url/CHANGELOG.md             |  43 +++
 packages/cspell/CHANGELOG.md                 | 424 +++++++++++++++++++++++++++
 packages/dynamic-import/CHANGELOG.md         |  43 +++
 packages/flatpack-json/CHANGELOG.md          |  43 +++
 packages/hunspell-reader/CHANGELOG.md        |  43 +++
 30 files changed, 2012 insertions(+), 3 deletions(-)

github-actions Bot added the chore label Jun 12, 2025

street-side-software-automation Bot force-pushed the release-draft branch from 2810ffd to 4ad0b30 Compare June 12, 2025 21:22

github-actions Bot force-pushed the release-draft branch 13 times, most recently from 64eeb9e to d0272cb Compare June 14, 2025 12:31

chore: Prepare Release v9.1.0

84096ce

github-actions Bot force-pushed the release-draft branch from d0272cb to 84096ce Compare June 14, 2025 12:33

github-actions Bot changed the title ~~chore: Prepare Release v9.1.0~~ chore: Prepare Release v9.1.0 (auto-deploy) Jun 14, 2025

Jason3S merged commit e6d3251 into main Jun 14, 2025
1 check passed

Jason3S deleted the release-draft branch June 14, 2025 12:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: Prepare Release v9.1.0 (auto-deploy)#7487

chore: Prepare Release v9.1.0 (auto-deploy)#7487
Jason3S merged 1 commit into
mainfrom
release-draft

street-side-software-automation Bot commented Jun 12, 2025 •

edited by github-actions Bot

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

street-side-software-automation Bot commented Jun 12, 2025 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Release v9.1.0

Release Notes

Changes

Features

feat: Add command dictionaries (#7445)

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

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

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

Command Line Option: --report

Reporters - add opt-in feature flag

Fixes

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

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

refactor: isolatedDeclarations: true (#7459)

refactor: enable isolatedDeclarations (#7456)

refactor: enable isolatedDeclarations (#7452)

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

fix: Improve dictionaries command (#7449)

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

fix: Add init options (#7436)

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

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

fix: Correct the schema generator (#7395)

Dictionary Updates

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

Update Dictionaries (main)

Summary

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

Update Dictionaries (main)

Summary

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

Update Dictionaries (main)

Summary

Documentation

fix: Correct the schema generator (#7395)

Version Information

Summary

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

street-side-software-automation Bot commented Jun 12, 2025 •

edited by github-actions Bot

Loading

feat: Add command `dictionaries` (#7445)

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

Command Line Option: `--report`

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

refactor: `isolatedDeclarations: true` (#7459)

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

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