[lint-diff] Enable eslint

.github/workflows/lintdiff-test.yaml

@@ -1,3 +1,3 @@
 name: Swagger LintDiff - Test
 
 on:
@@ -31,4 +31,4 @@
     uses: ./.github/workflows/_reusable-eng-tools-test.yaml
     with:
       package: lint-diff
-      lint: false
+      lint: true

eng/tools/lint-diff/eslint.config.js

@@ -0,0 +1,30 @@
+// Keep in sync with .github/shared/eslint.config.js
+
+import eslint from "@eslint/js";
+import { defineConfig } from "eslint/config";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+/** @type {import('eslint').Linter.Config[]} */
+export default defineConfig(
+  eslint.configs.recommended,
+  tseslint.configs.recommendedTypeChecked,
+  {
+    languageOptions: {
+      // we only run in node, not browser
+      globals: globals.node,
+      // required to use tseslint.configs.recommendedTypeChecked
+      parserOptions: {
+        projectService: {
+          allowDefaultProject: ["*.js", "cmd/*.js"],
+        },
+        // ensures the tsconfig path resolves relative to this file
+        // default is process.cwd() when running eslint, which may be incorrect
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    ignores: ["coverage/**", "dist/**"],
+  },
+);

eng/tools/lint-diff/package.json

@@ -1,3 +1,3 @@
 {
   "name": "@azure-tools/lint-diff",
   "private": true,
@@ -8,10 +8,12 @@
   },
   "scripts": {
     "build": "tsc --build",
+    "check": "npm run build && npm run lint && npm run format:check && npm run test:ci",
     "clean": "rm -rf dist && rm -rf node_modules",
     "format": "prettier . --ignore-path ../.prettierignore --write",
     "format:check": "prettier . --ignore-path ../.prettierignore --check",
     "format:check:ci": "prettier . --ignore-path ../.prettierignore --check --log-level debug",
+    "lint": "cross-env DEBUG=eslint:eslint eslint",
     "test": "vitest",
     "test:ci": "vitest run --coverage --reporter=verbose"
   },
@@ -30,14 +32,17 @@
     "marked": "^17.0.0"
   },
   "devDependencies": {
+    "@eslint/js": "^9.22.0",
     "@types/deep-eql": "^4.0.2",
     "@types/node": "^18.19.31",
     "@vitest/coverage-v8": "^3.0.2",
+    "eslint": "^9.22.0",
     "execa": "^9.5.2",
     "memfs": "^4.17.0",
     "prettier": "~3.6.2",
     "prettier-plugin-organize-imports": "^4.2.0",
     "typescript": "~5.9.2",
+    "typescript-eslint": "^8.45.0",
     "vitest": "^3.2.4"
   }
 }

eng/tools/lint-diff/src/correlateResults.ts

@@ -1,3 +1,3 @@
 import { Readme } from "@azure-tools/specs-shared/readme";
 import { basename, join, relative } from "path";
 import { AutorestRunResult, BeforeAfter, LintDiffViolation, Source } from "./lintdiff-types.js";
@@ -40,7 +40,7 @@
       const beforeReadme = new Readme(beforeReadmePath);
       const defaultTag = await getDefaultTag(beforeReadme);
       if (!defaultTag) {
-        throw new Error(`No default tag found for readme ${readme} in before state`);
+        throw new Error(`No default tag found for readme ${readme.toString()} in before state`);
       }
       const beforeDefaultTagCandidates = beforeChecks.filter(
         (r) => relative(beforePath, r.readme.path) === readmePathRelative && r.tag === defaultTag,
@@ -69,7 +69,9 @@
         });
         continue;
       } else if (beforeReadmeCandidate.length > 1) {
-        throw new Error(`Multiple before candidates found for key ${key} using readme ${readme}`);
+        throw new Error(
+          `Multiple before candidates found for key ${key} using readme ${readme.toString()}`,
+        );
       }
     }
 
@@ -148,7 +150,7 @@
       continue;
     }
 
-    const result = JSON.parse(line.trim());
+    const result = JSON.parse(line.trim()) as { code: string };
     if (result.code == undefined) {
       // Results without a code can be assumed to be fatal errors. Set the code
       // to "FATAL"
@@ -213,7 +215,7 @@
   return true;
 }
 
