Skip to main content

Interface: ValidationIssue

Defined in: packages/cspell-lib/src/lib/Models/ValidationIssue.ts:4

Extends​

  • ValidationResult

Properties​

hasPreferredSuggestions?​

optional hasPreferredSuggestions?: boolean

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

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

Inherited from​

ValidationResult.hasPreferredSuggestions

hasSimpleSuggestions?​

optional hasSimpleSuggestions?: boolean

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

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

Inherited from​

ValidationResult.hasSimpleSuggestions

isFlagged?​

optional isFlagged?: boolean

Defined in: packages/cspell-lib/src/lib/Models/ValidationResult.ts:9

Inherited from​

ValidationIssue.isFlagged

isFound?​

optional isFound?: boolean

Defined in: packages/cspell-lib/src/lib/Models/ValidationResult.ts:10

Inherited from​

ValidationIssue.isFound

issueType?​

optional issueType?: IssueType

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

Issues are spelling issues unless otherwise specified.

Inherited from​

ValidationResult.issueType

length?​

optional length?: number

Defined in: packages/cspell-lib/src/lib/Models/ValidationResult.ts:7

Inherited from​

ValidationIssue.length

line​

line: TextOffset

Defined in: packages/cspell-lib/src/lib/Models/ValidationResult.ts:8

Inherited from​

ValidationResult.line

message?​

optional message?: string

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

Optional message to show.

Inherited from​

ValidationResult.message

offset​

offset: number

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

The offset into the document.

Inherited from​

TextDocumentOffset.offset

suggestions?​

optional suggestions?: string[]

Defined in: packages/cspell-lib/src/lib/Models/ValidationIssue.ts:5

suggestionsEx?​

optional suggestionsEx?: ExtendedSuggestion[]

Defined in: packages/cspell-lib/src/lib/Models/ValidationIssue.ts:6

text​

text: string

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

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​

TextDocumentOffset.text