Interface: Issue

Defined in: CSpellReporter.ts:18

Extends

• Omit<TextDocumentOffset, "doc">

Properties

col

col: number

Defined in: TextOffset.ts:21

Inherited from

Omit.col

---

context

context: TextOffset

Defined in: CSpellReporter.ts:20

text surrounding the issue text

---

isFlagged?

optional isFlagged: boolean

Defined in: CSpellReporter.ts:24

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

---

issueType?

optional issueType: IssueType

Defined in: CSpellReporter.ts:36

Issues are spelling issues unless otherwise specified.

---

length?

optional length: number

Defined in: TextOffset.ts:14

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

Inherited from

Omit.length

---

line

line: TextOffset

Defined in: TextOffset.ts:22

Inherited from

Omit.line

---

message?

optional message: string

Defined in: CSpellReporter.ts:40

Optional message to show.

---

offset

offset: number

Defined in: TextOffset.ts:10

The offset into the document.

Inherited from

Omit.offset

---

row

row: number

Defined in: TextOffset.ts:20

Inherited from

Omit.row

---

suggestions?

optional suggestions: string[]

Defined in: CSpellReporter.ts:28

An optional array of replacement strings.

---

suggestionsEx?

optional suggestionsEx: Suggestion[]

Defined in: CSpellReporter.ts:32

An optional array of suggestions.

---

text

text: string

Defined in: TextOffset.ts:6

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

Omit.text

---

uri?

optional uri: string

Defined in: TextOffset.ts:18

Inherited from

Omit.uri