streetsidesoftware/cspell v10.3.1-alpha.1

on GitHub

fix(cspell-tools): Support multiple replacements in a single entry (#9212)

This pull request enhances the cspell-tools.config.schema.json schema file by adding markdownDescription fields alongside existing description fields 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:

• Added markdownDescription fields 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:

• Refactored the Replacements definition: introduced a ReplaceWith type, added propertyNames with 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.