Merge branch 'main' of https://github.com/Azure/typespec-azure into e…

…ndpoint_design
Azure · Mar 22, 2024 · d0ff3e8 · d0ff3e8
2 parents 85a97ac + 3b30c1e
commit d0ff3e8
Show file tree

Hide file tree

Showing 25 changed files with 289 additions and 242 deletions.
diff --git a/.chronus/changes/cleanup-autorest-diagnostics-2024-2-12-17-55-36.md b/.chronus/changes/cleanup-autorest-diagnostics-2024-2-12-17-55-36.md
@@ -0,0 +1,8 @@
+---
+# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
+changeKind: internal
+packages:
+  - "@azure-tools/typespec-autorest"
+---
+
+Cleanup autorest diagnostics
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/.chronus/changes/enum_fixed-2024-2-21-15-54-49.md b/.chronus/changes/enum_fixed-2024-2-21-15-54-49.md
@@ -0,0 +1,7 @@
+---
+changeKind: breaking
+packages:
+  - "@azure-tools/typespec-client-generator-core"
+---
+
+enums are always fixed after we switch to use union to represent extensible enum
diff --git a/.chronus/changes/fix-no-enum-code-fix-include-name-2024-2-22-8-14-39.md b/.chronus/changes/fix-no-enum-code-fix-include-name-2024-2-22-8-14-39.md
@@ -0,0 +1,7 @@
+---
+changeKind: fix
+packages:
+  - "@azure-tools/typespec-azure-core"
+---
+
+`no-enum` rule codefix now convert to named variant when the enum had not values (e.g. `enum E {a, b}`)
diff --git a/.chronus/changes/lintdiff-EnablePostRule-2024-2-21-19-18-34.md b/.chronus/changes/lintdiff-EnablePostRule-2024-2-21-19-18-34.md
@@ -0,0 +1,8 @@
+---
+# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
+changeKind: internal
+packages:
+  - "@azure-tools/typespec-azure-resource-manager"
+---
+
+Ensure `arm-post-response-codes` rule is in the default ruleset.
diff --git a/.chronus/changes/remove-projected-name-property-naming-rule-2024-2-21-15-32-12.md b/.chronus/changes/remove-projected-name-property-naming-rule-2024-2-21-15-32-12.md
@@ -0,0 +1,8 @@
+---
+# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
+changeKind: fix
+packages:
+  - "@azure-tools/typespec-azure-core"
+---
+
+Update `property-name-conflict` linter rule to stop looking and recommending `@projectedName` in favor of `@clientName`
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1,4 +1,4 @@
-* @bterlson @daviwil @markcowl @allenjzhang @timotheeguerin
+* @bterlson @markcowl @allenjzhang @timotheeguerin
 
 /packages/typespec-client-generator-core @lmazuel @m-nash @iscai-msft @srnagar @joheredi
 

diff --git a/core b/core
diff --git a/docs/howtos/DataPlane Generation - DPG/04renaming.mdx b/docs/howtos/DataPlane Generation - DPG/04renaming.mdx
@@ -5,6 +5,11 @@ import TabItem from "@theme/TabItem";
 
 This page documents how to customize names for client generations in DPG. For an overview of the setup, please visit the setup page.
 
+:::note
+The TypeSpec compiler provides an `@encodedName` decorator that allows changing the name of the property for a given serialization format.
+However in Azure we recommend that you define the property name as the value sent on the wire and use the `@clientName` decorator to change the name of the generated property.
+:::
+
 ## Default behaviors
 
 By default, any language code generator will assume the TYPESPEC name is the client. For clarity, generators do not attempt to do any auto-magic rename.

diff --git a/docs/libraries/azure-core/reference/linter.md b/docs/libraries/azure-core/reference/linter.md
@@ -52,7 +52,7 @@ Available ruleSets:
 | `@azure-tools/typespec-azure-core/no-multiple-discriminator`                                                         | Classes should have at most one discriminator.                                                                                                       |
 | `@azure-tools/typespec-azure-core/no-rest-library-interfaces`                                                        | Resource interfaces from the TypeSpec.Rest.Resource library are incompatible with Azure.Core.                                                        |
 | `@azure-tools/typespec-azure-core/no-unknown`                                                                        | Azure services must not have properties of type `unknown`.                                                                                           |
-| `@azure-tools/typespec-azure-core/property-name-conflict`                                                            | Avoid naming conflicts.                                                                                                                              |
+| `@azure-tools/typespec-azure-core/property-name-conflict`                                                            | Avoid naming conflicts between a property and a model of the same name.                                                                              |
 | `@azure-tools/typespec-azure-core/bad-record-type`                                                                   | Identify bad record definitions.                                                                                                                     |
 | `@azure-tools/typespec-azure-core/documentation-required`                                                            | Require documentation over enums, models, and operations.                                                                                            |
 | `@azure-tools/typespec-azure-core/key-visibility-required`                                                           | Key properties need to have an explicit visibility setting.                                                                                          |

