Skip to main content

Interface: CSpellReporterConfiguration

Defined in: packages/cspell/src/models.ts:8

Extends​

Properties​

cache?​

readonly optional cache?: boolean

Defined in: packages/cspell/src/util/cache/CacheOptions.ts:12

Store the info about processed files in order to only operate on the changed ones.

Inherited from​

Readonly.cache

cacheFormat?​

readonly optional cacheFormat?: CacheFormat

Defined in: packages/cspell/src/util/cache/CacheOptions.ts:38

Format of the cache file.

  • legacy - use absolute paths in the cache file
  • universal - use a sharable format.

Default​

'legacy'

Inherited from​

Readonly.cacheFormat

cacheLocation?​

readonly optional cacheLocation?: string

Defined in: packages/cspell/src/util/cache/CacheOptions.ts:20

Path to the cache location. Can be a file or a directory. If none specified .cspellcache will be used. The file will be created in the directory where the cspell command is executed.

Inherited from​

Readonly.cacheLocation

cacheReset?​

readonly optional cacheReset?: boolean

Defined in: packages/cspell/src/util/cache/CacheOptions.ts:30

Resets the cache

Inherited from​

Readonly.cacheReset

cacheStrategy?​

readonly optional cacheStrategy?: CacheStrategy

Defined in: packages/cspell/src/util/cache/CacheOptions.ts:25

Strategy to use for detecting changed files, default: metadata

Inherited from​

Readonly.cacheStrategy

color?​

readonly optional color?: boolean

Defined in: packages/cspell/src/options.ts:333

Use color in the output. true to force color, false to turn off color. undefined to use color if the output is a TTY.

Inherited from​

BaseOptions.color

config?​

readonly optional config?: string | CSpellConfigFile

Defined in: packages/cspell/src/options.ts:146

Path to configuration file.

Inherited from​

CSpellApplicationOptions.config

configSearch?​

readonly optional configSearch?: boolean

Defined in: packages/cspell/src/options.ts:412

Prevents searching for local configuration files

When --no-config-search is passed on the command line, this will be true. If the flag is not passed, it defaults to false.

Inherited from​

CSpellApplicationOptions.configSearch

console?​

readonly optional console?: IConsole

Defined in: packages/cspell/src/models.ts:13

The console to use for reporting.

Since​

8.11.1

continueOnError?​

readonly optional continueOnError?: boolean

Defined in: packages/cspell/src/options.ts:130

Keep going even if an error is found.

Inherited from​

CSpellApplicationOptions.continueOnError

debug?​

readonly optional debug?: boolean

Defined in: packages/cspell-types/dist/index.d.mts:320

Show extensive output.

Inherited from​

ReporterConfiguration.debug

defaultConfiguration?​

readonly optional defaultConfiguration?: boolean

Defined in: packages/cspell/src/options.ts:308

Load the default configuration

Default​

true

Inherited from​

BaseOptions.defaultConfiguration

dictionary?​

readonly optional dictionary?: string[]

Defined in: packages/cspell/src/options.ts:115

List of dictionary names to use.

Inherited from​

CSpellApplicationOptions.dictionary

disableDictionary?​

readonly optional disableDictionary?: string[]

Defined in: packages/cspell/src/options.ts:120

List of dictionary names to disable.

Inherited from​

CSpellApplicationOptions.disableDictionary

dot?​

readonly optional dot?: boolean

Defined in: packages/cspell/src/options.ts:40

Determine if files / directories starting with . should be part of the glob search.

Default​

false

Inherited from​

CSpellApplicationOptions.dot

exclude?​

readonly optional exclude?: string | string[]

Defined in: packages/cspell/src/options.ts:22

a globs to exclude files from being checked.

Inherited from​

CSpellApplicationOptions.exclude

exitCode?​

readonly optional exitCode?: boolean

Defined in: packages/cspell/src/options.ts:319

Return an exit code if there are issues found.

Default​

true

Inherited from​

BaseOptions.exitCode

failFast?​

readonly optional failFast?: boolean

Defined in: packages/cspell/src/options.ts:125

Stop processing and exit if an issue or error is found.

Inherited from​

CSpellApplicationOptions.failFast

file?​

readonly optional file?: string[]

Defined in: packages/cspell/src/options.ts:81

Alias of LinterOptions.files.

Inherited from​

CSpellApplicationOptions.file

fileList?​

readonly optional fileList?: string[]

Defined in: packages/cspell/src/options.ts:68

List of files that contains the paths to files to be spell checked. The files in the lists will be filtered against the glob patterns.

  • an entry of stdin means to read the file list from stdin The resulting files are filtered against the files globs found in the configuration.

Inherited from​

CSpellApplicationOptions.fileList

files?​

readonly optional files?: string[]

Defined in: packages/cspell/src/options.ts:76

List of file paths to spell check. These can be relative or absolute paths, but not Globs. Relative paths are relative to LinterOptions.root. The files are combined with the file paths read from LinterOptions.fileList. These files are filtered against the files globs found in the configuration.

