Adding @promotion decorator and learnMoreDocs validation

packages/typespec-azure-portal-core/lib/decorators.tsp

@@ -18,7 +18,7 @@ extern dec browse(target: Model, options: BrowseOptions);
 /**
  * Provides a Model customizing deployment promotion apiVersion for ARM resource.
  * The apiVersion will be used as a version to deploy to Portal.
- * @param options Property options provides promotion information of the resourceType. 
+ * @param options Property options provides promotion information of the resourceType.
  */
 extern dec promotion(target: Model, options: PromotionOptions);
 

packages/typespec-azure-portal-core/src/decorators.ts

@@ -15,9 +15,9 @@ import {
   resolvePath,
   validateDecoratorUniqueOnNode,
 } from "@typespec/compiler";
+import * as versioning from "@typespec/versioning";
 import { PortalCoreKeys, reportDiagnostic } from "./lib.js";
 import { AboutOptions, BrowseOptions, PromotionOptions, marketplaceOfferOptions } from "./types.js";
-import * as versioning from "@typespec/versioning";
 
 /**
  * This is a Browse decorator which will be use to put more info on the browse view.
@@ -75,8 +75,10 @@ export function $promotion(context: DecoratorContext, target: Model, options: Mo
     if (autoUpdate) {
       promotionResult.autoUpdate = true;
     }
-    if(versions && versions[1] && versions[1].size > 0) {
-      const versionsList = (versions[1] as versioning.VersionMap).getVersions().map(version => version.value);
+    if (versions && versions[1] && versions[1].size > 0) {
+      const versionsList = (versions[1] as versioning.VersionMap)
+        .getVersions()
+        .map((version) => version.value);
       if (!versionsList.includes(currentApiVersion)) {
         reportDiagnostic(program, {
           code: "invalid-apiversion",
@@ -118,7 +120,7 @@ export function checkIsValidApiVersion(program: Program, target: Model, version:
       target,
     });
     return false;
-  };
+  }
   return true;
 }
 
@@ -230,18 +232,18 @@ export function $about(context: DecoratorContext, target: Model, options: Model)
 
 function checkIsValidLinks(program: Program, target: Model, links: Type[]) {
   let valid = true;
-  links.forEach(value => {
+  links.forEach((value) => {
     const pattern = /^https:\/\//;
-      if (!(value as StringLiteral).value.match(pattern)) {
-        reportDiagnostic(program, {
-          code: "invalid-link",
-          format: {
-            link: (value as StringLiteral).value
-          },
-          target,
-        });
-        valid = false;
-      }
+    if (!(value as StringLiteral).value.match(pattern)) {
+      reportDiagnostic(program, {
+        code: "invalid-link",
+        format: {
+          link: (value as StringLiteral).value,
+        },
+        target,
+      });
+      valid = false;
+    }
   });
   return valid;
 }

packages/typespec-azure-portal-core/src/lib.ts

@@ -30,24 +30,24 @@ export const $lib = createTypeSpecLibrary({
     "invalid-apiversion": {
       severity: "error",
       messages: {
-        versionsList: paramMessage `@promotion apiVersion ${"version"} is not listed on ARM service API Version lists`,
-        serviceVersion: paramMessage `@promotion apiVersion ${"version"} is not same as the @service.version`,
-        promotionVersion: paramMessage `@promotion apiVersion ${"version"} is invalid, should be yyyy-mm-dd or yyyy-mm-dd-preview format`
+        versionsList: paramMessage`@promotion apiVersion ${"version"} is not listed on ARM service API Version lists`,
+        serviceVersion: paramMessage`@promotion apiVersion ${"version"} is not same as the @service.version`,
+        promotionVersion: paramMessage`@promotion apiVersion ${"version"} is invalid, should be yyyy-mm-dd or yyyy-mm-dd-preview format`,
       },
     },
     "invalid-link": {
       severity: "error",
       messages: {
-        default: paramMessage `@about learnMoreDocs ${"link"} does not start with https://`,
+        default: paramMessage`@about learnMoreDocs ${"link"} does not start with https://`,
       },
-    }
+    },
   },
   state: {
     browse: { description: "State for the @browse decorator" },
     about: { description: "State for the @about decorator" },
     marketplaceOffer: { description: "State for the @marketplaceOffer decorator" },
     displayName: { description: "State for the @displayName decorator" },
-    promotion: {description: "State for the @promotion decorator" },
+    promotion: { description: "State for the @promotion decorator" },
   },
 } as const);
 

packages/typespec-azure-portal-core/test/decorators.test.ts

@@ -93,14 +93,16 @@ describe("TypeSpec-Azure-Portal-Core decorators test", () => {
       learnMoreDocs: ["www.azure.com", "www.portal.azure.com"],
       })`;
     const diagnostics = await runner.diagnose(createTestSpec(undefined, aboutTest));
-    expectDiagnostics(diagnostics, [{
-      code: "@azure-tools/typespec-azure-portal-core/invalid-link",
-      message: "@about learnMoreDocs www.azure.com does not start with https://",
-    }, 
-    {
-      code: "@azure-tools/typespec-azure-portal-core/invalid-link",
-      message: "@about learnMoreDocs www.portal.azure.com does not start with https://",
-    }]);
+    expectDiagnostics(diagnostics, [
+      {
+        code: "@azure-tools/typespec-azure-portal-core/invalid-link",
+        message: "@about learnMoreDocs www.azure.com does not start with https://",
+      },
+      {
+        code: "@azure-tools/typespec-azure-portal-core/invalid-link",
+        message: "@about learnMoreDocs www.portal.azure.com does not start with https://",
+      },
+    ]);
   });
 
   it("@marketplaceOffer.id", async () => {
@@ -112,7 +114,9 @@ describe("TypeSpec-Azure-Portal-Core decorators test", () => {
 
   it("@marketplaceOffer.id with space", async () => {
     const marketplaceOffer = `@test @marketplaceOffer({id: "id space"})`;
-    const diagnostics = await runner.diagnose(createTestSpec(undefined, undefined, marketplaceOffer));
+    const diagnostics = await runner.diagnose(
+      createTestSpec(undefined, undefined, marketplaceOffer)
+    );
     expectDiagnostics(diagnostics, {
       code: "@azure-tools/typespec-azure-portal-core/invalid-offer-id",
       message: "@marketplaceOffer id cannot have a blank space.",
@@ -121,15 +125,19 @@ describe("TypeSpec-Azure-Portal-Core decorators test", () => {
 
   it("@promotion", async () => {
     const promotion = `@test @promotion({apiVersion: "2024-02-20-preview"})`;
-    const { Foo } = await runner.compile(createTestSpec(undefined, undefined, undefined, promotion));
+    const { Foo } = await runner.compile(
+      createTestSpec(undefined, undefined, undefined, promotion)
+    );
     const promotionOptions = getPromotion(runner.program, Foo);
     strictEqual(promotionOptions.apiVersion, "2024-02-20-preview");
     strictEqual(promotionOptions.autoUpdate, false);
   });
 
   it("@promotion with wrong apiVersion", async () => {
     const promotion = `@test @promotion({apiVersion: "2024-02-20"})`;
-    const diagnostics = await runner.diagnose(createTestSpec(undefined, undefined, undefined, promotion));
+    const diagnostics = await runner.diagnose(
+      createTestSpec(undefined, undefined, undefined, promotion)
+    );
     expectDiagnostics(diagnostics, {
       code: "@azure-tools/typespec-azure-portal-core/invalid-apiversion",
       message: "@promotion apiVersion 2024-02-20 is not listed on ARM service API Version lists",
@@ -138,10 +146,13 @@ describe("TypeSpec-Azure-Portal-Core decorators test", () => {
 
   it("@promotion with incorrect apiVersion", async () => {
     const promotion = `@test @promotion({apiVersion: "2023-01"})`;
-    const diagnostics = await runner.diagnose(createTestSpec(undefined, undefined, undefined, promotion));
+    const diagnostics = await runner.diagnose(
+      createTestSpec(undefined, undefined, undefined, promotion)
+    );
     expectDiagnostics(diagnostics, {
       code: "@azure-tools/typespec-azure-portal-core/invalid-apiversion",
-      message: "@promotion apiVersion 2023-01 is invalid, should be yyyy-mm-dd or yyyy-mm-dd-preview format",
+      message:
+        "@promotion apiVersion 2023-01 is invalid, should be yyyy-mm-dd or yyyy-mm-dd-preview format",
     });
   });
 
@@ -150,15 +161,21 @@ describe("TypeSpec-Azure-Portal-Core decorators test", () => {
       apiVersion: Versions.v2024_02_20_preview, 
       autoUpdate: true
     })`;
-    const { Foo } = await runner.compile(createTestSpec(undefined, undefined, undefined, promotion));
+    const { Foo } = await runner.compile(
+      createTestSpec(undefined, undefined, undefined, promotion)
+    );
     const promotionOptions = getPromotion(runner.program, Foo);
     strictEqual(promotionOptions.apiVersion, "2024-02-20-preview");
     strictEqual(promotionOptions.autoUpdate, true);
   });
-
 });
 
-export function createTestSpec(browseDec?: string, aboutDec?: string, marketplaceOffer?: string, promotion?: string) {
+export function createTestSpec(
+  browseDec?: string,
+  aboutDec?: string,
+  marketplaceOffer?: string,
+  promotion?: string
+) {
   return `
     @service({title: "Microsoft.Foo"})
     @armProviderNamespace