chore: Prepare Release v10.3.1 (auto-deploy) - #9214
Merged
Merged
Conversation
github-actions
Bot
force-pushed
the
release-draft
branch
from
September 12, 2026 14:08
46f6d23 to
9e87b91
Compare
github-actions
Bot
force-pushed
the
release-draft
branch
3 times, most recently
from
September 12, 2026 16:14
f6b3ef6 to
fc93af6
Compare
github-actions
Bot
force-pushed
the
release-draft
branch
16 times, most recently
from
September 13, 2026 07:17
bb91619 to
a76d9c7
Compare
github-actions
Bot
force-pushed
the
release-draft
branch
from
September 13, 2026 07:29
a76d9c7 to
aeae05a
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Release v10.3.1
Release Notes
Details
Fixes
fix: Update documentation and schema for recent improvements (#9222)
fix: Update documentation and schema for recent improvements (#9222)
This pull request updates documentation and default values in both the
cspell.schema.jsonand TypeScript type definitions to improve clarity and accuracy. The main changes include updating the default cache strategy, fixing typos and grammatical errors, and clarifying descriptions for several configuration options.Configuration behavior changes:
cacheStrategyis now"content"instead of"metadata", and the descriptions have been updated accordingly in both the schema and type definitions. [1] [2] [3]Documentation and description improvements:
useIntlWordSegmentation,enableFiletypes,globRoot, andlanguageIdacross both the schema and type definitions. These changes ensure consistency and make the documentation easier to understand. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]No functional code changes were made; all updates are to documentation, default values, and descriptions to improve developer experience and reduce ambiguity.
fix: Add support for soft word breaks (#9215)
fix: Add support for soft word breaks (#9215)
This pull request introduces support for "soft word breaks" in CSpell, allowing users to define custom rules for segmenting compound words (such as splitting
fnptrvalueintofnptr+value) to improve spell checking accuracy. The main changes include implementing the new text transformer, integrating it into the document validation pipeline, and updating related utilities and tests.Soft Word Breaks Feature:
SoftWordBreakTextTransformerand thecreateSoftWordBreakTextTransformerfactory function to apply user-configurable soft word break rules based on patterns or regular expressions. (WordBreakTextTransformer.ts,Transformer.ts,index.ts) [1] [2] [3]DocumentValidatorso that, if enabled in user settings, documents are preprocessed to insert soft hyphens at defined break points before spell checking. (docValidator.ts) [1] [2]Testing and Validation:
WordBreakTextTransformer.test.ts,docValidator.test.ts) [1] [2]Utility and Refactoring:
stringToRegExpOrUndefinedas a safer version ofstringToRegExpfor parsing regex patterns, and refactored codebase to use it where appropriate. (patterns.ts,textRegex.ts,text.ts,textRegex.test.ts) [1] [2] [3] [4] [5] [6]softHyphenconstant toTransformer.tsfor shared use and updated imports accordingly. (IntlSegmentTextTransformer.ts,IntlSegmentTextTransformer.test.ts,Transformer.ts) [1] [2] [3]These changes collectively add a flexible mechanism for advanced word segmentation, improving the accuracy of spell checking for compound identifiers and domain-specific terms.
fix(cspell-tools): Support multiple replacements in a single entry (#9212)
fix(cspell-tools): Support multiple replacements in a single entry (#9212)
This pull request enhances the
cspell-tools.config.schema.jsonschema file by addingmarkdownDescriptionfields alongside existingdescriptionfields throughout the schema. This improves support for tools and editors that render markdown-formatted descriptions, making configuration options clearer and more readable. Additionally, the schema for replacements has been refactored for clarity and extensibility.The most important changes are:
Documentation Improvements:
markdownDescriptionfields to nearly all properties and definitions, providing markdown-formatted explanations for better editor and tool integration. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]Schema Structure Improvements:
Replacementsdefinition: introduced aReplaceWithtype, addedpropertyNameswith descriptions, and enhanced the overall documentation and structure for replacement rules.These changes collectively improve the developer experience when working with the schema in modern editors and tooling.
fix: CSpell-Tools support replacements (#9205)
fix: CSpell-Tools support replacements (#9205)
Support replacing word fragments before adding the word to the dictionary.
TL;DR
Be able to replace
’with'.Details
This pull request adds support for applying word replacement rules during dictionary compilation in
cspell-tools. The main change is the introduction of areplacementsoption, allowing users to specify patterns and their replacements, which are then applied to all words in the dictionary. The changes include updates to the configuration schema, TypeScript interfaces, core compilation logic, and tests to support and verify this new feature.Add support for word replacements in dictionary compilation:
Configuration and Schema Updates:
Replacementsdefinition and areplacementsproperty to the JSON schema and TypeScript interfaces, allowing users to specify replacement rules in config files and programmatic interfaces. [1] [2] [3] [4]Compiler Logic Enhancements:
compile.ts,wordListParser.ts) to accept and apply thereplacementsoption, mapping specified patterns to their replacements during normalization of dictionary words. [1] [2] [3]Testing and Fixtures:
rep-words.txt) and snapshot updates. [1] [2] [3] [4] [5] [6] [7]Type and Interface Adjustments:
CompileOptions,CompileRequest, etc.) to include or omit the newreplacementsproperty as appropriate, ensuring type safety and clarity throughout the codebase. [1] [2]These changes collectively enable more flexible and accurate dictionary generation by allowing systematic normalization or correction of word forms via configurable replacement rules.
fix: Revert #9198 (#9202)
fix: Revert #9198 (#9202)
fix: Add definitions for custom word breaks (#9199)
fix: Add definitions for custom word breaks (#9199)
This pull request introduces support for customizable "soft word break" rules in both the JSON schema (
cspell.schema.json) and the TypeScript types (packages/cspell-types/api/index.d.mts). These changes allow users to define and enable/disable advanced word segmentation behaviors, improving spell checking for languages and naming patterns that aren't well handled by default camel case detection.The most important changes are:
Schema and Configuration Enhancements:
softWordBreakDefinitionsandsoftWordBreaksto the JSON schema, allowing users to define and control custom soft word break rules for text segmentation. These rules help split words at specific positions (like between "error" and "code" in "errorcode") and support advanced language scenarios. [1] [2] [3]SoftWordBreak,SoftWordBreakDefinitions,SoftWordBreakPattern,SoftWordBreakRegExpString,SoftWordBreakRule, andSoftWordBreaks, with detailed descriptions and usage examples for each.TypeScript API Updates:
WordSegmentationSettingsinterface, which includessoftWordBreakDefinitions,softWordBreaks, anduseIntlWordSegmentationoptions, providing a type-safe way to configure segmentation rules in code.WordSegmentationSettingsinto the mainBaseSettinginterface, ensuring all configuration objects can use the new word break features.BaseSettinginterface by removing the now redundantuseIntlWordSegmentationproperty (since it's included inWordSegmentationSettings).These changes make the spell checker more flexible and powerful, especially for users working with languages or code styles that require custom word splitting logic.
fix: Split words on soft hyphens (#9196)
fix: Split words on soft hyphens (#9196)
This pull request enhances the word splitting utilities in the
cspell-libpackage, particularly improving how camelCase and compound words are split, especially when soft hyphens are present. It also introduces and tests new utility functions that return word segments along with their offsets, and refactors the implementation for better accuracy and maintainability.Key changes:
Feature enhancements and bug fixes
regExpCamelCaseWordBreaksWithEnglishSuffixto handle soft hyphens (\u00AD), ensuring words like'hello\u00ADthere'are split correctly.splitWordWithOffsetto compute word splits and their offsets more accurately, replacing the previous use ofscanMapwith a custom implementation.splitCamelCaseWordWithOffsetto use the newsplitWordWithOffsetimplementation, improving consistency and correctness.Testing improvements
splitCamelCaseWordWithOffsetandsplitWordWithOffset, covering a variety of word forms, including those with soft hyphens and mixed casing.Dependency and import updates
text.test.tsto include the new or modified regular expressions used for word splitting.Dictionary Updates
fix: Workflow Bot -- Update Dictionaries (main) (#9218)
fix: Workflow Bot -- Update Dictionaries (main) (#9218)
Update Dictionaries (main)
Summary
fix: Workflow Bot -- Update Dictionaries (main) (#9208)
fix: Workflow Bot -- Update Dictionaries (main) (#9208)
Update Dictionaries (main)
Summary
fix: Workflow Bot -- Update Dictionaries (main) (#9198)
fix: Workflow Bot -- Update Dictionaries (main) (#9198)
Update Dictionaries (main)
Summary
Version Information
v10.3.110.3.1Summary