diff --git a/docs/libraries/azure-resource-manager/reference/linter.md b/docs/libraries/azure-resource-manager/reference/linter.md
@@ -30,6 +30,7 @@ Available ruleSets:
 | `@azure-tools/typespec-azure-resource-manager/arm-common-types-version`                                                                                          | Specify the ARM common-types version using @armCommonTypesVersion.                 |
 | [`@azure-tools/typespec-azure-resource-manager/arm-delete-operation-response-codes`](/libraries/azure-resource-manager/rules/delete-operation-response-codes.md) | Ensure delete operations have the appropriate status codes.                        |
 | [`@azure-tools/typespec-azure-resource-manager/arm-put-operation-response-codes`](/libraries/azure-resource-manager/rules/put-operation-response-codes.md)       | Ensure put operations have the appropriate status codes.                           |
+| [`@azure-tools/typespec-azure-resource-manager/arm-post-operation-response-codes`](/libraries/azure-resource-manager/rules/post-operation-response-codes.md)     | Ensure post operations have the appropriate status codes.                          |
 | `@azure-tools/typespec-azure-resource-manager/arm-resource-action-no-segment`                                                                                    | `@armResourceAction` should not be used with `@segment`.                           |
 | `@azure-tools/typespec-azure-resource-manager/arm-resource-duplicate-property`                                                                                   | Warn about duplicate properties in resources.                                      |
 | `@azure-tools/typespec-azure-resource-manager/arm-resource-invalid-envelope-property`                                                                            | Check for invalid resource envelope properties.                                    |

