Releases: streetsidesoftware/cspell
v8.10.4
v8.10.3
v8.10.2
v8.10.1
v8.10.0
Changes
Features
feat: Add glob support for URLs (#5824)
feat: Add glob support for URLs (#5824)
It is possible to use CSpell in an environment where all the files being spell checked exist behind a virtual URL, something like: vscode-vfs://github/microsoft/vscode/extensions/csharp/README.md
.
The challenge here is to make the glob system URL aware.
Fixes
fix: Make sure case sensitive trace works as expected. (#5806)
fix: Make sure case sensitive trace works as expected. (#5806)
- Fix case sensitive tracing.
- Display preferred corrections when they are available.
![image](https://private-user-images.githubusercontent.com/3740137/342439505-a202256f-0593-405d-8c03-40c574f66083.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjA2NzQ5NTgsIm5iZiI6MTcyMDY3NDY1OCwicGF0aCI6Ii8zNzQwMTM3LzM0MjQzOTUwNS1hMjAyMjU2Zi0wNTkzLTQwNWQtOGMwMy00MGM1NzRmNjYwODMucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDcxMSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA3MTFUMDUxMDU4WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9MTczOTRiM2U0NTM0ODc1MWYwMTk5NjY4YzJkODJkMmNmMDQyOTUyNjNlOTFiMjcxMzZmM2JlZDkyOGUyZDRkZSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.K8rgNiSWHUOjV3eCoZ3zd8XegjbxUoyMsIEgayTjHiE)
fix: resolve imports from ESLint plugin (#5790)
fix: resolve imports from ESLint plugin (#5790)
fixes #5789
fix: `suggestWords` dict schema validation (#5786)
fix: suggestWords
dict schema validation (#5786)
- Inline dictionaries with only suggested words did not pass validation.
- Clean up the type docs a bit.
- Make sure there are not any ZeroWidthSpaces in the schema.
Dictionary Updates
fix: Workflow Bot -- Update Dictionaries (main) (#5849)
fix: Workflow Bot -- Update Dictionaries (main) (#5849)
Update Dictionaries (main)
Summary
.../snapshots/MicrosoftDocs/PowerShell-Docs/report.yaml | 3 +--
.../snapshots/MicrosoftDocs/PowerShell-Docs/snapshot.txt | 3 +--
packages/cspell-bundled-dicts/package.json | 2 +-
pnpm-lock.yaml | 10 +++++-----
4 files changed, 8 insertions(+), 10 deletions(-)
fix: Workflow Bot -- Update Dictionaries (main) (#5800)
fix: Workflow Bot -- Update Dictionaries (main) (#5800)
Update Dictionaries (main)
Summary
packages/cspell-bundled-dicts/package.json | 2 +-
pnpm-lock.yaml | 10 +++++-----
2 files changed, 6 insertions(+), 6 deletions(-)
fix: Workflow Bot -- Update Dictionaries (main) (#5783)
fix: Workflow Bot -- Update Dictionaries (main) (#5783)
Update Dictionaries (main)
Summary
.../snapshots/ktaranov/sqlserver-kit/report.yaml | 5 +++--
.../snapshots/ktaranov/sqlserver-kit/snapshot.txt | 3 ++-
packages/cspell-bundled-dicts/package.json | 6 +++---
pnpm-lock.yaml | 25 +++++++++++++---------
4 files changed, 23 insertions(+), 16 deletions(-)
Documentation
v8.9.1
v8.9.0-alpha.0
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
v8.9.0
Changes
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
docs: Extract Markdown from cspell.schema.json (#5722)
docs: Extract Markdown from cspell.schema.json (#5722)
Extract Markdown from Schema file
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
v8.8.4
Changes
Fixes
Dictionary Updates
fix: Workflow Bot -- Update Dictionaries (main) (#5696)
fix: Workflow Bot -- Update Dictionaries (main) (#5696)
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) (#5689)
fix: Workflow Bot -- Update Dictionaries (main) (#5689)
Update Dictionaries (main)
Summary
.../snapshots/wireapp/wire-webapp/report.yaml | 4 +---
.../snapshots/wireapp/wire-webapp/snapshot.txt | 4 +---
packages/cspell-bundled-dicts/package.json | 4 ++--
pnpm-lock.yaml | 17 +++++++++++------
4 files changed, 15 insertions(+), 14 deletions(-)
fix: Workflow Bot -- Update Dictionaries (main) (#5682)
fix: Workflow Bot -- Update Dictionaries (main) (#5682)
Update Dictionaries (main)
Summary
packages/cspell-bundled-dicts/package.json | 6 +++---
pnpm-lock.yaml | 24 ++++++++++++------------
2 files changed, 15 insertions(+), 15 deletions(-)
fix: Workflow Bot -- Update Dictionaries (main) (#5675)
fix: Workflow Bot -- Update Dictionaries (main) (#5675)
Update Dictionaries (main)
Summary
.../snapshots/Azure/azure-rest-api-specs/report.yaml | 3 +--
.../snapshots/Azure/azure-rest-api-specs/snapshot.txt | 3 +--
integration-tests/snapshots/mdx-js/mdx/report.yaml | 5 ++---
integration-tests/snapshots/mdx-js/mdx/snapshot.txt | 3 +--
integration-tests/snapshots/php/php-src/report.yaml | 3 +--
integration-tests/snapshots/php/php-src/snapshot.txt | 3 +--
integration-tests/snapshots/sveltejs/svelte/report.yaml | 4 +---
.../snapshots/sveltejs/svelte/snapshot.txt | 4 +---
packages/cspell-bundled-dicts/package.json | 4 ++--
pnpm-lock.yaml | 17 +++++++++++------
10 files changed, 22 insertions(+), 27 deletions(-)
fix: Workflow Bot -- Update Dictionaries (main) (#5669)
fix: Workflow Bot -- Update Dictionaries (main) (#5669)
Update Dictionaries (main)
Summary
.../MicrosoftDocs/PowerShell-Docs/report.yaml | 3 +-
.../MicrosoftDocs/PowerShell-Docs/snapshot.txt | 3 +-
.../snapshots/TheAlgorithms/Python/report.yaml | 3 +-
.../snapshots/TheAlgorithms/Python/snapshot.txt | 3 +-
.../googleapis/google-cloud-cpp/report.yaml | 7 +---
.../googleapis/google-cloud-cpp/snapshot.txt | 5 +--
.../snapshots/ktaranov/sqlserver-kit/report.yaml | 3 +-
.../snapshots/ktaranov/sqlserver-kit/snapshot.txt | 3 +-
.../snapshots/sveltejs/svelte/report.yaml | 3 +-
.../snapshots/sveltejs/svelte/snapshot.txt | 3 +-
packages/cspell-bundled-dicts/package.json | 12 +++---
pnpm-lock.yaml | 49 ++++++++++++----------
12 files changed, 44 insertions(+), 53 deletions(-)
v8.8.3
Changes
Fixes
fix: Make sure `files` globs are normalized. (#5665)
fix: Make sure files
globs are normalized. (#5665)
Dictionary Updates
fix: Workflow Bot -- Update Dictionaries (main) (#5664)
fix: Workflow Bot -- Update Dictionaries (main) (#5664)
Update Dictionaries (main)
Summary
.../snapshots/TheAlgorithms/Python/report.yaml | 3 +-
.../snapshots/TheAlgorithms/Python/snapshot.txt | 3 +-
.../snapshots/django/django/report.yaml | 4 +--
.../snapshots/django/django/snapshot.txt | 3 +-
.../snapshots/php/php-src/report.yaml | 3 +-
.../snapshots/php/php-src/snapshot.txt | 3 +-
packages/cspell-bundled-dicts/package.json | 8 +++---
pnpm-lock.yaml | 33 +++++++++++++---------
8 files changed, 29 insertions(+), 31 deletions(-)