Skip to main content

Interface: Issue

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

Extends​

Properties​

col​

col: number

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

Inherited from​

TextDocumentOffset.col

context?​

optional context: TextOffset

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

The text surrounding the issue text. It is only included if the reporter cannot generated it automatically.

hasPreferredSuggestions?​

optional hasPreferredSuggestions: boolean

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

This setting is used for common typo detection.

  • true - if it has been determined if preferred suggestions are available.
  • false - if preferred suggestions are NOT available.
  • undefined - if it has not been determined.

Since​

9.1.0

hasSimpleSuggestions?​

optional hasSimpleSuggestions: boolean

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

true - if it has been determined if simple suggestions are available. false - if simple suggestions are NOT available. undefined - if it has not been determined.

Since​

9.1.0

isFlagged?​

optional isFlagged: boolean

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

true if the issue has been flagged as a forbidden word.

issueType?​

optional issueType: IssueType

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

Issues are spelling issues unless otherwise specified.

length?​

optional length: number

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

Assumed to match text.length if the text has not been transformed.

Inherited from​

TextOffset.length

line​

line: TextOffset

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

Inherited from​

TextDocumentOffset.line

message?​

optional message: string

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

Optional message to show.

offset​

offset: number

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

The offset into the document.

Inherited from​

TextOffset.offset

row​

row: number

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

Inherited from​

TextDocumentOffset.row

suggestions?​

optional suggestions: string[]

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

An optional array of replacement strings.

suggestionsEx?​

optional suggestionsEx: Suggestion[]

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

An optional array of suggestions.

text​

text: string

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

The text found at the offset. If the text has been transformed, then the length might not match length. Example: Original: cafe\u0301, text: café

Inherited from​

TextOffset.text

uri?​

optional uri: string

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

Inherited from​

TextDocumentOffset.uri