cspell-config
A library to assist reading and writing CSpell configuration files.
Install
npm install -S cspell-config
CSpell Config library
cspell-config
A library to assist reading and writing CSpell configuration files.
npm install -S cspell-config
All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.
.../snapshots/graphql/graphql-spec/report.yaml | 108 ++++++++++-----------
.../snapshots/wireapp/wire-desktop/report.yaml | 2 +-
packages/cspell-bundled-dicts/package.json | 8 +-
packages/cspell/src/__snapshots__/app.test.ts.snap | 15 +--
pnpm-lock.yaml | 44 +++++----
5 files changed, 95 insertions(+), 82 deletions(-)
---
packages/cspell-bundled-dicts/package.json | 8 ++--
packages/cspell/src/__snapshots__/app.test.ts.snap | 22 +++++-----
pnpm-lock.yaml | 47 ++++++++++++----------
3 files changed, 41 insertions(+), 36 deletions(-)
---
packages/cspell-bundled-dicts/package.json | 2 +-
pnpm-lock.yaml | 11 ++++++++---
2 files changed, 9 insertions(+), 4 deletions(-)
---
.../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 | 10 ++--
pnpm-lock.yaml | 57 ++++++++++++----------
6 files changed, 40 insertions(+), 40 deletions(-)
---
.../snapshots/TheAlgorithms/Python/report.yaml | 3 +-
.../snapshots/TheAlgorithms/Python/snapshot.txt | 3 +-
packages/cspell-bundled-dicts/package.json | 2 +-
pnpm-lock.yaml | 162 ++++++++++-----------
4 files changed, 84 insertions(+), 86 deletions(-)
---
integration-tests/snapshots/mdx-js/mdx/report.yaml | 3 +--
.../snapshots/mdx-js/mdx/snapshot.txt | 3 +--
.../snapshots/vitest-dev/vitest/report.yaml | 6 +-----
.../snapshots/vitest-dev/vitest/snapshot.txt | 4 +---
packages/cspell-bundled-dicts/package.json | 4 ++--
pnpm-lock.yaml | 24 +++++++++++-----------
6 files changed, 18 insertions(+), 26 deletions(-)
---
packages/cspell-bundled-dicts/package.json | 6 ++---
pnpm-lock.yaml | 36 +++++++++++++++---------------
2 files changed, 21 insertions(+), 21 deletions(-)
---
packages/cspell-bundled-dicts/package.json | 6 ++---
pnpm-lock.yaml | 36 +++++++++++++++---------------
2 files changed, 21 insertions(+), 21 deletions(-)
---
flat-cache
dependency (#7636)</summary>
### fix: Remove flat-cache
dependency (#7636)
flat-cache
v6 is not compatible with the cspell cache. Since flat-cache
was mostly a pass through to flatted
, it was better to just replace it.
---
file-entry-cache
breaks the spell checker and bloats the cache size.
This PR is the first step in reducing the dependency upon file-entry-cache and its dependencies.
---
integration-tests/snapshots/vitest-dev/vitest/report.yaml | 10 ++--------
integration-tests/snapshots/vitest-dev/vitest/snapshot.txt | 5 +----
packages/cspell-bundled-dicts/package.json | 2 +-
pnpm-lock.yaml | 12 ++++++------
4 files changed, 10 insertions(+), 19 deletions(-)
---
simple
. The code worked because of the assumption that hasSimpleSuggestions
would be true if hasPreferredSuggestions
was true.
---
packages/cspell-bundled-dicts/package.json | 116 ++---
pnpm-lock.yaml | 706 +++++++++++++++--------------
2 files changed, 432 insertions(+), 390 deletions(-)
---
packages/cspell-bundled-dicts/package.json | 4 ++--
pnpm-lock.yaml | 24 ++++++++++++------------
2 files changed, 14 insertions(+), 14 deletions(-)
---
packages/cspell-bundled-dicts/package.json | 2 +-
pnpm-lock.yaml | 12 ++++++------
2 files changed, 7 insertions(+), 7 deletions(-)
---
packages/cspell-bundled-dicts/package.json | 2 +-
pnpm-lock.yaml | 12 ++++++------
2 files changed, 7 insertions(+), 7 deletions(-)
---
.../snapshots/flutter/samples/report.yaml | 4 +--
.../snapshots/flutter/samples/snapshot.txt | 7 ++---
packages/cspell-bundled-dicts/package.json | 6 ++--
pnpm-lock.yaml | 33 +++++++++++++---------
4 files changed, 26 insertions(+), 24 deletions(-)
---
integration-tests/snapshots/mdx-js/mdx/report.yaml | 46 ++--------------------
.../snapshots/mdx-js/mdx/snapshot.txt | 43 +-------------------
packages/cspell-bundled-dicts/package.json | 8 ++--
pnpm-lock.yaml | 45 +++++++++++----------
4 files changed, 33 insertions(+), 109 deletions(-)
---
packages/cspell-bundled-dicts/package.json | 4 ++--
pnpm-lock.yaml | 24 ++++++++++++------------
2 files changed, 14 insertions(+), 14 deletions(-)
---
dictionaries
(#7445)</summary>
### feat: Add command dictionaries
(#7445)
Add new dictionaries
command to the cli
Usage: cspell dictionaries [options]
List dictionaries
Options:
-c, --config <cspell.json> Configuration file to use. By default cspell
looks for cspell.json in the current directory.
--path-format <format> Configure how to display the dictionary path.
(choices: "hide", "short", "long", "full",
default: Display most of the path.)
--color Force color.
--no-color Turn off color.
--no-default-configuration Do not load the default configuration and
dictionaries.
-h, --help display help for command
---
--dictionary
(#7441)</summary>
### feat: Add lint option --dictionary
(#7441)
Add lint options:
- --dictionary
- enable a dictionary by name
- --disable-dictionary
- disable a dictionary by name
---
Usage: cspell init [options]
Initialize a CSpell configuration file.
Options:
-o, --output <path> Define where to write file.
--format <format> Define the format of the file. (choices: "yaml",
"yml", "json", "jsonc", default: "yaml")
--import <path|package> Import a configuration file or dictionary package.
--locale <locale> Define the locale to use when spell checking (e.g.,
en, en-US, de).
--dictionary <dictionary> Enable a dictionary.
--no-comments Do not add comments to the config file.
--no-schema Do not add the schema reference to the config file.
-h, --help display help for command
---
--report
Option: --report
Choices:
- all
- report everything (default)
- simple
- only report issues with simple fixes.
- typos
- only report issues with common typos.
- flagged
- only report flagged issues.
## Reporters - add opt-in feature flag
To support legacy reporters, it is necessary to check if they support new features.
Features:
ts
/**
* Allows the reporter to advertise which features it supports.
*/
interface FeaturesSupportedByReporter {
/**
* The reporter supports the {@link ReportingConfiguration.unknownWords} option and understands
* how to filter issues based upon {@link Issue.isFlagged}, {@link Issue.hasSimpleSuggestions} and {@link Issue.hasPreferredSuggestions}.
* - `true` - The `reporter.issue` method will be called for all spelling issues and it is expected to handle .
* - `false | undefined` - the unknown words will be filtered out based upon the `unknownWords` setting before being passed to the reporter.
*/
unknownWords?: boolean | undefined;
/**
* The reporter supports the {@link Issue.issueType} option.
* - `true` - the reporter will be called with all issues types.
* - `false | undefined` - only {@link IssueType.spelling} issues will be passed to the reporter.
*/
issueType?: boolean | undefined;
}
---
--config-search
option (#7479)</summary>
### fix: Hide --config-search
option (#7479)
---
isolatedDeclarations: true
(#7459)</summary>
### refactor: isolatedDeclarations: true
(#7459)
---
--continue-on-error Continue processing files even if there is a configuration error.
---
--enabled Show only enabled dictionaries.
--no-enabled Do not show enabled dictionaries.
--locale <locale> Set language locales. i.e. "en,fr" for English and
French, or "en-GB" for British English.
--file-type <fileType> File type to use. i.e. "html", "golang", or
"javascript".
--no-show-location Do not show the location of the dictionary.
--show-file-types Show the file types supported by the dictionary.
(default: false)
--show-locales Show the language locales supported by the
dictionary. (default: false)
---
--dictionary
(#7443)</summary>
### fix: Add trace option --dictionary
(#7443)
Usage: cspell trace [options] [words...]
Options:
--dictionary <name> Enable a dictionary by name. Can be used multiple
times.
---
-c, --config <path> Path to the CSpell configuration file. Conflicts
with --output and --format.
--remove-comments Remove all comments from the config file.
--stdout Write the configuration to stdout instead of a
file.
Help:
Usage: cspell init [options]
Initialize a CSpell configuration file.
Options:
-c, --config <path> Path to the CSpell configuration file. Conflicts
with --output and --format.
-o, --output <path> Define where to write file.
--format <format> Define the format of the file. (choices: "yaml",
"yml", "json", "jsonc", default: "yaml")
--import <path|package> Import a configuration file or dictionary package.
--locale <locale> Define the locale to use when spell checking (e.g.,
en, en-US, de).
--dictionary <dictionary> Enable a dictionary. Can be used multiple times.
--no-comments Do not add comments to the config file.
--remove-comments Remove all comments from the config file.
--no-schema Do not add the schema reference to the config file.
--stdout Write the configuration to stdout instead of a
file.
-h, --help display help for command
---
cspell.config.yml
files (#7432)</summary>
### fix: Allow init of cspell.config.yml
files (#7432)
Add yml
to the init command format list.
cspell init --format=yml
It will create a cspell.config.yml
file.
---
packages/cspell-bundled-dicts/package.json | 2 +-
.../cspell/src/app/__snapshots__/app.test.ts.snap | 30 +++++++++++-----------
pnpm-lock.yaml | 12 ++++-----
3 files changed, 22 insertions(+), 22 deletions(-)
---
.../snapshots/AdaDoom3/AdaDoom3/report.yaml | 1994 ++--
.../Azure/azure-rest-api-specs/report.yaml | 18 +-
.../MartinThoma/LaTeX-examples/report.yaml | 616 +-
.../MicrosoftDocs/PowerShell-Docs/report.yaml | 236 +-
.../snapshots/RustPython/RustPython/report.yaml | 442 +-
.../SoftwareBrothers/admin-bro/report.yaml | 2 +-
.../snapshots/TheAlgorithms/Python/report.yaml | 178 +-
.../snapshots/alexiosc/megistos/report.yaml | 1292 +--
.../aspnetboilerplate/report.yaml | 244 +-
.../snapshots/aws-amplify/docs/report.yaml | 14 +-
.../snapshots/caddyserver/caddy/report.yaml | 36 +-
.../snapshots/dart-lang/sdk/report.yaml | 498 +-
.../snapshots/django/django/report.yaml | 1318 +--
.../snapshots/eslint/eslint/report.yaml | 76 +-
.../snapshots/flutter/samples/report.yaml | 10744 +++++++++----------
.../snapshots/gitbucket/gitbucket/report.yaml | 8 +-
.../googleapis/google-cloud-cpp/report.yaml | 114 +-
.../iluwatar/java-design-patterns/report.yaml | 52 +-
.../snapshots/ktaranov/sqlserver-kit/report.yaml | 7542 ++++++-------
.../snapshots/liriliri/licia/report.yaml | 148 +-
integration-tests/snapshots/mdx-js/mdx/report.yaml | 58 +-
.../microsoft/TypeScript-Website/report.yaml | 98 +-
.../snapshots/neovim/nvim-lspconfig/report.yaml | 844 +-
.../snapshots/pagekit/pagekit/report.yaml | 17 +-
.../snapshots/pagekit/pagekit/snapshot.txt | 3 +-
.../snapshots/php/php-src/report.yaml | 4260 ++++----
.../snapshots/pycontribs/jira/report.yaml | 4 +-
.../snapshots/slint-ui/slint/report.yaml | 518 +-
.../snapshots/sveltejs/svelte/report.yaml | 2548 ++---
.../typescript-cheatsheets/react/report.yaml | 6 +-
.../snapshots/vitest-dev/vitest/report.yaml | 62 +-
.../snapshots/wireapp/wire-webapp/report.yaml | 994 +-
packages/cspell-bundled-dicts/package.json | 8 +-
.../__snapshots__/validator.test.ts.snap | 4 +-
.../cspell/src/app/__snapshots__/app.test.ts.snap | 96 +-
pnpm-lock.yaml | 52 +-
36 files changed, 17573 insertions(+), 17571 deletions(-)
---
.../MicrosoftDocs/PowerShell-Docs/report.yaml | 3 +-
.../MicrosoftDocs/PowerShell-Docs/snapshot.txt | 3 +-
.../snapshots/ktaranov/sqlserver-kit/report.yaml | 10 +--
.../snapshots/ktaranov/sqlserver-kit/snapshot.txt | 9 +--
.../microsoft/TypeScript-Website/report.yaml | 6 +-
.../microsoft/TypeScript-Website/snapshot.txt | 4 +-
.../snapshots/neovim/nvim-lspconfig/report.yaml | 5 +-
.../snapshots/neovim/nvim-lspconfig/snapshot.txt | 3 +-
.../webdeveric/webpack-assets-manifest/report.yaml | 7 +-
.../webpack-assets-manifest/snapshot.txt | 5 +-
packages/cspell-bundled-dicts/package.json | 16 ++--
.../cspell/src/app/__snapshots__/app.test.ts.snap | 30 +++----
pnpm-lock.yaml | 93 ++++++++++++----------
13 files changed, 95 insertions(+), 99 deletions(-)
---
defineCSpellPluginOptions
- defineCSpellConfig
Add some examples for supportNonStrictSearches
---
packages/cspell-bundled-dicts/package.json | 4 ++--
pnpm-lock.yaml | 24 ++++++++++++------------
2 files changed, 14 insertions(+), 14 deletions(-)
---
.../snapshots/dart-lang/sdk/report.yaml | 10 ++-----
.../snapshots/dart-lang/sdk/snapshot.txt | 4 +--
.../snapshots/ktaranov/sqlserver-kit/report.yaml | 2 +-
.../snapshots/vitest-dev/vitest/report.yaml | 4 +--
.../snapshots/vitest-dev/vitest/snapshot.txt | 3 +-
packages/cspell-bundled-dicts/package.json | 6 ++--
pnpm-lock.yaml | 33 +++++++++++++---------
7 files changed, 29 insertions(+), 33 deletions(-)
---
.../snapshots/AdaDoom3/AdaDoom3/report.yaml | 3 +-
.../snapshots/AdaDoom3/AdaDoom3/snapshot.txt | 3 +-
.../MicrosoftDocs/PowerShell-Docs/report.yaml | 12 +++---
.../MicrosoftDocs/PowerShell-Docs/snapshot.txt | 4 +-
.../snapshots/eslint/eslint/report.yaml | 6 +--
.../snapshots/eslint/eslint/snapshot.txt | 3 +-
packages/cspell-bundled-dicts/package.json | 8 ++--
pnpm-lock.yaml | 45 ++++++++++++----------
8 files changed, 40 insertions(+), 44 deletions(-)
---
.../snapshots/dart-lang/sdk/report.yaml | 6 +--
.../snapshots/dart-lang/sdk/snapshot.txt | 3 +-
.../snapshots/liriliri/licia/report.yaml | 3 +-
.../snapshots/liriliri/licia/snapshot.txt | 3 +-
.../microsoft/TypeScript-Website/report.yaml | 5 +-
.../microsoft/TypeScript-Website/snapshot.txt | 3 +-
.../snapshots/neovim/nvim-lspconfig/report.yaml | 5 +-
.../snapshots/neovim/nvim-lspconfig/snapshot.txt | 3 +-
.../snapshots/pycontribs/jira/report.yaml | 3 +-
.../snapshots/pycontribs/jira/snapshot.txt | 3 +-
.../snapshots/wireapp/wire-webapp/report.yaml | 5 +-
.../snapshots/wireapp/wire-webapp/snapshot.txt | 3 +-
packages/cspell-bundled-dicts/package.json | 10 ++--
pnpm-lock.yaml | 60 +++++++++++++---------
14 files changed, 57 insertions(+), 58 deletions(-)
---
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
reusable
" (55a7121)Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
cpp
dictionary (#2794) (e51f7f4)go
dictionary (#2792) (778b8fe)exactOptionalPropertyTypes
(#2493) (ffde5ac).R
is detected as an R file. (#2425) (e9ae045), closes #2424Note: Version bump only for package cspell-monorepo
cwd
can be set. (#2316) (80087ac)--fail-fast
to cspell README.md (#2340) (5554ecb)types
(#2343) (7131001), closes #2341${cwd}/
works in globs. (#2315) (2dbe93e)suggestionEditCosts
into dictionaryInformation
(#2296) (021e781)--fail-fast
cli option (#2338) (7c17c22), closes #2294failFast
config option to exit as soon as an issue encountered (#2307) (26dd25a)stdin
for trace. (#2300) (7967ffe)typedoc
till it is fixed. (#2277) (417fe32)maxDuplicateProblems
setting (#2237) (fbb3593)0.2
by default. (#2186) (ed8af60)Note: Version bump only for package cspell-monorepo
enableCaseSensitive
/disableCaseSensitive
(#1951) (93387b7)path
(#1938) (fa4ea3f)--wordsOnly
option to --words-only
(#1928) (aac621f).gitignore
glob matching (#1847) (d36449b), closes #1846Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
--no-gitignore
option (#1833) (0b89fed)Note: Version bump only for package cspell-monorepo
issue.uri
is actually a URI. (#1746) (4268057)u
if no flags are given (#1745) (a75c370), closes #1699Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
trace
command with compound words. (#1574) (e6ebda8)noSuggest
dictionaries. (#1554) (f0ccda5)trace
words command results. (#1558) (ed8a5dc)cspell.config.js
files. (#1529) (e05aeff)cspell
README.md (#1530) (9c0dfd6)Note: Version bump only for package cspell-monorepo
There are several ways to mark a word as forbidden:
!
. !forbiddenWord
words
section of cspell
configuration: "words": [
"!forbiddenWord",
"configstore"
],
flagWords
section of cspell
configuration: "flagWords": ["forbiddenWord"]
Sometimes it is necessary to allow a word even if it is forbidden.
/**
* Do not mark `forbiddenWord` as incorrect.
* cspell:ignore forbiddenWord
*/
cspell
configuration{
"ignoreWords": ["forbiddenWord"]
}
words
(#1326) (ee3897d)Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
enableFiletypes
. (#979) (d18706e)deprecatedMessage
(#972) (492dca9)Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo
Note: Version bump only for package cspell-monorepo