chore(deps): update dependency cspell to v10.3.6

[renovate]

This PR contains the following updates:

Package	Change	Age	Confidence
cspell (source)	10.2.0 → 10.3.6

---

Release Notes

streetsidesoftware/cspell (cspell)

v10.3.6

Compare Source

Fixes

fix: Report unknown CSpell directives again (#​9319)

fix: Report unknown CSpell directives again (#​9319)

v10.3.5

Compare Source

Fixes

fix(cspell-lib): `shouldCheckDocument` honors the `forceCheck` option (#​9303)

fix(cspell-lib): shouldCheckDocument honors the forceCheck option (#​9303)

v10.3.4

Compare Source

Fixes

fix: Fix Sponsor cards on npmjs (#​9260)

fix: Fix Sponsor cards on npmjs (#​9260)

---

v10.3.3

Compare Source

Fixes

fix: Add `--json` option to check text for use with AI (#​9254)

fix: Add --json option to check text for use with AI (#​9254)

This pull request adds support for a --json output mode to the check CLI command, enabling results to be emitted as structured JSON per file. It also introduces comprehensive test coverage for the new JSON output behavior, including error handling and exit code logic.

CLI Enhancements:

• Added a --json flag to the check command, allowing users to receive results in JSON format. This includes proper handling of multiple files and error cases, such as missing files. [1] [2]
• Updated the exit code logic to work with both standard and JSON output, respecting the --no-exit-code flag. [1] [2]

Implementation Details:

• Introduced separate processing functions: processRequestAnsi for standard output and processRequestJSON for JSON output, with the latter aggregating results and errors per file. [1] [2]
• Added a helper function to detect missing files and report them as JSON errors.

Testing Improvements:

• Expanded CLI test coverage to include various --json scenarios, such as files with spelling errors, missing files, and the interaction with --no-exit-code. [1] [2]
• Added utility functions and interfaces in tests to parse and validate the JSON output.

---

fix: Mark ParsedTags as read only. (#​9253)

fix: Mark ParsedTags as read only. (#​9253)

This pull request makes a small but important change to the ParsedText interface in several files, improving type safety by marking the tags property as a read-only type. This ensures that the tags associated with a parsed text segment cannot be modified after creation.

• Updated the tags property in the ParsedText interface to use Readonly<ParsedTags> instead of ParsedTags, making the tags immutable in the following files:
  • packages/cspell-types/api/Parser/index.d.mts
  • packages/cspell-types/api/index.d.mts
  • packages/cspell-types/src/Parser/parser.ts

---

fix: Make sure Parser and DocumentParser can be used together. (#​9252)

fix: Make sure Parser and DocumentParser can be used together. (#​9252)

This pull request enhances the parser interface definitions in the cspell-types package to provide better flexibility and clarity for parser implementations. The main changes introduce optional parseDocument and parse methods to both the Parser and DocumentParser interfaces, across both type declaration and source files.

Parser interface enhancements:

• Added an optional parseDocument method to the Parser interface, allowing parsers to optionally implement document-based parsing. (packages/cspell-types/api/Parser/index.d.mts [1] packages/cspell-types/api/index.d.mts [2] packages/cspell-types/src/Parser/parser.ts [3]
• Added an optional parse method to the DocumentParser interface, enabling parsers to optionally implement content-and-filename-based parsing. (packages/cspell-types/api/Parser/index.d.mts [1] packages/cspell-types/api/index.d.mts [2] packages/cspell-types/src/Parser/parser.ts [3]

---

v10.3.2

Compare Source

Fixes

fix: Add tags to ParsedText (#​9237)

fix: Add tags to ParsedText (#​9237)

This pull request introduces the concept of "tags" for parsed text segments in the CSpell types, allowing each segment of text to be annotated with a set of named tags. These tags can hold boolean, string, or undefined values, supporting richer metadata for parsers and downstream consumers. The changes affect both the TypeScript source and the type definitions.

The most important changes are:

Tagging Support for Parsed Text

• Added a new optional tags property to the ParsedText interface, allowing each parsed text segment to carry a set of tags as metadata. (ParsedText in parser.ts, index.d.mts, index.d.mts) [1] [2] [3]
• Introduced the ParsedTag type (boolean | string | undefined) and the ParsedTags interface (a map of tag names to ParsedTag values) to define the structure of tags. (parser.ts, index.d.mts, index.d.mts) [1] [2] [3]

Type Exports and API Surface

• Updated exports throughout the codebase to include ParsedTag and ParsedTags, making these types available to consumers. (src/Parser/index.ts, src/index.ts, index.d.mts, index.d.mts) [1] [2] [3] [4]
• Changed the export style in src/Parser/index.mts from export * to export type *, ensuring only types are exported.

These changes lay the groundwork for parsers and other tools to annotate text with structured metadata, improving extensibility and downstream processing.

---

v10.3.1

Compare Source

Fixes

fix: CSpell-Tools support replacements (#​9205)

fix: CSpell-Tools support replacements (#​9205)

Support replacing word fragments before adding the word to the dictionary.

v10.3.0

Compare Source

Features

feat: Add an option to set the kind of dictionary file (#​9178)

feat: Add an option to set the kind of dictionary file (#​9178)

This pull request introduces support for the new kind property in dictionary definitions, enabling explicit specification of dictionary types such as words, flag-words, and ignore-words.

{
  "version": "0.2",
  "language": "en-US",
  "caseSensitive": false,
  "dictionaryDefinitions": [
    {
      "name": "forbidden-spelling",
      "path": "./forbidden-spelling.txt",
      "kind": "flag-words"
    }
  ],
  "dictionaries": ["forbidden-spelling"]
}

forbidden-spelling.txt

# Add forbidden words below.
# Words starting with `!` are exceptions.

# cspell:disable
english:English # Do not allow `english` and suggest `English`
!English # needed to allow `English`
!ENGLISH # needed to allow `ENGLISH`

forbidden_word # All variants of `forbidden_word` are not allowed.

# Mixed case words:
cSpell # only `cSpell` is flagged. `cspell` will not be.

It updates the JSON schema, dictionary loading logic, and adds new APIs and tests to handle these kinds, including support for loading forbidden (flag) words from trie files.

Schema and API Enhancements:

• Added a kind property to dictionary definitions in the cspell.schema.json schema, allowing configuration of dictionary type as words, flag-words, or ignore-words [1] [2] [3] [4] [5].
• Updated the internal dictionary settings and loader logic to recognize and handle the new kind property, ensuring correct dictionary instantiation based on its value [1] [2] [3] [4].

Flag Words Dictionary Support:

• Introduced createFlagWordsDictionaryFromTrieFile to allow creating forbidden words dictionaries directly from trie files, and exposed this function in the public API [1] [2] [3] [4] [5].
• Added comprehensive tests for the new kind behaviors and for loading flag words from trie files, ensuring correct forbidden word detection and suggestion handling [1] [2].

Sample and Fixture Updates:

• Added a new sample file flag-words.txt to demonstrate and test the flag words functionality.

These changes collectively provide more flexible and explicit dictionary configuration, improve forbidden word handling, and ensure robust support for new and existing dictionary formats.

---

Fixes

fix: Only hide code-like partial words (#​9163)

fix: Only hide code-like partial words (#​9163)

---

Documentation

feat: Add an option to set the kind of dictionary file (#​9178)

feat: Add an option to set the kind of dictionary file (#​9178)

This pull request introduces support for the new kind property in dictionary definitions, enabling explicit specification of dictionary types such as words, flag-words, and ignore-words.

{
  "version": "0.2",
  "language": "en-US",
  "caseSensitive": false,
  "dictionaryDefinitions": [
    {
      "name": "forbidden-spelling",
      "path": "./forbidden-spelling.txt",
      "kind": "flag-words"
    }
  ],
  "dictionaries": ["forbidden-spelling"]
}

forbidden-spelling.txt

# Add forbidden words below.
# Words starting with `!` are exceptions.

# cspell:disable
english:English # Do not allow `english` and suggest `English`
!English # needed to allow `English`
!ENGLISH # needed to allow `ENGLISH`

forbidden_word # All variants of `forbidden_word` are not allowed.

# Mixed case words:
cSpell # only `cSpell` is flagged. `cspell` will not be.

It updates the JSON schema, dictionary loading logic, and adds new APIs and tests to handle these kinds, including support for loading forbidden (flag) words from trie files.

Schema and API Enhancements:

• Added a kind property to dictionary definitions in the cspell.schema.json schema, allowing configuration of dictionary type as words, flag-words, or ignore-words [1] [2] [3] [4] [5].
• Updated the internal dictionary settings and loader logic to recognize and handle the new kind property, ensuring correct dictionary instantiation based on its value [1] [2] [3] [4].

Flag Words Dictionary Support:

• Introduced createFlagWordsDictionaryFromTrieFile to allow creating forbidden words dictionaries directly from trie files, and exposed this function in the public API [1] [2] [3] [4] [5].
• Added comprehensive tests for the new kind behaviors and for loading flag words from trie files, ensuring correct forbidden word detection and suggestion handling [1] [2].

Sample and Fixture Updates:

• Added a new sample file flag-words.txt to demonstrate and test the flag words functionality.

These changes collectively provide more flexible and explicit dictionary configuration, improve forbidden word handling, and ensure robust support for new and existing dictionary formats.

---

v10.2.2

Compare Source

Fixes

fix: Workaround for #​9164 (#​9168)

fix: Workaround for #​9164 (#​9168)

This pull request updates the word splitter to improve its handling of long or complex words and adds new test cases to ensure correct behavior. The main changes include increasing the allowed number of skipped breaks and attempts for word splitting, updating test cases to cover additional scenarios, and adjusting ignored words in the dictionary tests.

Word splitting improvements:

• Increased the maximum number of skipped breaks (maxSkippedBreaks) from 8 to 16 and set a new maximum number of attempts (maxAttempts) to 64,000 in wordSplitter.ts to better handle complex word splitting cases.
• Removed the local maxAttempts limit in the splitIntoWords function, relying instead on the new global constant.

Test enhancements:

• Updated the ignored words in the dictionary test to include a new Base64 string (QmFzZTY0IHN0cmluZyBvZiB0ZXh0IGhlcmU) and used cspell:disable/cspell:enable comments for clarity.
• Added a new test case to validate splitting of the string 'QmFzZTY0IHN0cmluZyBvZiB0ZXh0IGhlcmU.access' in the word splitter tests.

---

v10.2.1

Compare Source

Fixes

fix: support soft hyphens in the word splitter (#​9144)

fix: support soft hyphens in the word splitter (#​9144)

This pull request introduces several improvements and fixes to the word segmentation and word splitting logic, especially for Thai language support and symbol handling. The main changes include updating the Thai segmentation to use soft hyphens, enhancing the word splitting logic to handle more cases (including camelCase, symbols, and soft hyphens), and refactoring the code for better modularity and test coverage.

Word segmentation and Thai language improvements:

• Updated Thai (th-TH) segmentation to use soft hyphens (\u00AD) instead of spaces, improving the accuracy of word breaks and ensuring better compatibility with spell checking and downstream processing. [1] [2] [3]
• Added the @cspell/dict-th-th package to dependencies, enabling Thai dictionary support.
• Adjusted tests and expectations for Thai segmentation to reflect the use of soft hyphens and to ensure no false positives in validation.

Word splitting and symbol handling enhancements:

• Introduced a new generateWordBreaks utility that generates all possible word breaks in a string, including camelCase, symbols, numbers, and soft hyphens. Includes comprehensive tests and snapshot coverage for various edge cases. [1] [2] [3] [4]
• Improved regular expressions for word splitting to support soft hyphens and better handle punctuation and symbols.

Refactoring and code organization:

• Refactored imports to use the new wordSplitter/index.js entry point, improving modularity and future maintainability. [1] [2]
• Added explicit exports for split, SplitOptions, and SplitResult in wordSplitter/index.ts to clarify and centralize the public API.

Other enhancements:

• Exposed the softHyphen constant for consistent use throughout the codebase. [1] [2]

---

Dictionary Updates

fix: Workflow Bot -- Update Dictionaries (main) (#​9143)

fix: Workflow Bot -- Update Dictionaries (main) (#​9143)

---

Configuration

📅 Schedule: (UTC)

• Branch creation
  • At any time (no schedule defined)
• Automerge
  • At any time (no schedule defined)

🚦 Automerge: Enabled.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (64b7a78) to head (cdfb244).

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #366   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines            5         5           
  Branches         3         3           
=========================================
  Hits             5         5           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.