Merge pull request #35 from glecaros/glecaros/suppress-emitter

feat(muzzle): Add support to suppressing emitter diagnostics.

Author: baywet

@binkylabs/muzzle/package.json

@@ -34,6 +34,7 @@
     "format": "prettier ./src/*.ts --write"
   },
   "devDependencies": {
+    "@azure-tools/typespec-autorest": "^0.63.1",
     "@azure-tools/typespec-azure-rulesets": "^0.63.0",
     "@eslint/js": "^9.39.2",
     "@types/node": "^25.0.3",

@binkylabs/muzzle/src/cli.ts

@@ -17,6 +17,7 @@ Arguments:
 
 Options:
   -r, --rule-set <ruleset>  Specify a rule set to apply (can be used multiple times)
+  -e, --emitter <emitter>   Specify an emitter to apply (can be used multiple times)
   -m, --message <message>   Suppression message to add to all suppressions
   -h, --help                Show this help message
 
@@ -30,6 +31,7 @@ Examples:
 function parseCliArguments(args: string[]): SuppressionOptions {
   let entryPoint: string | undefined;
   const ruleSets: `${string}/${string}`[] = [];
+  const emitters: string[] = [];
   let message: string | undefined;
 
   for (let i = 0; i < args.length; ) {
@@ -46,6 +48,14 @@ function parseCliArguments(args: string[]): SuppressionOptions {
       }
       ruleSets.push(ruleSet as `${string}/${string}`);
       i += 2; // Skip both the flag and its value
+    } else if (arg === "--emitter" || arg === "-e") {
+      const emitter = args[i + 1];
+      if (!emitter || emitter.startsWith("-")) {
+        console.error(`Error: ${arg} requires a value`);
+        process.exit(1);
+      }
+      emitters.push(emitter);
+      i += 2; // Skip both the flag and its value
     } else if (arg === "--message" || arg === "-m") {
       const messageValue = args[i + 1];
       if (!messageValue || messageValue.startsWith("-")) {
@@ -66,7 +76,7 @@ function parseCliArguments(args: string[]): SuppressionOptions {
     }
   }
 
-  return { entryPoint: entryPoint || "", ruleSets, message };
+  return { entryPoint: entryPoint || "", emitters, ruleSets, message };
 }
 
 const options = parseCliArguments(process.argv.slice(2));

@binkylabs/muzzle/src/index.test.ts

@@ -148,4 +148,50 @@ model FooBarArray is (Foo | Bar)[];
     // Verify the output matches expected
     expect(result.trim()).toBe(expectedOutput.trim());
   });
+
+  it("should add suppress directives related to warnings generated by an emitter", async () => {
+    const inputTypeSpec = `
+model Foo {
+  bar: "one" | integer;
+}
+`;
+
+    const expectedOutput = `
+model Foo {
+  #suppress "@azure-tools/typespec-autorest/union-unsupported" "Auto-suppressed warnings non-applicable rules during import."
+  bar: "one" | integer;
+}
+
+`;
+
+    // Write the test TypeSpec file
+    writeFileSync(testFilePath, inputTypeSpec);
+
+    // Compile the TypeSpec program with linting rules
+    const [options] = await resolveCompilerOptions(NodeHost, {
+      cwd: testDir,
+      entrypoint: testFilePath,
+      overrides: {
+        emit: ["@azure-tools/typespec-autorest"],
+      },
+    });
+
+    const program = await compile(NodeHost, testFilePath, options);
+
+    // Apply suppressions
+    await suppressEverything(program, {
+      message: "Auto-suppressed warnings non-applicable rules during import.",
+    });
+
+    // Format the file
+    const sourceCode = await NodeHost.readFile(testFilePath);
+    const formattedSource = await formatTypeSpec(sourceCode.text);
+    await NodeHost.writeFile(testFilePath, formattedSource);
+
+    // Read the modified file
+    const result = readFileSync(testFilePath, "utf-8");
+
+    // Verify the output matches expected
+    expect(result.trim()).toBe(expectedOutput.trim());
+  });
 });

@binkylabs/muzzle/src/index.ts