diff --git a/packages/typespec-autorest/src/lib.ts b/packages/typespec-autorest/src/lib.ts
@@ -173,24 +173,6 @@ const EmitterOptionsSchema: JSONSchemaType<AutorestEmitterOptions> = {
 const libDef = {
   name: "@azure-tools/typespec-autorest",
   diagnostics: {
-    "security-service-namespace": {
-      severity: "error",
-      messages: {
-        default: "Cannot add security details to a namespace other than the service namespace.",
-      },
-    },
-    "resource-namespace": {
-      severity: "error",
-      messages: {
-        default: "Resource goes on namespace",
-      },
-    },
-    "missing-path-param": {
-      severity: "error",
-      messages: {
-        default: paramMessage`Path contains parameter ${"param"} but wasn't found in given parameters`,
-      },
-    },
     "duplicate-body-types": {
       severity: "error",
       messages: {
@@ -242,24 +224,6 @@ const libDef = {
         default: paramMessage`Invalid type '${"type"}' for a default value`,
       },
     },
-    "invalid-property-type-for-collection-format": {
-      severity: "error",
-      messages: {
-        default: "The collectionFormat can only be applied to model property with type 'string[]'.",
-      },
-    },
-    "invalid-collection-format": {
-      severity: "error",
-      messages: {
-        default: "The format should be one of 'csv','ssv','tsv','pipes' and 'multi'.",
-      },
-    },
-    "non-recommended-collection-format": {
-      severity: "warning",
-      messages: {
-        default: "The recommendation of collection format are 'csv' and 'multi'.",
-      },
-    },
     "invalid-multi-collection-format": {
       severity: "error",
       messages: {

diff --git a/packages/typespec-azure-core/README.md b/packages/typespec-azure-core/README.md
@@ -56,7 +56,7 @@ Available ruleSets:
 | `@azure-tools/typespec-azure-core/no-multiple-discriminator`                                                                                                 | Classes should have at most one discriminator.                                                                                                       |
 | `@azure-tools/typespec-azure-core/no-rest-library-interfaces`                                                                                                | Resource interfaces from the TypeSpec.Rest.Resource library are incompatible with Azure.Core.                                                        |
 | `@azure-tools/typespec-azure-core/no-unknown`                                                                                                                | Azure services must not have properties of type `unknown`.                                                                                           |
-| `@azure-tools/typespec-azure-core/property-name-conflict`                                                                                                    | Avoid naming conflicts.                                                                                                                              |
+| `@azure-tools/typespec-azure-core/property-name-conflict`                                                                                                    | Avoid naming conflicts between a property and a model of the same name.                                                                              |
 | `@azure-tools/typespec-azure-core/bad-record-type`                                                                                                           | Identify bad record definitions.                                                                                                                     |
 | `@azure-tools/typespec-azure-core/documentation-required`                                                                                                    | Require documentation over enums, models, and operations.                                                                                            |
 | `@azure-tools/typespec-azure-core/key-visibility-required`                                                                                                   | Key properties need to have an explicit visibility setting.                                                                                          |

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,
@@ -48,7 +50,7 @@ function createEnumToExtensibleUnionCodeFix(en: Enum): CodeFix {
                 ? node.value.value
                 : `"${node.value.value}"`
             }`
-          : `"${node.id.sv}"`;
+          : `${node.id.sv}: "${node.id.sv}"`;
     }
   }
 
@@ -131,7 +133,7 @@ function getNodeAnnotations(node: Node): string {
   }
 
   for (let i = endOfTrivia; i < node.end; i++) {
-    if (source[i] === " ") {
+    if (source[i] === " " || source[i] === "\n") {
       endOfTrivia = i + 1;
     } else {
       break;

diff --git a/packages/typespec-azure-core/src/rules/property-naming.ts b/packages/typespec-azure-core/src/rules/property-naming.ts
@@ -1,34 +1,20 @@
-import { ModelProperty, createRule, getProjectedNames, paramMessage } from "@typespec/compiler";
+import { ModelProperty, createRule, paramMessage } from "@typespec/compiler";
 import { isExcludedCoreType } from "./utils.js";
 
 export const propertyNameRule = createRule({
   name: "property-name-conflict",
-  description: "Avoid naming conflicts.",
+  description: "Avoid naming conflicts between a property and a model of the same name.",
   severity: "warning",
   messages: {
-    default: paramMessage`Property '${"propertyName"}' having the same name as its enclosing model will cause problems with C# code generation. Consider renaming the property directly or using the @projectedName decorator to rename the property for C#.`,
-    projectedName: paramMessage`Use of @projectedName on property '${"propertyName"}' results in '${"propertyName"}' having the same name as its enclosing type in C#. Please use a different @projectedName value.`,
+    default: paramMessage`Property '${"propertyName"}' having the same name as its enclosing model will cause problems with C# code generation. Consider renaming the property directly or using the @clientName("newName", "csharp") decorator to rename the property for C#.`,
   },
   create(context) {
     return {
       modelProperty: (property: ModelProperty) => {
         if (isExcludedCoreType(context.program, property)) return;
-        const projectedNames = getProjectedNames(context.program, property);
         const modelName = property.model?.name.toLocaleLowerCase();
         const propertyName = property.name.toLocaleLowerCase();
-        const csharpProjection = projectedNames?.get("csharp")?.toLocaleLowerCase();
-        const clientProjection = projectedNames?.get("client")?.toLocaleLowerCase();
-        if (
-          csharpProjection === modelName || // csharp projection conflicts with model name
-          (clientProjection === modelName && !csharpProjection) // client projection conflicts with model name and there is no csharp projection
-        ) {
-          context.reportDiagnostic({
-            messageId: "projectedName",
-            format: { propertyName: property.name },
-            target: property,
-          });
-        } else if (propertyName === modelName && !(csharpProjection || clientProjection)) {
-          // warning if the property name conflicts with the model name and there is no csharp or client projected name
+        if (propertyName === modelName) {
           context.reportDiagnostic({
             format: { propertyName: property.name },
             target: property,

diff --git a/packages/typespec-azure-core/src/rules/require-docs.ts b/packages/typespec-azure-core/src/rules/require-docs.ts
@@ -12,7 +12,7 @@ export const requireDocumentation = createRule({
   description: "Require documentation over enums, models, and operations.",
   severity: "warning",
   messages: {
-    default: paramMessage`The ${"kind"} named '${"name"}' should have a documentation or description, please use decorator @doc to add it.`,
+    default: paramMessage`The ${"kind"} named '${"name"}' should have a documentation or description, use doc comment /** */ to provide it.`,
   },
   create(context) {
     return {

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
@@ -60,7 +82,31 @@ describe("typespec-azure-core: no-enum rule", () => {
           union PetKind {
             string,
 
-            "cat", "dog",
+            cat: "cat", dog: "dog",
+          }
+        `);
+    });
+
+    it("keeps new lines", async () => {
+      await tester
+        .expect(
+          `        
+          enum PetKind {
+            /** cat doc */
+            cat,
+            /** dog doc */
+            dog
+          }
+          `
+        )
+        .applyCodeFix("enum-to-extensible-union").toEqual(`
+          union PetKind {
+            string,
+
+            /** cat doc */
+            cat: "cat",
+            /** dog doc */
+            dog: "dog",
           }
         `);
     });
@@ -115,14 +161,14 @@ describe("typespec-azure-core: no-enum rule", () => {
             /** cat */
             @doc("cat")
             #suppress "cat"
-            "cat", 
+            cat: "cat", 
             
             // dog
 
             /** dog */
             @doc("dog")
             #suppress "dog"
-            "dog",
+            dog: "dog",
 
             // end
           }