cspell 6.21.0

v6.21.0

on Node.js NPM

ci: Workflow Bot -- Build Readme (#4094)

packages/cspell/README.md | 42 +++++++++++++++++++++++++++++-------
packages/cspell/static/help-lint.txt | 42 +++++++++++++++++++++++++++++-------
2 files changed, 68 insertions(+), 16 deletions(-)

ci: Workflow Bot -- Build Readme (#4090)

packages/cspell-json-reporter/README.md | 20 ++++++++++++++------
1 file changed, 14 insertions(+), 6 deletions(-)

feat: Support cli reporters (#4093)

Add the --reporter option to specify a reporter on the command line.

feat: support stdin:// and file:// protocols (#4091)

Support using stdin://filename and file://./filename on the command line.

fixes: #4084

feat: JSON Reporter, support output to stdout (#4089)

Enable @cspell/cspell-json-reporter so that it can output to stdout and stderr as well as a file.

feat: Disable default reporter if another reporter has been defined. (#4087)

Minor Breakage

If a configuration contains a custom reporter, the default cli reporter will no longer be called. The fix is to add "default" to the list of "reporters".

//...
"reporters": ["./my-custom-reporter.cjs"]

//...
"reporters": ["./my-custom-reporter.cjs", "default"]

Problem

It is was not possible to disable the default cli reporter when using a custom reporter. This made custom reporters less useful in a CI/CD environment with structured logging.

Solution

If a custom reporter is defined, disable the default reporter. Allow the "default" reporter to be re-enabled by explicitly including it in the "reporters" list.

ci: Workflow Bot -- Build Docs (#4088)

docs/types/cspell-types/enums/IssueType.md | 4 +-
.../AdvancedCSpellSettingsWithSourceTrace.md | 123 +++++++++++---------
docs/types/cspell-types/interfaces/BaseSetting.md | 32 +++---
.../cspell-types/interfaces/CSpellReporter.md | 24 ++--
.../interfaces/CSpellReporterModule.md | 7 +-
.../cspell-types/interfaces/CSpellSettings.md | 115 +++++++++---------
.../interfaces/CSpellSettingsWithSourceTrace.md | 121 ++++++++++---------
.../types/cspell-types/interfaces/CacheSettings.md | 8 +-
.../cspell-types/interfaces/CharacterSetCosts.md | 6 +-
.../cspell-types/interfaces/CommandLineSettings.md | 4 +-
.../interfaces/DictionaryDefinitionAlternate.md | 14 +--
.../interfaces/DictionaryDefinitionAugmented.md | 16 +--
.../interfaces/DictionaryDefinitionBase.md | 12 +-
.../interfaces/DictionaryDefinitionCustom.md | 18 +--
.../interfaces/DictionaryDefinitionPreferred.md | 14 +--
.../interfaces/DictionaryInformation.md | 16 +--
docs/types/cspell-types/interfaces/EditCosts.md | 10 +-
.../cspell-types/interfaces/ExtendableSettings.md | 64 +++++------
docs/types/cspell-types/interfaces/Features.md | 2 +-
docs/types/cspell-types/interfaces/FileSettings.md | 111 ++++++++++--------
docs/types/cspell-types/interfaces/FileSource.md | 8 +-
.../types/cspell-types/interfaces/ImportFileRef.md | 6 +-
.../cspell-types/interfaces/InMemorySource.md | 8 +-
docs/types/cspell-types/interfaces/Issue.md | 26 ++---
.../cspell-types/interfaces/LanguageSetting.md | 38 +++---
.../interfaces/LanguageSettingFilterFields.md | 6 +-
.../LanguageSettingFilterFieldsDeprecated.md | 4 +-
.../LanguageSettingFilterFieldsPreferred.md | 4 +-
.../cspell-types/interfaces/LegacySettings.md | 4 +-
docs/types/cspell-types/interfaces/MergeSource.md | 8 +-
.../interfaces/OverrideFilterFields.md | 2 +-
.../cspell-types/interfaces/OverrideSettings.md | 64 +++++------
docs/types/cspell-types/interfaces/ParseResult.md | 6 +-
docs/types/cspell-types/interfaces/ParsedText.md | 12 +-
docs/types/cspell-types/interfaces/Parser.md | 4 +-
docs/types/cspell-types/interfaces/Plugin.md | 2 +-
docs/types/cspell-types/interfaces/PnPSettings.md | 4 +-
docs/types/cspell-types/interfaces/ProgressBase.md | 2 +-
.../cspell-types/interfaces/ProgressFileBase.md | 8 +-
.../cspell-types/interfaces/ProgressFileBegin.md | 8 +-
.../interfaces/ProgressFileComplete.md | 16 +--
.../interfaces/RegExpPatternDefinition.md | 6 +-
.../interfaces/ReportingConfiguration.md | 28 +++--
docs/types/cspell-types/interfaces/RunResult.md | 10 +-
docs/types/cspell-types/interfaces/Settings.md | 62 +++++-----
.../interfaces/SuggestionsConfiguration.md | 6 +-
.../cspell-types/interfaces/TextDocumentOffset.md | 16 +--
docs/types/cspell-types/interfaces/TextOffset.md | 6 +-
.../interfaces/WorkspaceTrustSettings.md | 6 +-
docs/types/cspell-types/modules.md | 128 +++++++++++----------
50 files changed, 648 insertions(+), 581 deletions(-)

test: Update ESLint test fixtures (#4086)