[typespec-validation] Enable eslint (minimal config) (#38903)

Author: mikeharder

.github/workflows/typespec-validation-test.yaml

@@ -27,3 +27,4 @@ jobs:
     uses: ./.github/workflows/_reusable-eng-tools-test.yaml
     with:
       package: typespec-validation
+      lint: true

eng/tools/typespec-validation/eslint.config.js

@@ -0,0 +1,33 @@
+// 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.recommended,
+  // TODO: Enable "recommendedTypeChecked" rules, fix all violations
+  // 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,
+      // },
+    },
+  },
+  {
+    // TODO: Remove exclusion for "test/**"
+    ignores: ["coverage/**", "dist/**", "test/**"],
+  },
+);

eng/tools/typespec-validation/package.json

@@ -17,19 +17,24 @@
     "yaml": "^2.4.2"
   },
   "devDependencies": {
+    "@eslint/js": "^9.22.0",
     "@types/debug": "^4.1.12",
     "@types/node": "^20.0.0",
     "@vitest/coverage-v8": "^3.1.2",
+    "eslint": "^9.22.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"
   },
   "scripts": {
     "build": "tsc --build",
+    "check": "npm run build && npm run lint && npm run format:check && npm run test:ci",
     "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"
   },

eng/tools/typespec-validation/src/index.ts

@@ -12,7 +12,7 @@ import { SdkTspConfigValidationRule } from "./rules/sdk-tspconfig-validation.js"
 import { fileExists, getSuppressions, normalizePath } from "./utils.js";
 
 // Context argument may add new properties or override checkingAllSpecs
-export var context: Record<string, any> = { checkingAllSpecs: false };
+export let context: Record<string, unknown> = { checkingAllSpecs: false };
 
 export async function main() {
   const args = process.argv.slice(2);

eng/tools/typespec-validation/src/rules/compile.ts

@@ -18,7 +18,7 @@ export class CompileRule implements Rule {
     let errorOutput = "";
 
     if (await fileExists(path.join(folder, "main.tsp"))) {
-      let [err, stdout, stderr] = await runNpm([
+      const [err, stdout, stderr] = await runNpm([
         "exec",
         "--no",
         "--",
@@ -178,7 +178,7 @@ export class CompileRule implements Rule {
 
     const clientTsp = path.join(folder, "client.tsp");
     if (await fileExists(clientTsp)) {
-      let [err, stdout, stderr] = await runNpm([
+      const [err, stdout, stderr] = await runNpm([
         "exec",
         "--no",
         "--",

eng/tools/typespec-validation/src/rules/folder-structure.ts

@@ -136,7 +136,7 @@ export class FolderStructureRule implements Rule {
           success = false;
         }
 
-        const rpNamespaceRegex = /^[A-Za-z0-9\.]+$/;
+        const rpNamespaceRegex = /^[A-Za-z0-9.]+$/;
         const rpNamespaceFolder = folderStruct[folderStruct.length - 2];
 
         if (!rpNamespaceRegex.test(rpNamespaceFolder)) {

eng/tools/typespec-validation/src/rules/linter-ruleset.ts

@@ -33,7 +33,7 @@ export class LinterRulesetRule implements Rule {
 
     const mainTspExists = await fileExists(join(folder, "main.tsp"));
     const clientTspExists = await fileExists(join(folder, "client.tsp"));
-    let files = [];
+    const files = [];
     if (mainTspExists) {
       files.push("main.tsp");
     }

eng/tools/typespec-validation/src/rules/npm-prefix.ts

@@ -29,7 +29,7 @@ export class NpmPrefixRule implements Rule {
     const actual_npm_prefix = normalizePath((await runNpm(["prefix"], folder))[1].trim());
 
     let success = true;
-    let stdOutput =
+    const stdOutput =
       "Expected npm prefix: " +
       expected_npm_prefix +
       "\n" +

eng/tools/typespec-validation/src/rules/sdk-tspconfig-validation.ts

@@ -1,3 +1,6 @@
+/* eslint-disable */
+// TODO: Enable eslint, fix errors
+
 import { join } from "path";
 import { Suppression } from "suppressions";
 import { parse as yamlParse } from "yaml";

eng/tools/typespec-validation/src/utils.ts

@@ -59,9 +59,9 @@ export function normalizePathImpl(folder: string, path: PlatformPath = defaultPa
 
 export async function gitDiffTopSpecFolder(folder: string) {
   const git = simpleGit(folder);
-  let topSpecFolder = folder.replace(/(^.*specification\/[^\/]*)(.*)/, "$1");
-  let stdOutput = `Running git diff on folder ${topSpecFolder}`;
-  let gitStatus = await git.status(["--porcelain", topSpecFolder]);
+  const topSpecFolder = folder.replace(/(^.*specification\/[^/]*)(.*)/, "$1");
+  const stdOutput = `Running git diff on folder ${topSpecFolder}`;
+  const gitStatus = await git.status(["--porcelain", topSpecFolder]);
 
   let success = true;
   let errorOutput: string | undefined;