refactor(linter/plugins): store messageId in diagnostics (#16296)

Store `messageId` in `DiagnosticReport` objects. It's not required for sending to Rust, but it is needed for rule tester (#16206).

I think it's fine to add a little code that's redundant in the main runtime, because it only has an overhead when a rule produces diagnostics, which should be an uncommon path.

Author: overlookmotel

apps/oxlint/src-js/plugins/lint.ts

@@ -22,6 +22,8 @@ import { walkProgram } from '../generated/walk.js';
 // @ts-expect-error we need to generate `.d.ts` file for this module
 import { walkProgram } from "../generated/walk.js";
 
+import type { SetOptional } from "type-fest";
+import type { DiagnosticReport } from "../plugins/report.ts";
 import type { AfterHook, BufferWithArrays } from "./types.ts";
 
 // Buffers cache.
@@ -61,6 +63,12 @@ export function lintFile(
 
   try {
     lintFileImpl(filePath, bufferId, buffer, ruleIds, optionsIds, settingsJSON);
+
+    // Remove `messageId` field from diagnostics. It's not needed on Rust side.
+    for (let i = 0, len = diagnostics.length; i < len; i++) {
+      (diagnostics[i] as SetOptional<DiagnosticReport, "messageId">).messageId = undefined;
+    }
+
     return JSON.stringify({ Success: diagnostics });
   } catch (err) {
     return JSON.stringify({ Failure: getErrorMessage(err) });

apps/oxlint/src-js/plugins/report.ts

@@ -21,7 +21,7 @@ const { hasOwn, keys: ObjectKeys } = Object;
  * - Either `node` or `loc` property must be provided.
  */
 // This is the type of the value passed to `Context#report()` by user.
-// `DiagnosticReport` (see below) is the type of diagnostics sent to Rust.
+// `DiagnosticReport` (see below) is the type of diagnostics used internally on JS side, and sent to Rust.
 export type Diagnostic = RequireAtLeastOne<
   RequireAtLeastOne<DiagnosticBase, "node" | "loc">,
   "message" | "messageId"
@@ -55,13 +55,15 @@ interface SuggestionBase {
   data?: DiagnosticData | null | undefined;
 }
 
-// Diagnostic in form sent to Rust
-interface DiagnosticReport {
+// Diagnostic in form sent to Rust.
+// Actually, the `messageId` field is removed before sending to Rust.
+export interface DiagnosticReport {
   message: string;
   start: number;
   end: number;
   ruleIndex: number;
   fixes: Fix[] | null;
+  messageId: string | null;
 }
 
 // Diagnostics array. Reused for every file.
@@ -81,7 +83,7 @@ export function report(diagnostic: Diagnostic, ruleDetails: RuleDetails): void {
   if (filePath === null) throw new Error("Cannot report errors in `createOnce`");
 
   // Get message, resolving message from `messageId` if present
-  let message = getMessage(diagnostic, ruleDetails);
+  let { message, messageId } = getMessage(diagnostic, ruleDetails);
 
   // Interpolate placeholders {{key}} with data values
   if (hasOwn(diagnostic, "data")) {
@@ -129,6 +131,7 @@ export function report(diagnostic: Diagnostic, ruleDetails: RuleDetails): void {
 
   diagnostics.push({
     message,
+    messageId,
     start,
     end,
     ruleIndex: ruleDetails.ruleIndex,
@@ -140,18 +143,26 @@ export function report(diagnostic: Diagnostic, ruleDetails: RuleDetails): void {
  * Get message from diagnostic.
  * @param diagnostic - Diagnostic object
  * @param ruleDetails - `RuleDetails` object, containing rule-specific `messages`
- * @returns Message string
+ * @returns Message string and `messageId`
  * @throws {Error|TypeError} If neither `message` nor `messageId` provided, or of wrong type
  */
-function getMessage(diagnostic: Diagnostic, ruleDetails: RuleDetails): string {
+function getMessage(
+  diagnostic: Diagnostic,
+  ruleDetails: RuleDetails,
+): { message: string; messageId: string | null } {
   if (hasOwn(diagnostic, "messageId")) {
     const { messageId } = diagnostic;
-    if (messageId != null) return resolveMessageFromMessageId(messageId, ruleDetails);
+    if (messageId != null) {
+      return {
+        message: resolveMessageFromMessageId(messageId, ruleDetails),
+        messageId,
+      };
+    }
   }
 
   if (hasOwn(diagnostic, "message")) {
     const { message } = diagnostic;
-    if (typeof message === "string") return message;
+    if (typeof message === "string") return { message, messageId: null };
     if (message != null) throw new TypeError("`message` must be a string");
   }