Azure Core: Enable no-enum rule by default in all ruleset (#467)

Azure · Mar 22, 2024 · 8046715 · 8046715
1 parent 2223654
commit 8046715
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 2 deletions.
diff --git a/.chronus/changes/enable-no-enum-rule-2024-2-21-16-42-36.md b/.chronus/changes/enable-no-enum-rule-2024-2-21-16-42-36.md
@@ -0,0 +1,8 @@
+---
+# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
+changeKind: feature
+packages:
+  - "@azure-tools/typespec-azure-core"
+---
+
+Enable `no-enum` rule by default in `all` ruleset
diff --git a/packages/typespec-azure-core/src/linter.ts b/packages/typespec-azure-core/src/linter.ts
@@ -110,7 +110,7 @@ export const $linter = defineLinter({
           true,
         [`@azure-tools/typespec-azure-core/${useStandardNames.name}`]: true,
         [`@azure-tools/typespec-azure-core/${friendlyNameRule.name}`]: true,
-        [`@azure-tools/typespec-azure-core/${noEnumRule.name}`]: false,
+        [`@azure-tools/typespec-azure-core/${noEnumRule.name}`]: true,
       },
       extends: ["@typespec/http/all"],
     },

diff --git a/packages/typespec-azure-core/src/rules/no-enum.ts b/packages/typespec-azure-core/src/rules/no-enum.ts
@@ -23,9 +23,11 @@ export const noEnumRule = createRule({
   create(context) {
     return {
       enum: (en: Enum) => {
-        if (getVersionsForEnum(context.program, en).length > 0) {
+        const [_, versions] = getVersionsForEnum(context.program, en);
+        if (versions !== undefined && versions.getVersions()[0].enumMember.enum === en) {
           return;
         }
+
         context.reportDiagnostic({
           format: { enumName: en.name },
           target: en,

diff --git a/packages/typespec-azure-core/test/rules/no-enum.test.ts b/packages/typespec-azure-core/test/rules/no-enum.test.ts
@@ -31,6 +31,7 @@ describe("typespec-azure-core: no-enum rule", () => {
         },
       ]);
   });
+
   it("allows the version enum", async () => {
     await tester
       .expect(
@@ -46,6 +47,27 @@ describe("typespec-azure-core: no-enum rule", () => {
       .toBeValid();
   });
 
+  it("emit warning about other enums in versioned service", async () => {
+    await tester
+      .expect(
+        `       
+        @service
+        @versioned(Versions)
+        namespace Foo; 
+        enum Versions {
+          v1, v2
+        }
+
+        enum Bar { a,  b}
+        `
+      )
+      .toEmitDiagnostics([
+        {
+          code: "@azure-tools/typespec-azure-core/no-enum",
+        },
+      ]);
+  });
+
   describe("codefix", () => {
     it("codefix simple enum", async () => {
       await tester