docs: mark LintMessage#nodeType as deprecated (#19019)

snitin315 · mdjermanovic · web-flow · commit abdbfa839077 · 2024-10-17T21:54:21.000+02:00
* docs: mark `LintMessage#nodeType` as deprecated

* docs: mark `TestCaseError#type` as deprecated

* docs: apply suggestions from code review

Co-authored-by: Milos Djermanovic &lt;milos.djermanovic@gmail.com&gt;

---------

Co-authored-by: Milos Djermanovic &lt;milos.djermanovic@gmail.com&gt;
diff --git a/docs/src/extend/custom-formatters.md b/docs/src/extend/custom-formatters.md
@@ -111,7 +111,7 @@ Each `message` object contains information about the ESLint rule that was trigge
 * **message**: the human readable description of the error.
 * **line**: the line where the issue is located.
 * **column**: the column where the issue is located.
-* **nodeType**: the type of the node in the [AST](https://github.com/estree/estree/blob/master/es5.md#node-objects) or `null` if the issue isn't related to a particular AST node.
+* **nodeType**: (**Deprecated:** This property will be removed in a future version of ESLint.) the type of the node in the [AST](https://github.com/estree/estree/blob/master/es5.md#node-objects) or `null` if the issue isn't related to a particular AST node.
 
 ### The `context` Argument
 
diff --git a/docs/src/integrate/nodejs-api.md b/docs/src/integrate/nodejs-api.md
@@ -658,7 +658,7 @@ The information available for each linting message is:
 * `fatal` - usually omitted, but will be set to true if there's a parsing error (not related to a rule).
 * `line` - the line on which the error occurred.
 * `message` - the message that should be output.
-* `nodeType` - the node or token type that was reported with the problem.
+* `nodeType` - (**Deprecated:** This property will be removed in a future version of ESLint.) the node or token type that was reported with the problem.
 * `ruleId` - the ID of the rule that triggered the messages (or null if `fatal` is true).
 * `severity` - either 1 or 2, depending on your configuration.
 * `endColumn` - the end column of the range on which the error occurred (this property is omitted if it's not range).
@@ -839,7 +839,7 @@ In addition to the properties above, invalid test cases can also have the follow
     * `message` (string/regexp): The message for the error. Must provide this or `messageId`
     * `messageId` (string): The Id for the error. Must provide this or `message`. See [testing errors with messageId](#testing-errors-with-messageid) for details
     * `data` (object): Placeholder data which can be used in combination with `messageId`
-    * `type` (string): The type of the reported AST node
+    * `type` (string): (**Deprecated:** This property will be removed in a future version of ESLint.) The type of the reported AST node
     * `line` (number): The 1-based line number of the reported location
     * `column` (number): The 1-based column number of the reported location
     * `endLine` (number): The 1-based line number of the end of the reported location
diff --git a/lib/types/index.d.ts b/lib/types/index.d.ts
@@ -1179,6 +1179,9 @@ export namespace Linter {
         ruleId: string | null;
         message: string;
         messageId?: string | undefined;
+        /**
+         * @deprecated `nodeType` is deprecated and will be removed in the next major version.
+         */
         nodeType?: string | undefined;
         fatal?: true | undefined;
         severity: Exclude<Severity, 0>;
@@ -1661,6 +1664,9 @@ export namespace RuleTester {
     interface TestCaseError {
         message?: string | RegExp;
         messageId?: string;
+        /**
+         * @deprecated `type` is deprecated and will be removed in the next major version.
+         */
         type?: string | undefined;
         data?: any;
         line?: number | undefined;