@@ -1,6 +1,6 @@
 import { existsSync } from "node:fs";
 import {
-  compile,
+  compile as typespecCompile,
   createSuppressCodeFix,
   DiagnosticTarget,
   NodeHost,
@@ -9,6 +9,7 @@ import {
   resolveCompilerOptions,
   applyCodeFixes,
   formatTypeSpec,
+  CompilerOptions,
 } from "@typespec/compiler";
 
 import { findSuppressTarget } from "./typespec-imports.js";
@@ -54,6 +55,22 @@ export async function suppressEverything(
   await applyCodeFixes(p.host, codeFixes);
 }
 
+async function compile(
+  entryPoint: string,
+  compilerOptions: CompilerOptions,
+): Promise<Program> {
+  /* We prevent the compiler from writing files to disk by overriding the writeFile method on the NodeHost. */
+  const originalWriteFile = NodeHost.writeFile;
+  try {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    NodeHost.writeFile = (_path: string, _content: string) => Promise.resolve();
+    return await typespecCompile(NodeHost, entryPoint, compilerOptions);
+  } finally {
+    /* Restore the original writeFile method after compilation. */
+    NodeHost.writeFile = originalWriteFile;
+  }
+}
+
 async function formatSourceFile(filePath: string) {
   const sourceCode = await NodeHost.readFile(filePath);
   const formattedSource = await formatTypeSpec(sourceCode.text);
@@ -66,8 +83,8 @@ async function formatSourceFile(filePath: string) {
 export async function parseTypeSpecAndSuppressEverything(
   options: SuppressionOptions,
 ) {
-  if (options.ruleSets.length === 0) {
-    throw new Error("At least one rule set must be provided.");
+  if (options.ruleSets.length === 0 && options.emitters.length === 0) {
+    throw new Error("At least one rule set or emitter must be provided.");
   }
 
   if (!options.entryPoint) {
@@ -85,14 +102,15 @@ export async function parseTypeSpecAndSuppressEverything(
     cwd: process.cwd(),
     entrypoint: options.entryPoint,
     overrides: {
+      emit: options.emitters,
       linter: {
         extends: options.ruleSets,
       },
     },
   });
 
   // Create the TypeSpec program
-  const program = await compile(NodeHost, options.entryPoint, compilerOptions);
+  const program = await compile(options.entryPoint, compilerOptions);
 
   if (
     program.diagnostics.some(
@@ -117,8 +135,10 @@ export async function parseTypeSpecAndSuppressEverything(
 export interface SuppressionOptions {
   /** The entry point file for the TypeSpec program */
   entryPoint: string;
-  /** The rule sets to apply. At least one rule set must be provided. */
+  /** The rule sets to apply. At least one rule or one emitter must be provided. */
   ruleSets: `${string}/${string}`[];
+  /** The emitters to apply. At least one rule or one emitter must be provided. */
+  emitters: string[];
   /** The message to include with each suppression directive */
   message?: string;
 }

README.md

@@ -12,17 +12,20 @@ Welcome to the TypeSpec Muzzle project. This project aims to provide tooling to
    npm i -g @binkylabs/muzzle
    ```
 
-1. Ensure the ruleset you want to suppress is also installed
+1. Ensure the ruleset or emitter you want to suppress is also installed
 
    ```shell
-   # example you use the @typespec/http/recommended ruleset
-   npm i @typespec/http
+   # example you use the @typespec/http/recommended ruleset and the @azure-tools/typespec-autorest emitter
+   npm i @typespec/http @azure-tools/typespec-autorest
    ```
 
 1. Suppress all warnings generated by the ruleset
 
    ```shell
    muzzle main.tsp --rule-set "@typespec/http/recommended" -m "auto-suppression"
+
+   # Or for an emitter
+   muzzle main.tsp --emiter "@azure-tools/typespec-autorest"
    ```
 
 ### API
@@ -36,8 +39,8 @@ Welcome to the TypeSpec Muzzle project. This project aims to provide tooling to
 1. Ensure the ruleset you want to suppress is also installed
 
    ```shell
-   # example you use the @typespec/http/recommended ruleset
-   npm i -S @typespec/http
+   # example you use the @typespec/http/recommended ruleset and the @azure-tools/typespec-autorest
+   npm i -S @typespec/http @azure-tools/typespec-autorest
    ```
 
 1. Use the suppression method
@@ -49,6 +52,7 @@ Welcome to the TypeSpec Muzzle project. This project aims to provide tooling to
       {
          entryPoint: "path/to/main.tsp", 
          ruleSets: ["@typespec/http/recommended"],
+         emitters: ["@azure-tools/typespec-autorest"],
          message: "auto-suppression"
       }
    );