From c51989400b342623a6a3f365d0ca283405dda8eb Mon Sep 17 00:00:00 2001 From: Brandon Mills Date: Sat, 8 Apr 2023 20:34:33 -0400 Subject: [PATCH] Update LintMessage docs This updates existing documented properties to match the updated `LintMessage` type and implementations. `messageId`, `nodeType`, and `suppressions` remain undocumented. --- docs/src/extend/custom-processors.md | 6 +++--- docs/src/integrate/nodejs-api.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/src/extend/custom-processors.md b/docs/src/extend/custom-processors.md index 8f330883b03b..769bdf614be2 100644 --- a/docs/src/extend/custom-processors.md +++ b/docs/src/extend/custom-processors.md @@ -65,13 +65,13 @@ type LintMessage = { column: number; /// The 1-based line number of the end location. - endLine: number; + endLine?: number; /// The 1-based column number of the end location. - endColumn: number; + endColumn?: number; /// If `true`, this is a fatal error. - fatal: boolean; + fatal?: boolean; /// Information for an autofix. fix: Fix; diff --git a/docs/src/integrate/nodejs-api.md b/docs/src/integrate/nodejs-api.md index de035ca731c6..05b5b5d01ebc 100644 --- a/docs/src/integrate/nodejs-api.md +++ b/docs/src/integrate/nodejs-api.md @@ -397,9 +397,9 @@ The `LintMessage` value is the information of each linting error. The `messages` `true` if this is a fatal error unrelated to a rule, like a parsing error. * `message` (`string`)
The error message. -* `line` (`number | undefined`)
+* `line` (`number`)
The 1-based line number of the begin point of this message. -* `column` (`number | undefined`)
+* `column` (`number`)
The 1-based column number of the begin point of this message. * `endLine` (`number | undefined`)
The 1-based line number of the end point of this message. This property is undefined if this message is not a range.