Skip to main content

Interface: ReporterConfiguration

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

Extends​

  • ReporterCommandLineOptions.ReporterConfigurationBase

Properties​

debug?​

optional debug: boolean

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

Show extensive output.

Inherited from​

ReporterCommandLineOptions.debug

ignoreRandomStrings?​

optional ignoreRandomStrings: boolean

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

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:222

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:216

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:240

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:228

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:262

root directory, defaults to cwd

Inherited from​

ReporterCommandLineOptions.root

unique?​

optional unique: boolean

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

unique errors per file only.

Inherited from​

ReporterCommandLineOptions.unique

verbose?​

optional verbose: boolean

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

Display verbose information

Inherited from​

ReporterCommandLineOptions.verbose

wordsOnly?​

optional wordsOnly: boolean

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

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

Inherited from​

ReporterCommandLineOptions.wordsOnly