@azure-tools/typespec-azure-resource-manager/dist/src/rules/arm-resource-name-pattern.js

TypeSpec Azure Resource Manager library

import { createRule, defineCodeFix, getPattern, getSourceLocation, } from "@typespec/compiler";
import { getArmResources } from "../resource.js";
// TODO: Replace this with a reusable implementation from the compiler package when implemented.
// Issue: https://github.com/microsoft/typespec/issues/3044
function createPatternCodeFix(diagnosticTarget) {
    return defineCodeFix({
        id: "add-pattern-decorator",
        label: "Add `@pattern` decorator to the resource name property with the default ARM pattern.",
        fix: (context) => {
            const location = getSourceLocation(diagnosticTarget);
            const { lineStart, indent } = findLineStartAndIndent(location);
            const updatedLocation = { ...location, pos: lineStart };
            return context.prependText(updatedLocation, `${indent}@pattern("^[a-zA-Z0-9-]{3,24}$")\n`);
        },
    });
}
function findLineStartAndIndent(location) {
    const text = location.file.text;
    let pos = location.pos;
    let indent = 0;
    while (pos > 0 && text[pos - 1] !== "\n") {
        if ([" ", "\t", "\n"].includes(text[pos - 1])) {
            indent++;
        }
        else {
            indent = 0;
        }
        pos--;
    }
    return { lineStart: pos, indent: location.file.text.slice(pos, pos + indent) };
}
/**
 * Verify that a delete operation only
 */
export const armResourceNamePatternRule = createRule({
    name: "arm-resource-name-pattern",
    severity: "warning",
    url: "https://azure.github.io/typespec-azure/docs/libraries/azure-resource-manager/rules/resource-name-pattern",
    description: "The resource name parameter should be defined with a 'pattern' restriction.",
    messages: {
        default: `The resource name parameter should be defined with a 'pattern' restriction.  Please use 'ResourceNameParameter' to specify the name parameter with options to override default pattern RegEx expression.`,
    },
    create(context) {
        return {
            root: (program) => {
                const resources = getArmResources(program);
                for (const resource of resources) {
                    // find the name property
                    const nameProperty = resource.typespecType.properties.get("name");
                    if (nameProperty !== undefined) {
                        if (!hasPattern(program, nameProperty)) {
                            context.reportDiagnostic({
                                target: nameProperty,
                                codefixes: [createPatternCodeFix(nameProperty)],
                            });
                        }
                    }
                }
            },
        };
    },
});
function hasPattern(program, property) {
    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;
}
//# sourceMappingURL=arm-resource-name-pattern.js.map