Changes
docs: Extract Markdown from cspell.schema.json (#5722)
docs: Extract Markdown from cspell.schema.json (#5722)
Extract Markdown from Schema file
Features
feat: Support spell checking more document types (#5741)
feat: Support spell checking more document types (#5741)
fixes #5740
Checking Custom AST Nodes
The checkScope
setting is used to enable / disable checking AST Nodes. Parsers are used to generate the AST (Abstract Syntax Tree) used by ESLint to evaluate a document. Each PlugIn gets access to the AST. checkScope
can be used to handle new AST node when a custom parser is added.
rules: {
'@cspell/spellchecker': ['warn', { checkScope: [
['JSONLiteral': true], // will match AST Nodes of type `JSONLiteral` and spell check the value.
['JSONProperty[key] JSONLiteral', false] // will turn off checking the JSON Property keys.
['JSONProperty JSONLiteral', false] // will turn off checking the JSON Property keys and values.
['JSONProperty[value] JSONLiteral', true] // will turn on checking the JSON Property values.
['YAMLPair[key] YAMLScalar', true],
['YAMLPair[value] YAMLScalar', true],
['YAMLSequence YAMLScalar', true],
] }],
},
New Options
/**
* Scope selectors to spell check.
* This is a list of scope selectors to spell check.
*
* Example:
* ```js
* checkScope: [
* ['YAMLPair[key] YAMLScalar', true],
* ['YAMLPair[value] YAMLScalar', true],
* ['YAMLSequence[entries] YAMLScalar', true],
* ['JSONProperty[key] JSONLiteral', true],
* ['JSONProperty[value] JSONLiteral', true],
* ['JSONArrayExpression JSONLiteral', true],
* ],
* ```
*
* To turn off checking JSON keys, use the following:
*
* ```js
* checkScope: [
* ['JSONProperty[key] JSONLiteral', false],
* ],
* ```
*
* @since 8.9.0
*/
checkScope?: ScopeSelectorList;
feat: Add library `@cspell/url` (#5720)
feat: Add library @cspell/url
(#5720)
Move URL methods into a common library.
Fixes
Dictionary Updates
fix: Workflow Bot -- Update Dictionaries (main) (#5762)
fix: Workflow Bot -- Update Dictionaries (main) (#5762)
Update Dictionaries (main)
Summary
.../SoftwareBrothers/admin-bro/report.yaml | 7 +++---
.../SoftwareBrothers/admin-bro/snapshot.txt | 3 ++-
.../apollographql/apollo-server/report.yaml | 7 +++---
.../apollographql/apollo-server/snapshot.txt | 5 +++--
.../microsoft/TypeScript-Website/report.yaml | 3 ++-
.../microsoft/TypeScript-Website/snapshot.txt | 3 ++-
.../snapshots/prettier/prettier/report.yaml | 7 +++---
.../snapshots/prettier/prettier/snapshot.txt | 5 +++--
packages/cspell-bundled-dicts/package.json | 6 ++---
pnpm-lock.yaml | 26 +++++++++++++++-------
10 files changed, 45 insertions(+), 27 deletions(-)
fix: Workflow Bot -- Update Dictionaries (main) (#5755)
fix: Workflow Bot -- Update Dictionaries (main) (#5755)
Update Dictionaries (main)
Summary
packages/cspell-bundled-dicts/package.json | 2 +-
pnpm-lock.yaml | 8 ++++----
2 files changed, 5 insertions(+), 5 deletions(-)
fix: Workflow Bot -- Update Dictionaries (main) (#5716)
fix: Workflow Bot -- Update Dictionaries (main) (#5716)
Update Dictionaries (main)
Summary
.../MartinThoma/LaTeX-examples/report.yaml | 3 +-
.../MartinThoma/LaTeX-examples/snapshot.txt | 3 +-
.../aspnetboilerplate/report.yaml | 3 +-
.../aspnetboilerplate/snapshot.txt | 3 +-
.../snapshots/django/django/report.yaml | 4 +--
.../snapshots/django/django/snapshot.txt | 3 +-
.../snapshots/eslint/eslint/report.yaml | 6 ++--
.../snapshots/eslint/eslint/snapshot.txt | 3 +-
.../snapshots/gitbucket/gitbucket/report.yaml | 2 +-
.../snapshots/gitbucket/gitbucket/snapshot.txt | 2 +-
.../googleapis/google-cloud-cpp/report.yaml | 4 +--
.../googleapis/google-cloud-cpp/snapshot.txt | 4 +--
.../iluwatar/java-design-patterns/report.yaml | 6 ++--
.../iluwatar/java-design-patterns/snapshot.txt | 4 +--
.../snapshots/ktaranov/sqlserver-kit/report.yaml | 8 ++----
.../snapshots/ktaranov/sqlserver-kit/snapshot.txt | 6 +---
.../microsoft/TypeScript-Website/report.yaml | 3 +-
.../microsoft/TypeScript-Website/snapshot.txt | 5 ++--
.../snapshots/php/php-src/report.yaml | 4 +--
.../snapshots/php/php-src/snapshot.txt | 4 +--
.../snapshots/sveltejs/svelte/report.yaml | 3 +-
.../snapshots/sveltejs/svelte/snapshot.txt | 3 +-
packages/cspell-bundled-dicts/package.json | 8 +++---
pnpm-lock.yaml | 33 +++++++++++++---------
24 files changed, 49 insertions(+), 78 deletions(-)
fix: Workflow Bot -- Update Dictionaries (main) (#5711)
fix: Workflow Bot -- Update Dictionaries (main) (#5711)
Update Dictionaries (main)
Summary
.../Azure/azure-rest-api-specs/report.yaml | 8 +--
.../Azure/azure-rest-api-specs/snapshot.txt | 6 +-
.../snapshots/RustPython/RustPython/report.yaml | 12 +---
.../snapshots/RustPython/RustPython/snapshot.txt | 10 +--
.../snapshots/TheAlgorithms/Python/report.yaml | 16 +----
.../snapshots/TheAlgorithms/Python/snapshot.txt | 14 +---
.../snapshots/django/django/report.yaml | 78 +++-------------------
.../snapshots/django/django/snapshot.txt | 34 +---------
.../googleapis/google-cloud-cpp/report.yaml | 14 ++--
.../googleapis/google-cloud-cpp/snapshot.txt | 6 +-
.../snapshots/pycontribs/jira/report.yaml | 2 +-
.../snapshots/pycontribs/jira/snapshot.txt | 2 +-
.../snapshots/sveltejs/svelte/report.yaml | 3 +-
.../snapshots/sveltejs/svelte/snapshot.txt | 3 +-
packages/cspell-bundled-dicts/package.json | 4 +-
.../cspell/src/app/__snapshots__/app.test.ts.snap | 6 +-
pnpm-lock.yaml | 24 +++++--
17 files changed, 62 insertions(+), 180 deletions(-)
Documentation
fix: Workflow Bot -- Update Dictionaries (main) (#5762)
fix: Workflow Bot -- Update Dictionaries (main) (#5762)
Update Dictionaries (main)
Summary
.../SoftwareBrothers/admin-bro/report.yaml | 7 +++---
.../SoftwareBrothers/admin-bro/snapshot.txt | 3 ++-
.../apollographql/apollo-server/report.yaml | 7 +++---
.../apollographql/apollo-server/snapshot.txt | 5 +++--
.../microsoft/TypeScript-Website/report.yaml | 3 ++-
.../microsoft/TypeScript-Website/snapshot.txt | 3 ++-
.../snapshots/prettier/prettier/report.yaml | 7 +++---
.../snapshots/prettier/prettier/snapshot.txt | 5 +++--
packages/cspell-bundled-dicts/package.json | 6 ++---
pnpm-lock.yaml | 26 +++++++++++++++-------
10 files changed, 45 insertions(+), 27 deletions(-)
docs: Use `inject` template function (#5754)
docs: Use inject
template function (#5754)
Create an inject
template function to help with keeping indention consistant.
Co-authored-by: Felix Moeser amanoji@users.noreply.github.com