Skip to main content

Interface: ReportingConfiguration

Defined in: CSpellSettingsDef.ts:284

Extends

Extended by

Properties

ignoreRandomStrings?

optional ignoreRandomStrings: boolean

Defined in: CSpellReporter.ts:152

Ignore sequences of characters that look like random strings.

Default

true

Inherited from

ReporterConfigurationBase.ignoreRandomStrings


maxDuplicateProblems?

optional maxDuplicateProblems: number

Defined in: CSpellReporter.ts:138

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: CSpellReporter.ts:131

The maximum number of problems to report in a file.

Default

10000

Inherited from

ReporterConfigurationBase.maxNumberOfProblems


minRandomLength?

optional minRandomLength: number

Defined in: CSpellReporter.ts:159

The minimum length of a random string to be ignored.

Default

40

Inherited from

ReporterConfigurationBase.minRandomLength


minWordLength?

optional minWordLength: number

Defined in: CSpellReporter.ts:145

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

Default

4

Inherited from

ReporterConfigurationBase.minWordLength


numSuggestions?

optional numSuggestions: number

Defined in: CSpellSettingsDef.ts:292

Number of suggestions to make.

Default

10

Inherited from

SuggestionsConfiguration.numSuggestions


suggestionNumChanges?

optional suggestionNumChanges: number

Defined in: CSpellSettingsDef.ts:310

The maximum number of changes allowed on a word to be considered a suggestions.

For example, appending an s onto example -> examples is considered 1 change.

Range: between 1 and 5.

Default

3

Inherited from

SuggestionsConfiguration.suggestionNumChanges


suggestionsTimeout?

optional suggestionsTimeout: number

Defined in: CSpellSettingsDef.ts:299

The maximum amount of time in milliseconds to generate suggestions for a word.

Default

500

Inherited from

SuggestionsConfiguration.suggestionsTimeout