Specify the fully qualified name of @OpenAPI.extension decorator in…

… `missing-x-ms-identifiers` linter warning. Signed-off-by: Michael Shen <[email protected]>
Azure · Apr 5, 2024 · ab3ae6d · ab3ae6d
1 parent 19a31f7
commit ab3ae6d
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 9 deletions.
diff --git a/.chronus/changes/604-2024-3-5-16-44-59.md b/.chronus/changes/604-2024-3-5-16-44-59.md
@@ -0,0 +1,7 @@
+---
+changeKind: fix
+packages:
+  - "@azure-tools/typespec-azure-resource-manager"
+---
+
+Specify the fully qualified name of `@OpenAPI.extension` decorator in `missing-x-ms-identifiers` linter warning.
diff --git a/packages/typespec-azure-resource-manager/src/rules/missing-x-ms-identifiers.ts b/packages/typespec-azure-resource-manager/src/rules/missing-x-ms-identifiers.ts
@@ -16,8 +16,8 @@ export const missingXmsIdentifiersRule = createRule({
   severity: "warning",
   url: "https://azure.github.io/typespec-azure/docs/libraries/azure-resource-manager/rules/missing-x-ms-identifiers",
   messages: {
-    default: `Missing identifying properties of objects in the array item, please add @extension("x-ms-identifiers", [<prop>]) to specify it. If there are no appropriate identifying properties, please add @extension("x-ms-identifiers",[]).`,
-    notArray: paramMessage`Value passed to @extension("x-ms-identifiers",...) was a "${"valueType"}". Pass an array of property name.`,
+    default: `Missing identifying properties of objects in the array item, please add @OpenAPI.extension("x-ms-identifiers", [<prop>]) to specify it. If there are no appropriate identifying properties, please add @OpenAPI.extension("x-ms-identifiers",[]).`,
+    notArray: paramMessage`Value passed to @OpenAPI.extension("x-ms-identifiers",...) was a "${"valueType"}". Pass an array of property name.`,
     missingProperty: paramMessage`Property "${"propertyName"}" is not found in "${"targetModelName"}". Make sure value of x-ms-identifiers extension are valid property name of the array element.`,
   },
   create(context) {

diff --git a/packages/typespec-azure-resource-manager/test/rules/missing-x-ms-identifiers.test.ts b/packages/typespec-azure-resource-manager/test/rules/missing-x-ms-identifiers.test.ts
@@ -23,7 +23,7 @@ describe("typespec-azure-core: no-enum rule", () => {
   it("emit warning for array of model without x-ms-identifiers", async () => {
     await tester
       .expect(
-        `        
+        `
         model Foo {
           bar: Bar[];
         }
@@ -35,14 +35,14 @@ describe("typespec-azure-core: no-enum rule", () => {
       )
       .toEmitDiagnostics({
         code: "@azure-tools/typespec-azure-resource-manager/missing-x-ms-identifiers",
-        message: `Missing identifying properties of objects in the array item, please add @extension("x-ms-identifiers", [<prop>]) to specify it. If there are no appropriate identifying properties, please add @extension("x-ms-identifiers",[]).`,
+        message: `Missing identifying properties of objects in the array item, please add @OpenAPI.extension("x-ms-identifiers", [<prop>]) to specify it. If there are no appropriate identifying properties, please add @OpenAPI.extension("x-ms-identifiers",[]).`,
       });
   });
 
   it("emit warning if value is not a tuple", async () => {
     await tester
       .expect(
-        `        
+        `
         model Foo {
           @OpenAPI.extension("x-ms-identifiers", "customName")
           bar: Bar[];
@@ -55,14 +55,14 @@ describe("typespec-azure-core: no-enum rule", () => {
       )
       .toEmitDiagnostics({
         code: "@azure-tools/typespec-azure-resource-manager/missing-x-ms-identifiers",
-        message: `Value passed to @extension("x-ms-identifiers",...) was a "string". Pass an array of property name.`,
+        message: `Value passed to @OpenAPI.extension("x-ms-identifiers",...) was a "string". Pass an array of property name.`,
       });
   });
 
   it("emit diagnostic when x-ms-identifiers property names are not found in the target type", async () => {
     await tester
       .expect(
-        `        
+        `
         model Foo {
           @OpenAPI.extension("x-ms-identifiers", ["not-a-prop"])
           bar: Bar[];
@@ -82,7 +82,7 @@ describe("typespec-azure-core: no-enum rule", () => {
   it(`doesn't emit diagnostic if @extension("x-ms-identifiers",...) is specified`, async () => {
     await tester
       .expect(
-        `        
+        `
         model Foo {
           @OpenAPI.extension("x-ms-identifiers", ["customName"])
           bar: Bar[];
@@ -98,7 +98,7 @@ describe("typespec-azure-core: no-enum rule", () => {
   it(`doesn't emit diagnostic if element is a primitive type`, async () => {
     await tester
       .expect(
-        `        
+        `
         model Foo {
           bar: Bar[];
         }