Skip to main content

Interface: ReportIssueOptions

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

Extends​

Properties​

showContext?​

optional showContext: number

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

Tells the spell checker to show context around the issue. It is the number of characters to show on either side of the issue.

unknownWords?​

optional unknownWords: UnknownWordsChoices

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

Controls how unknown words are handled.

  • report-all - Report all unknown words (default behavior)
  • report-simple - Report unknown words that have simple spelling errors, typos, and flagged words.
  • report-common-typos - Report unknown words that are common typos and flagged words.
  • report-flagged - Report unknown words that are flagged.

Default​

"report-all"

Since​

9.1.0

Inherited from​

UnknownWordsConfiguration.unknownWords

validateDirectives?​

optional validateDirectives: boolean

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

Verify that the in-document directives are correct.