Skip to main content

Interface: ReporterConfiguration

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

Extends​

  • ReporterCommandLineOptions.ReporterConfigurationBase

Properties​

debug?​

optional debug?: boolean

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

Show extensive output.

Inherited from​

ReporterCommandLineOptions.debug

ignoreRandomStrings?​

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​

ReporterConfigurationBase.ignoreRandomStrings

maxDuplicateProblems?​

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​

ReporterConfigurationBase.maxDuplicateProblems

maxNumberOfProblems?​

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​

ReporterConfigurationBase.maxNumberOfProblems

minRandomLength?​

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​

ReporterConfigurationBase.minRandomLength

minWordLength?​

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​

ReporterConfigurationBase.minWordLength

root?​

optional root?: string

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

root directory, defaults to cwd

Inherited from​

ReporterCommandLineOptions.root

unique?​

optional unique?: boolean

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

unique errors per file only.

Inherited from​

ReporterCommandLineOptions.unique

verbose?​

optional verbose?: boolean

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

Display verbose information

Inherited from​

ReporterCommandLineOptions.verbose

verboseLevel?​

optional verboseLevel?: number

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

Level of verbosity (higher number = more verbose).

Inherited from​

ReporterCommandLineOptions.verboseLevel

wordsOnly?​

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​

ReporterCommandLineOptions.wordsOnly