[TypeSpec Validation] Add rule to require specifying a linter ruleset (#25804)

Author: mikeharder

eng/tools/TypeSpecValidation/package.json

@@ -9,7 +9,8 @@
     },
     "dependencies": {
         "debug": "^4.3.4",
-        "simple-git": "^3.16.0"
+        "simple-git": "^3.16.0",
+        "yaml": "^2.3.2"
     },
     "devDependencies": {
         "globby": "^13.1.1",

eng/tools/TypeSpecValidation/src/index.ts

@@ -3,6 +3,7 @@ import { CompileRule } from "./rules/compile.js";
 import { FolderStructureRule } from "./rules/folder-structure.js";
 import { FormatRule } from "./rules/format.js";
 import { GitDiffRule } from "./rules/git-diff.js";
+import { LinterRulesetRule } from "./rules/linter-ruleset.js";
 import { NpmPrefixRule } from "./rules/npm-prefix.js";
 
 export async function main() {
@@ -20,6 +21,7 @@ export async function main() {
   let rules = [
     new FolderStructureRule(),
     new NpmPrefixRule(),
+    new LinterRulesetRule(),
     new CompileRule(),
     new FormatRule(),
     new GitDiffRule(),

eng/tools/TypeSpecValidation/src/rules/linter-ruleset.ts

@@ -0,0 +1,78 @@
+import { readFile } from "fs/promises";
+import { join } from "path";
+import { parse as yamlParse } from "yaml";
+import { Rule } from "../rule.js";
+import { RuleResult } from "../rule-result.js";
+import { checkFileExists } from "../utils.js";
+
+export class LinterRulesetRule implements Rule {
+  readonly name = "LinterRuleset";
+
+  readonly description =
+    "Ensures each spec includes the correct linter ruleset (data-plane or management-plane)";
+
+  async execute(folder: string): Promise<RuleResult> {
+    let success = true;
+    let stdOutput = "";
+    let errorOutput = "";
+
+    const configFile = join(folder, "tspconfig.yaml");
+    const configText = await readFile(configFile, "utf8");
+    const config = yamlParse(configText);
+
+    const rpFolder =
+      config.options?.["@azure-tools/typespec-autorest"]?.["azure-resource-provider-folder"];
+    stdOutput += `azure-resource-provider-folder: ${JSON.stringify(rpFolder)}\n`;
+
+    const mainTspExists = await checkFileExists(join(folder, "main.tsp"));
+    const clientTspExists = await checkFileExists(join(folder, "client.tsp"));
+    let files = [];
+    if (mainTspExists) {
+      files.push("main.tsp");
+    }
+    if (clientTspExists) {
+      files.push("client.tsp");
+    }
+    stdOutput += `files: ${JSON.stringify(files)}\n`;
+
+    const linterExtends = config.linter?.extends;
+    stdOutput += `linter.extends: ${JSON.stringify(linterExtends)}`;
+
+    let requiredRuleset = "";
+    if (rpFolder?.trim()?.endsWith("resource-manager")) {
+      requiredRuleset = "@azure-tools/typespec-azure-resource-manager/all";
+    } else if (rpFolder?.trim()?.endsWith("data-plane")) {
+      requiredRuleset = "@azure-tools/typespec-azure-core/all";
+    } else if (clientTspExists && !mainTspExists) {
+      // Assume folders with no autorest setting, containing only "client.tsp" but no "main.tsp",
+      // are data-plane (e.g. HealthInsights.TrialMatcher)
+      requiredRuleset = "@azure-tools/typespec-azure-core/all";
+    } else {
+      // Cannot determine if spec is data-plane or resource-manager, so cannot know
+      // which linter ruleset is required.
+      success = false;
+      errorOutput +=
+        "tspconfig.yaml must define the following property:\n" +
+        "\n" +
+        "options:\n" +
+        '  "@azure-tools/typespec-autorest":\n' +
+        '    azure-resource-provider-folder: "data-plane" | "resource-manager"\n';
+    }
+
+    if (requiredRuleset && !linterExtends?.includes(requiredRuleset)) {
+      success = false;
+      errorOutput +=
+        "tspconfig.yaml must define the following property:\n" +
+        "\n" +
+        "linter:\n" +
+        "  extends:\n" +
+        `    - "${requiredRuleset}"`;
+    }
+
+    return {
+      success: success,
+      stdOutput: stdOutput,
+      errorOutput: errorOutput,
+    };
+  }
+}