Interface ReporterConfiguration

interface ReporterConfiguration {
    debug?: boolean;
    maxDuplicateProblems?: number;
    maxNumberOfProblems?: number;
    minWordLength?: number;
    root?: string;
    unique?: boolean;
    verbose?: boolean;
    wordsOnly?: boolean;
}

Hierarchy

  • ReporterCommandLineOptions
  • ReporterConfigurationBase
    • ReporterConfiguration

Properties

debug? maxDuplicateProblems? maxNumberOfProblems? minWordLength? root? unique? verbose? wordsOnly?

Properties

Optional debug

debug?: boolean

Show extensive output.

Optional maxDuplicateProblems

maxDuplicateProblems?: number

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

Default

5

Optional maxNumberOfProblems

maxNumberOfProblems?: number

The maximum number of problems to report in a file.

Default

10000

Optional minWordLength

minWordLength?: number

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

Default

4

Optional root

root?: string

root directory, defaults to cwd

Optional unique

unique?: boolean

unique errors per file only.

Optional verbose

verbose?: boolean

Display verbose information

Optional wordsOnly

wordsOnly?: boolean

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

Settings

Member Visibility

Theme

On This Page

debugmaxDuplicateProblemsmaxNumberOfProblemsminWordLengthrootuniqueverbosewordsOnly