Allow @pattern to be provided on a scalar (#751)

fix [#732](#732)
Azure · Apr 29, 2024 · 4f8caae · 4f8caae
1 parent 74a3d6c
commit 4f8caae
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 3 deletions.
diff --git a/.chronus/changes/fix-allow-scalars-2024-3-26-23-13-19.md b/.chronus/changes/fix-allow-scalars-2024-3-26-23-13-19.md
@@ -0,0 +1,8 @@
+---
+# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
+changeKind: fix
+packages:
+  - "@azure-tools/typespec-azure-resource-manager"
+---
+
+Allow `@pattern` to be provided on a scalar
diff --git a/packages/typespec-azure-resource-manager/src/rules/arm-resource-name-pattern.ts b/packages/typespec-azure-resource-manager/src/rules/arm-resource-name-pattern.ts
@@ -1,5 +1,6 @@
 import {
   DiagnosticTarget,
+  ModelProperty,
   Program,
   SourceLocation,
   createRule,
@@ -59,8 +60,7 @@ export const armResourceNamePatternRule = createRule({
           // find the name property
           const nameProperty = resource.typespecType.properties.get("name");
           if (nameProperty !== undefined) {
-            const pattern = getPattern(program, nameProperty);
-            if (pattern === undefined) {
+            if (!hasPattern(program, nameProperty)) {
               context.reportDiagnostic({
                 target: nameProperty,
                 codefixes: [createPatternCodeFix(nameProperty)],
@@ -72,3 +72,18 @@ export const armResourceNamePatternRule = createRule({
     };
   },
 });
+
+function hasPattern(program: Program, property: ModelProperty): boolean {
+  const pattern = getPattern(program, property);
+  if (pattern !== undefined) {
+    return true;
+  }
+
+  if (property.type.kind === "Scalar") {
+    const pattern = getPattern(program, property.type);
+    if (pattern !== undefined) {
+      return true;
+    }
+  }
+  return false;
+}
diff --git a/packages/typespec-azure-resource-manager/test/rules/arm-resource-name-pattern.test.ts b/packages/typespec-azure-resource-manager/test/rules/arm-resource-name-pattern.test.ts
@@ -94,7 +94,6 @@ it("Does not emit a warning for an ARM resource that specifies `@pattern` on the
     namespace Microsoft.Contoso;
     
     model Employee is ProxyResource<{}> {
-      @doc("Name of employee")
       @pattern("^[a-zA-Z0-9-]{3,24}$")
       @key("employeeName")
       @path
@@ -114,3 +113,25 @@ it("Does not emit a warning for an ARM resource that specifies `@pattern` on the
     )
     .toBeValid();
 });
+
+it("Does not emit a warning for an ARM resource that specifies `@pattern` on the on the scalar used", async () => {
+  await tester
+    .expect(
+      `
+    @armProviderNamespace
+    @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1)
+    namespace Microsoft.Contoso;
+
+    @pattern("^[a-zA-Z0-9][a-zA-Z0-9-]{1,58}[a-zA-Z0-9]$")
+    scalar stringResourceName extends string;
+
+    model Employee is ProxyResource<{}> {
+      @key("employeeName")
+      @path
+      @segment("employees")
+      name: stringResourceName;
+    }
+    `
+    )
+    .toBeValid();
+});