Inherited from​

CSpellApplicationOptions.files

filterFiles?​

readonly optional filterFiles?: boolean

Defined in: packages/cspell/src/options.ts:86

Use the files configuration to filter the files found.

Inherited from​

CSpellApplicationOptions.filterFiles

flag?​

readonly optional flag?: string[]

Defined in: packages/cspell/src/options.ts:326

Execution flags. Used primarily for releasing experimental features. Flags are of the form key:value

Inherited from​

BaseOptions.flag

readonly optional followSymlinks?: boolean

Defined in: packages/cspell/src/options.ts:101

Allow checking --file and --file-list documents referenced by symbolic links. By default, a file that is a symbolic link, or is in a linked directory, is skipped. Glob searches are controlled by LinterOptions.globSymlinks.

When not set, the CSPELL_FOLLOW_SYMLINKS environment variable is used.

Default​

false

Inherited from​

CSpellApplicationOptions.followSymlinks

forceCheck?​

readonly optional forceCheck?: boolean

Defined in: packages/cspell/src/options.ts:425

Force the document to be checked even if it would normally be excluded.

Inherited from​

CSpellApplicationOptions.forceCheck

gitignore?​

readonly optional gitignore?: boolean

Defined in: packages/cspell/src/options.ts:55

Enable filtering out files matching globs found in .gitignore files.

Inherited from​

CSpellApplicationOptions.gitignore

gitignoreRoot?​

readonly optional gitignoreRoot?: string | string[]

Defined in: packages/cspell/src/options.ts:60

Stop searching for a .gitignores when a root is reached.

Inherited from​

CSpellApplicationOptions.gitignoreRoot

readonly optional globSymlinks?: boolean

Defined in: packages/cspell/src/options.ts:110

Follow symbolic links when matching globs. By default, glob searches skip files that are symbolic links and don't search linked directories.

When not set, the CSPELL_GLOB_SYMLINKS environment variable is used.

Default​

false

Inherited from​

CSpellApplicationOptions.globSymlinks

ignoreRandomStrings?​

readonly optional ignoreRandomStrings?: boolean

Defined in: packages/cspell-types/dist/index.d.mts:300

Ignore sequences of characters that look like random strings.

Default​

true

Inherited from​

CSpellApplicationOptions.ignoreRandomStrings

issues?​

readonly optional issues?: boolean

Defined in: packages/cspell/src/options.ts:348

Show issues

Inherited from​

CSpellApplicationOptions.issues

issuesSummaryReport?​

readonly optional issuesSummaryReport?: boolean

Defined in: packages/cspell/src/options.ts:370

Generate a summary report of issues.

Inherited from​

CSpellApplicationOptions.issuesSummaryReport

issueTemplate?​

readonly optional issueTemplate?: string

Defined in: packages/cspell/src/options.ts:405

Set the template to use when reporting issues.

The template is a string that can contain the following placeholders:

  • $filename - the file name
  • $col - the column number
  • $row - the row number
  • $text - the word that is misspelled
  • $message - the issues message: "unknown word", "word is misspelled", etc.
  • $messageColored - the issues message with color based upon the message type.
  • $uri - the URI of the file
  • $suggestions - suggestions for the misspelled word (if requested)
  • $quickFix - possible quick fixes for the misspelled word.
  • $contextFull - the full context of the misspelled word.
  • $contextLeft - the context to the left of the misspelled word.
  • $contextRight - the context to the right of the misspelled word.

Color is supported using the following template pattern:

  • {<style[.style]> <text>} - where <style> is a style name and <text> is the text to style.

Styles

  • bold, italic, underline, strikethrough, dim, inverse
  • black, red, green, yellow, blue, magenta, cyan, white

Example:

Example​

"{green $filename}:{yellow $row}:{yellow $col} $message {red $text} $quickFix {dim $suggestions}"

Since​

8.12.0

Inherited from​

CSpellApplicationOptions.issueTemplate

languageId?​

readonly optional languageId?: string

Defined in: packages/cspell/src/options.ts:298

Programming Language ID.

Inherited from​

BaseOptions.languageId

legacy?​

readonly optional legacy?: boolean

Defined in: packages/cspell/src/options.ts:340

Show legacy output

Inherited from​

CSpellApplicationOptions.legacy

locale?​

readonly optional locale?: string

Defined in: packages/cspell/src/options.ts:302

Locale to use.

Inherited from​

BaseOptions.locale

maxDuplicateProblems?​

readonly optional maxDuplicateProblems?: number

Defined in: packages/cspell-types/dist/index.d.mts:288

The maximum number of times the same word can be flagged as an error in a file.

Default​

5

Inherited from​

CSpellApplicationOptions.maxDuplicateProblems

maxFileSize?​

readonly optional maxFileSize?: string

Defined in: packages/cspell/src/options.ts:154