-export function arrayIsEqual(a: any[], b: any[]) {
+export function arrayIsEqual(a: unknown[], b: unknown[]) {
   if (a.length !== b.length) {
     return false;
   }

eng/tools/lint-diff/src/generateReport.ts

@@ -1,3 +1,3 @@
 import { kebabCase } from "change-case";
 import { writeFile } from "node:fs/promises";
 import { relative } from "node:path";
@@ -148,7 +148,7 @@
   console.error("LintDiff detected AutoRest errors");
   outputMarkdown += "**AutoRest errors:**\n\n";
   for (const { result, errors } of autoRestErrors) {
-    console.log(`AutoRest errors for ${result.readme} (${result.tag})`);
+    console.log(`AutoRest errors for ${result.readme.toString()} (${result.tag})`);
 
     const readmePath = relative(result.rootPath, result.readme.path);
 

eng/tools/lint-diff/src/lint-diff.ts

@@ -1,6 +1,6 @@
 import { SpecModelError } from "@azure-tools/specs-shared/spec-model-error";
 import { writeFile } from "node:fs/promises";
-import { parseArgs, ParseArgsConfig } from "node:util";
+import { inspect, parseArgs, ParseArgsConfig } from "node:util";
 import { correlateRuns } from "./correlateResults.js";
 import { generateAutoRestErrorReport, generateLintDiffReport } from "./generateReport.js";
 import { getRunList } from "./processChanges.js";
@@ -67,13 +67,13 @@
   // TODO: Handle trailing slashes properly
   if (!beforeArg || !(await pathExists(beforeArg as string))) {
     validArgs = false;
-    console.log(`--before must be a valid path. Value passed: ${beforeArg || "<empty>"}`);
+    console.log(`--before must be a valid path. Value passed: ${inspect(beforeArg) || "<empty>"}`);
   }
 
   // TODO: Handle trailing slashes properly
   if (!afterArg || !(await pathExists(afterArg as string))) {
     validArgs = false;
-    console.log(`--after must be a valid path. Value passed: ${afterArg || "<empty>"}`);
+    console.log(`--after must be a valid path. Value passed: ${inspect(afterArg) || "<empty>"}`);
   }
 
   if (!changedFilesPath || !(await pathExists(changedFilesPath as string))) {
@@ -121,7 +121,7 @@
   } catch (error) {
     if (error instanceof SpecModelError) {
       console.log("\n❌ Error building Spec Model from changed file list:");
-      console.log(`${error}`);
+      console.log(`${inspect(error)}`);
 
       process.exitCode = 1;
       return;

eng/tools/lint-diff/src/lintdiff-types.ts

@@ -1,3 +1,3 @@
 import { Readme } from "@azure-tools/specs-shared/readme";
 import { ExecException } from "node:child_process";
 
@@ -14,7 +14,7 @@
 
 export interface AutoRestMessage {
   level: "information" | "warning" | "error" | "debug" | "verbose" | "fatal";
-  code?: any;
+  code?: unknown;
   message: string;
   readme?: string;
   tag?: string;

eng/tools/lint-diff/src/markdown-utils.ts

@@ -1,6 +1,7 @@
 import { Readme } from "@azure-tools/specs-shared/readme";
 import { kebabCase } from "change-case";
-import { marked } from "marked";
+import { marked, Tokens } from "marked";
+import { inspect } from "util";
 
 export enum MarkdownType {
   Arm = "arm",
@@ -88,9 +89,9 @@
     if (!response.ok) {
       throw new Error(`HTTP ${response.status}: ${response.statusText}`);
     }
-  } catch (e: any) {
+  } catch (e) {
     // TODO: Retry? Fail ungracefully?
-    console.log(`GET ${docUrl} failed with ${e.message} .`);
+    console.log(`GET ${docUrl} failed with ${inspect(e)}.`);
     rpcInfoCache.set(ruleName, rpcRules);
     return rpcRules;
   }
@@ -101,13 +102,13 @@
     const token = tokens[i];
     if (
       token.type === "heading" &&
-      token.depth >= 1 &&
-      token.text.trim().toLowerCase() === "related arm guideline code"
+      (token as Tokens.Heading).depth >= 1 &&
+      (token as Tokens.Heading).text.trim().toLowerCase() === "related arm guideline code"
     ) {
       // The next token should be a list
       const next = tokens[i + 1];
-      if (next && next.type === "list" && Array.isArray(next.items)) {
-        for (const item of next.items) {
+      if (next && next.type === "list") {
+        for (const item of (next as Tokens.List).items) {
           // item.text may contain comma-separated codes
           if (typeof item.text === "string") {
             rpcRules.push(...item.text.split(",").map((c: string) => c.trim()));

eng/tools/lint-diff/src/processChanges.ts

@@ -1,3 +1,3 @@
 import { readme, swagger } from "@azure-tools/specs-shared/changed-files";
 import { SpecModel } from "@azure-tools/specs-shared/spec-model";
 import deepEqual from "deep-eql";
@@ -82,7 +82,7 @@
 
   // Get affected services from changed files
   // e.g. specification/service1/readme.md -> specification/service1
-  const affectedServiceDirectories = await getAffectedServices(existingChangedFiles);
+  const affectedServiceDirectories = getAffectedServices(existingChangedFiles);
 
   // Build service models of affected services
   const specModels = new Map<string, SpecModel>();
@@ -233,10 +233,10 @@
  * @param changedFiles a list of changed files
  * @returns A list of "services" that are affected by the changed files
  */
-export async function getAffectedServices(changedFiles: string[]) {
+export function getAffectedServices(changedFiles: string[]) {
   const affectedServices = new Set<string>();
   for (const file of changedFiles) {
-    const service = await getService(file);
+    const service = getService(file);
     if (service) {
       affectedServices.add(service);
     }

eng/tools/lint-diff/src/runChecks.ts

@@ -1,4 +1,4 @@
-import { ExecError, execNpmExec, isExecError } from "@azure-tools/specs-shared/exec";
+import { execNpmExec, isExecError } from "@azure-tools/specs-shared/exec";
 import { debugLogger } from "@azure-tools/specs-shared/logger";
 import { join } from "path";
 
@@ -22,14 +22,14 @@
   for (const [readme, tags] of runList.entries()) {
     const changedFilePath = join(path, readme);
 
-    let openApiType = await getOpenapiType(tags.readme);
+    const openApiType = await getOpenapiType(tags.readme);
 
     // From momentOfTruth.ts:executeAutoRestWithLintDiff
     // This is a quick workaround for https://github.com/Azure/azure-sdk-tools/issues/6549
     // We override the openapi-subtype with the value of openapi-type,
     // to prevent LintDiff from reading openapi-subtype from the AutoRest config file (README)
     // and overriding openapi-type with it.
-    let openApiSubType = openApiType;
+    const openApiSubType = openApiType;
 
     // If the tags array is empty run the loop once but with a null tag
     const coalescedTags = tags.changedTags?.size ? [...tags.changedTags] : [null];
@@ -77,16 +77,15 @@
           throw error;
         }
 
-        const execError = error as ExecError;
         lintDiffResult = {
           autorestCommand,
           rootPath: path,
           readme: tags.readme,
           tag: tag ? tag : "",
           openApiType,
-          error: execError,
-          stdout: execError.stdout || "",
-          stderr: execError.stderr || "",
+          error,
+          stdout: error.stdout || "",
+          stderr: error.stderr || "",
         } as AutorestRunResult;
 
         logAutorestExecutionErrors(lintDiffResult);

eng/tools/lint-diff/src/util.ts

@@ -31,7 +31,9 @@ export async function pathExists(path: string): Promise<boolean> {
 /* v8 ignore start */
 export async function getDependencyVersion(dependenciesDir: string): Promise<string> {
   const packageJsonPath = join(dependenciesDir, "package.json");
-  const packageJson = JSON.parse(await readFile(packageJsonPath, { encoding: "utf-8" }));
+  const packageJson = JSON.parse(await readFile(packageJsonPath, { encoding: "utf-8" })) as {
+    version?: string;
+  };
   const version = packageJson.version;
   if (!version) {
     throw new Error(`Version not found in package.json at ${packageJsonPath}`);

eng/tools/lint-diff/test/correlateResults.test.ts

@@ -297,7 +297,7 @@ describe("isSameSources", () => {
   });
 });
 
-describe("getLintDiffViolations", async () => {
+describe("getLintDiffViolations", () => {
   function createRunResult(stdout: string, stderr: string = ""): AutorestRunResult {
     return {
       rootPath: "string",
@@ -359,39 +359,39 @@ describe("getLintDiffViolations", async () => {
 });
 
 describe("arrayIsEqual", () => {
-  test("returns true for equal arrays", async () => {
+  test("returns true for equal arrays", () => {
     const a = ["a", "b", "c"];
     const b = ["a", "b", "c"];
 
     const result = arrayIsEqual(a, b);
     expect(result).toEqual(true);
   });
 
-  test("returns false for different arrays", async () => {
+  test("returns false for different arrays", () => {
     const a = ["a", "b", "c"];
     const b = ["a", "b", "d"];
 
     const result = arrayIsEqual(a, b);
     expect(result).toEqual(false);
   });
 
-  test("returns false for different lengths", async () => {
+  test("returns false for different lengths", () => {
     const a = ["a", "b", "c"];
     const b = ["a", "b"];
 
     const result = arrayIsEqual(a, b);
     expect(result).toEqual(false);
   });
 
-  test("returns true for empty arrays", async () => {
+  test("returns true for empty arrays", () => {
     const a: string[] = [];
     const b: string[] = [];
 
     const result = arrayIsEqual(a, b);
     expect(result).toEqual(true);
   });
 
-  test("returns true for equal arrays with different types", async () => {
+  test("returns true for equal arrays with different types", () => {
     const a = ["a", 1, "c"];
     const b = ["a", 1, "c"];
 

eng/tools/lint-diff/test/generateReport.test.ts

@@ -23,7 +23,7 @@ import { isWindows } from "./test-util.js";
 import { vol } from "memfs";
 
 vi.mock("node:fs/promises", async () => {
-  const memfs = (await vi.importActual("memfs")) as typeof import("memfs");
+  const memfs = await vi.importActual<typeof import("memfs")>("memfs");
   return {
     ...memfs.fs.promises,
   };

eng/tools/lint-diff/test/processChanges.fs.test.ts

@@ -6,7 +6,7 @@ import { readFileList } from "../src/processChanges.js";
 // These tests are in a separate module because fs mocking is difficult to undo
 
 vi.mock("node:fs/promises", async () => {
-  const memfs = (await vi.importActual("memfs")) as typeof import("memfs");
+  const memfs = await vi.importActual<typeof import("memfs")>("memfs");
   return {
     ...memfs.fs.promises,
   };