Specify the maximum file size to be checked. The value can include a units suffix: KB, MB, B, GB. The numeric value can include a decimal. Example: 1.5MB

Inherited from​

CSpellApplicationOptions.maxFileSize

maxNumberOfProblems?​

readonly optional maxNumberOfProblems?: number

Defined in: packages/cspell-types/dist/index.d.mts:282

The maximum number of problems to report in a file.

Default​

10000

Inherited from​

CSpellApplicationOptions.maxNumberOfProblems

minRandomLength?​

readonly optional minRandomLength?: number

Defined in: packages/cspell-types/dist/index.d.mts:306

The minimum length of a random string to be ignored.

Default​

40

Inherited from​

CSpellApplicationOptions.minRandomLength

minWordLength?​

readonly optional minWordLength?: number

Defined in: packages/cspell-types/dist/index.d.mts:294

The minimum length of a word before checking it against a dictionary.

Default​

4

Inherited from​

CSpellApplicationOptions.minWordLength

mustFindFiles?​

readonly optional mustFindFiles?: boolean

Defined in: packages/cspell/src/options.ts:365

Files must be found or cli will exit with an error.

Inherited from​

CSpellApplicationOptions.mustFindFiles

progress?​

readonly optional progress?: boolean

Defined in: packages/cspell/src/options.ts:357

Show progress

Inherited from​

CSpellApplicationOptions.progress

relative?​

readonly optional relative?: boolean

Defined in: packages/cspell/src/options.ts:361

issues are shown with a relative path to the root or cwd

Inherited from​

CSpellApplicationOptions.relative

report?​

readonly optional report?: ReportChoices

Defined in: packages/cspell/src/options.ts:430

Which issues to report. If not set, all issues are reported.

Inherited from​

Readonly.report

reporter?​

readonly optional reporter?: string[]

Defined in: packages/cspell/src/options.ts:136

Optional list of reporters to use, overriding any specified in the configuration.

Inherited from​

CSpellApplicationOptions.reporter

root?​

readonly optional root?: string

Defined in: packages/cspell-types/dist/index.d.mts:332

root directory, defaults to cwd

Inherited from​

ReporterConfiguration.root

showContext?​

readonly optional showContext?: number | boolean

Defined in: packages/cspell/src/options.ts:46

Show part of a line where an issue is found.

  • if true, it will show the default number of characters on either side.
  • if a number, the number of characters to show on either side of the issue.

Inherited from​

CSpellApplicationOptions.showContext

showPerfSummary?​

readonly optional showPerfSummary?: boolean

Defined in: packages/cspell/src/options.ts:375

Generate a summary report of performance.

Inherited from​

CSpellApplicationOptions.showPerfSummary

showSuggestions?​

readonly optional showSuggestions?: boolean

Defined in: packages/cspell/src/options.ts:50

Show suggestions for spelling errors.

Inherited from​

CSpellApplicationOptions.showSuggestions

silent?​

readonly optional silent?: boolean

Defined in: packages/cspell/src/options.ts:353

Run in silent mode.

Default​

false

Inherited from​

CSpellApplicationOptions.silent

skipValidation?​

readonly optional skipValidation?: boolean

Defined in: packages/cspell/src/options.ts:141

Load and parse documents, but do not spell check.

Inherited from​

CSpellApplicationOptions.skipValidation

stopConfigSearchAt?​

readonly optional stopConfigSearchAt?: string[]

Defined in: packages/cspell/src/options.ts:420

Directory paths at which CSpell should stop searching for configuration files.

These are set via one or more --stop-config-search-at <dir> CLI options. If no flags are passed, this will be undefined.

Inherited from​

CSpellApplicationOptions.stopConfigSearchAt

summary?​

readonly optional summary?: boolean

Defined in: packages/cspell/src/options.ts:344

Show summary at the end

Inherited from​

CSpellApplicationOptions.summary

unique?​

readonly optional unique?: boolean

Defined in: packages/cspell-types/dist/index.d.mts:328

unique errors per file only.

Inherited from​

ReporterConfiguration.unique

validateDirectives?​

readonly optional validateDirectives?: boolean

Defined in: packages/cspell/src/options.ts:313

Check In-Document CSpell directives for correctness.

Inherited from​

BaseOptions.validateDirectives

verbose?​

readonly optional verbose?: boolean

Defined in: packages/cspell-types/dist/index.d.mts:312

Display verbose information

Inherited from​

ReporterConfiguration.verbose

verboseLevel?​

readonly optional verboseLevel?: number

Defined in: packages/cspell-types/dist/index.d.mts:316

Level of verbosity (higher number = more verbose).

Inherited from​

ReporterConfiguration.verboseLevel

wordsOnly?​

readonly optional wordsOnly?: boolean

Defined in: packages/cspell-types/dist/index.d.mts:324

Only report the words, no line numbers or file names.

Inherited from​

ReporterConfiguration.wordsOnly