@angular-eslint/eslint-plugin 19.7.0-beta.0 → 19.7.1-alpha.0

package/dist/rules/require-localize-metadata.d.ts

@@ -2,9 +2,10 @@ export type Options = [
     {
         readonly requireDescription?: boolean;
         readonly requireMeaning?: boolean;
+        readonly requireCustomId?: boolean | string;
     }
 ];
-export type MessageIds = 'requireLocalizeDescription' | 'requireLocalizeMeaning';
+export type MessageIds = 'requireLocalizeDescription' | 'requireLocalizeMeaning' | 'requireLocalizeCustomId';
 export declare const RULE_NAME = "require-localize-metadata";
 declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<MessageIds, Options, import("../utils/create-eslint-rule").RuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
 export default _default;

package/dist/rules/require-localize-metadata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"require-localize-metadata.d.ts","sourceRoot":"","sources":["../../src/rules/require-localize-metadata.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,OAAO,GAAG;IACpB;QACE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC;QACtC,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;KACnC;CACF,CAAC;AAmBF,MAAM,MAAM,UAAU,GAClB,4BAA4B,GAC5B,wBAAwB,CAAC;AAC7B,eAAO,MAAM,SAAS,8BAA8B,CAAC;;AAErD,wBAuEG"}
+{"version":3,"file":"require-localize-metadata.d.ts","sourceRoot":"","sources":["../../src/rules/require-localize-metadata.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,OAAO,GAAG;IACpB;QACE,QAAQ,CAAC,kBAAkB,CAAC,EAAE,OAAO,CAAC;QACtC,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;QAClC,QAAQ,CAAC,eAAe,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;KAC7C;CACF,CAAC;AAYF,MAAM,MAAM,UAAU,GAClB,4BAA4B,GAC5B,wBAAwB,GACxB,yBAAyB,CAAC;AAC9B,eAAO,MAAM,SAAS,8BAA8B,CAAC;;AAErD,wBAyFG"}

package/dist/rules/require-localize-metadata.js

@@ -6,12 +6,11 @@ const create_eslint_rule_1 = require("../utils/create-eslint-rule");
 const DEFAULT_OPTIONS = {
     requireDescription: false,
     requireMeaning: false,
+    requireCustomId: false,
 };
-const VALID_LOCALIZED_STRING_WITH_DESCRIPTION = new RegExp(/:(.*\|)?([\w\s]+){1}(@@.*)?:.+/);
-const VALID_LOCALIZED_STRING_WITH_MEANING = new RegExp(/:([\w\s]+\|)(.*)?(@@.*)?:.+/);
 const STYLE_GUIDE_LINK = 'https://angular.dev/guide/i18n';
-const STYLE_GUIDE_LINK_COMMON_PREPARE = `${STYLE_GUIDE_LINK}-common-prepare`;
-const STYLE_GUIDE_LINK_METADATA_FOR_TRANSLATION = `${STYLE_GUIDE_LINK_COMMON_PREPARE}#i18n-metadata-for-translation`;
+const STYLE_GUIDE_LINK_PREPARE = `${STYLE_GUIDE_LINK}/prepare`;
+const STYLE_GUIDE_LINK_METADATA_FOR_TRANSLATION = `${STYLE_GUIDE_LINK_PREPARE}#i18n-metadata-for-translation`;
 exports.RULE_NAME = 'require-localize-metadata';
 exports.default = (0, create_eslint_rule_1.createESLintRule)({
     name: exports.RULE_NAME,
@@ -32,6 +31,10 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
                         type: 'boolean',
                         default: DEFAULT_OPTIONS.requireMeaning,
                     },
+                    requireCustomId: {
+                        oneOf: [{ type: 'boolean' }, { type: 'string' }],
+                        default: DEFAULT_OPTIONS.requireCustomId,
+                    },
                 },
                 additionalProperties: false,
             },
@@ -39,35 +42,79 @@ exports.default = (0, create_eslint_rule_1.createESLintRule)({
         messages: {
             requireLocalizeDescription: `$localize tagged messages should contain a description. See more at ${STYLE_GUIDE_LINK_METADATA_FOR_TRANSLATION}`,
             requireLocalizeMeaning: `$localize tagged messages should contain a meaning. See more at ${STYLE_GUIDE_LINK_METADATA_FOR_TRANSLATION}`,
+            requireLocalizeCustomId: `$localize tagged messages should contain a custom id{{patternMessage}}. See more at ${STYLE_GUIDE_LINK_METADATA_FOR_TRANSLATION}`,
         },
     },
     defaultOptions: [DEFAULT_OPTIONS],
-    create(context, [{ requireDescription, requireMeaning }]) {
+    create(context, [{ requireDescription, requireMeaning, requireCustomId }]) {
         return {
             TaggedTemplateExpression(taggedTemplateExpression) {
-                if ((requireDescription || requireMeaning) &&
+                if ((requireDescription || requireMeaning || requireCustomId) &&
                     utils_1.ASTUtils.isIdentifier(taggedTemplateExpression.tag)) {
                     const identifierName = taggedTemplateExpression.tag.name;
                     const templateElement = taggedTemplateExpression.quasi.quasis[0];
                     if (identifierName === '$localize' && !!templateElement) {
-                        const templateElementRawValue = templateElement.value.raw;
-                        if (requireDescription &&
-                            !VALID_LOCALIZED_STRING_WITH_DESCRIPTION.test(templateElementRawValue)) {
+                        const metadata = parseMetadata(templateElement.value.raw.trim());
+                        if (requireDescription && !metadata.description) {
                             context.report({
                                 loc: templateElement.loc,
                                 messageId: 'requireLocalizeDescription',
                             });
                         }
-                        if (requireMeaning &&
-                            !VALID_LOCALIZED_STRING_WITH_MEANING.test(templateElementRawValue)) {
+                        if (requireMeaning && !metadata.meaning) {
                             context.report({
                                 loc: templateElement.loc,
                                 messageId: 'requireLocalizeMeaning',
                             });
                         }
+                        if (requireCustomId &&
+                            !(metadata.customId &&
+                                (typeof requireCustomId === 'string'
+                                    ? RegExp(requireCustomId).test(metadata.customId)
+                                    : true))) {
+                            context.report({
+                                loc: templateElement.loc,
+                                messageId: 'requireLocalizeCustomId',
+                                data: {
+                                    patternMessage: typeof requireCustomId === 'string'
+                                        ? ` matching the pattern /${requireCustomId}/ on '${metadata.customId}'`
+                                        : '',
+                                },
+                            });
+                        }
                     }
                 }
             },
         };
     },
 });
+// see https://github.com/angular/angular/blob/main/packages/localize/src/utils/src/messages.ts#L247
+const BLOCK_MARKER = ':';
+const MEANING_SEPARATOR = '|';
+const ID_SEPARATOR = '@@';
+function parseMetadata(rawText) {
+    const output = {
+        rawText,
+        meaning: undefined,
+        description: undefined,
+        customId: undefined,
+    };
+    if (rawText.charAt(0) !== BLOCK_MARKER) {
+        return output;
+    }
+    const endOfTheBlock = rawText.lastIndexOf(BLOCK_MARKER);
+    if (endOfTheBlock === -1) {
+        return output;
+    }
+    const text = rawText.slice(1, endOfTheBlock);
+    const [meaningAndDesc, customId] = text.split(ID_SEPARATOR, 2);
+    let [meaning, description] = meaningAndDesc.split(MEANING_SEPARATOR, 2);
+    if (description === undefined) {
+        description = meaning;
+        meaning = undefined;
+    }
+    if (description === '') {
+        description = undefined;
+    }
+    return { rawText, meaning, description, customId };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@angular-eslint/eslint-plugin",
-  "version": "19.7.0-beta.0",
+  "version": "19.7.1-alpha.0",
   "description": "ESLint plugin for Angular applications, following https://angular.dev/style-guide",
   "license": "MIT",
   "main": "dist/index.js",
@@ -18,11 +18,11 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@angular-eslint/bundled-angular-compiler": "19.7.0-beta.0",
-    "@angular-eslint/utils": "19.7.0-beta.0"
+    "@angular-eslint/bundled-angular-compiler": "19.7.1-alpha.0",
+    "@angular-eslint/utils": "19.7.1-alpha.0"
   },
   "devDependencies": {
-    "@angular-eslint/test-utils": "19.7.0-beta.0"
+    "@angular-eslint/test-utils": "19.7.1-alpha.0"
   },
   "peerDependencies": {
     "@typescript-eslint/utils": "^7.11.0 || ^8.0.0",

package/dist/rules/no-host-metadata-property.d.ts

@@ -1,8 +0,0 @@
-export type Options = [{
-    readonly allowStatic?: boolean;
-}];
-export type MessageIds = 'noHostMetadataProperty';
-export declare const RULE_NAME = "no-host-metadata-property";
-declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"noHostMetadataProperty", Options, import("../utils/create-eslint-rule").RuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-export default _default;
-//# sourceMappingURL=no-host-metadata-property.d.ts.map

package/dist/rules/no-host-metadata-property.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"no-host-metadata-property.d.ts","sourceRoot":"","sources":["../../src/rules/no-host-metadata-property.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,OAAO,GAAG,CAAC;IAAE,QAAQ,CAAC,WAAW,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAC3D,MAAM,MAAM,UAAU,GAAG,wBAAwB,CAAC;AAClD,eAAO,MAAM,SAAS,8BAA8B,CAAC;;AAIrD,wBA4CG"}

package/dist/rules/no-host-metadata-property.js

@@ -1,67 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RULE_NAME = void 0;
-const utils_1 = require("@angular-eslint/utils");
-const utils_2 = require("@typescript-eslint/utils");
-const create_eslint_rule_1 = require("../utils/create-eslint-rule");
-exports.RULE_NAME = 'no-host-metadata-property';
-const DEFAULT_OPTIONS = { allowStatic: false };
-const METADATA_PROPERTY_NAME = 'host';
-exports.default = (0, create_eslint_rule_1.createESLintRule)({
-    name: exports.RULE_NAME,
-    meta: {
-        type: 'suggestion',
-        deprecated: true,
-        docs: {
-            description: `Disallows usage of the \`${METADATA_PROPERTY_NAME}\` metadata property. NOTE: This used to be recommended by the Angular Team, but now they recommend the exact opposite: https://github.com/angular/angular/issues/54284`,
-        },
-        schema: [
-            {
-                type: 'object',
-                properties: {
-                    allowStatic: {
-                        type: 'boolean',
-                        default: DEFAULT_OPTIONS.allowStatic,
-                    },
-                },
-                additionalProperties: false,
-            },
-        ],
-        messages: {
-            noHostMetadataProperty: `Use @${utils_1.ASTUtils.AngularInnerClassDecorators.HostBinding} or @${utils_1.ASTUtils.AngularInnerClassDecorators.HostListener} rather than the \`${METADATA_PROPERTY_NAME}\` metadata property`,
-        },
-    },
-    defaultOptions: [DEFAULT_OPTIONS],
-    create(context, [{ allowStatic }]) {
-        return {
-            [`${utils_1.Selectors.COMPONENT_OR_DIRECTIVE_CLASS_DECORATOR} Property[key.name="${METADATA_PROPERTY_NAME}"]`](node) {
-                const properties = allowStatic && utils_1.ASTUtils.isObjectExpression(node.value)
-                    ? node.value.properties.filter(isDynamic)
-                    : [node];
-                properties.forEach((property) => {
-                    context.report({
-                        node: property,
-                        messageId: 'noHostMetadataProperty',
-                    });
-                });
-            },
-        };
-    },
-});
-function startsWithLetter({ [0]: firstLetter }) {
-    return firstLetter.toLowerCase() !== firstLetter.toUpperCase();
-}
-function isEmptyStringValue(property) {
-    return (utils_1.ASTUtils.isStringLiteral(property.value) && property.value.value === '');
-}
-function isStatic(property) {
-    return (!property.computed &&
-        (utils_2.ASTUtils.isIdentifier(property.key) ||
-            (utils_1.ASTUtils.isStringLiteral(property.key) &&
-                startsWithLetter(property.key.value))));
-}
-function isDynamic(property) {
-    return (utils_1.ASTUtils.isProperty(property) &&
-        !isStatic(property) &&
-        !isEmptyStringValue(property));
-}

package/dist/rules/prefer-standalone-component.d.ts

@@ -1,6 +0,0 @@
-export type Options = [];
-export type MessageIds = 'preferStandaloneComponent';
-export declare const RULE_NAME = "prefer-standalone-component";
-declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"preferStandaloneComponent", [], import("../utils/create-eslint-rule").RuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-export default _default;
-//# sourceMappingURL=prefer-standalone-component.d.ts.map

package/dist/rules/prefer-standalone-component.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"prefer-standalone-component.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-standalone-component.ts"],"names":[],"mappings":"AASA,MAAM,MAAM,OAAO,GAAG,EAAE,CAAC;AACzB,MAAM,MAAM,UAAU,GAAG,2BAA2B,CAAC;AACrD,eAAO,MAAM,SAAS,gCAAgC,CAAC;;AAIvD,wBA0DG"}

package/dist/rules/prefer-standalone-component.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RULE_NAME = void 0;
-const utils_1 = require("@angular-eslint/utils");
-const create_eslint_rule_1 = require("../utils/create-eslint-rule");
-exports.RULE_NAME = 'prefer-standalone-component';
-const METADATA_PROPERTY_NAME = 'standalone';
-const IS_STANDALONE = 'true';
-exports.default = (0, create_eslint_rule_1.createESLintRule)({
-    name: exports.RULE_NAME,
-    meta: {
-        type: 'suggestion',
-        docs: {
-            description: `Ensures component \`${METADATA_PROPERTY_NAME}\` property is set to \`${IS_STANDALONE}\` in the component decorator`,
-        },
-        deprecated: true,
-        replacedBy: ['prefer-standalone'],
-        fixable: 'code',
-        schema: [],
-        messages: {
-            preferStandaloneComponent: `The component \`${METADATA_PROPERTY_NAME}\` property should be set to \`${IS_STANDALONE}\``,
-        },
-    },
-    defaultOptions: [],
-    create(context) {
-        return {
-            [utils_1.Selectors.COMPONENT_CLASS_DECORATOR](node) {
-                const standalone = utils_1.ASTUtils.getDecoratorPropertyValue(node, METADATA_PROPERTY_NAME);
-                if (standalone &&
-                    utils_1.ASTUtils.isLiteral(standalone) &&
-                    standalone.value === true) {
-                    return;
-                }
-                context.report({
-                    node: nodeToReport(node),
-                    messageId: 'preferStandaloneComponent',
-                    fix: (fixer) => {
-                        if (standalone &&
-                            utils_1.ASTUtils.isLiteral(standalone) &&
-                            standalone.value !== true) {
-                            return [fixer.replaceText(standalone, IS_STANDALONE)].filter(utils_1.isNotNullOrUndefined);
-                        }
-                        return [
-                            utils_1.RuleFixes.getDecoratorPropertyAddFix(node, fixer, `${METADATA_PROPERTY_NAME}: ${IS_STANDALONE}`),
-                        ].filter(utils_1.isNotNullOrUndefined);
-                    },
-                });
-            },
-        };
-    },
-});
-function nodeToReport(node) {
-    if (!utils_1.ASTUtils.isProperty(node)) {
-        return node;
-    }
-    return utils_1.ASTUtils.isMemberExpression(node.value)
-        ? node.value.property
-        : node.value;
-}

package/dist/rules/sort-ngmodule-metadata-arrays.d.ts

@@ -1,10 +0,0 @@
-export type Options = [
-    {
-        readonly locale: string;
-    }
-];
-export type MessageIds = 'sortNgmoduleMetadataArrays';
-export declare const RULE_NAME = "sort-ngmodule-metadata-arrays";
-declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<"sortNgmoduleMetadataArrays", Options, import("../utils/create-eslint-rule").RuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
-export default _default;
-//# sourceMappingURL=sort-ngmodule-metadata-arrays.d.ts.map

package/dist/rules/sort-ngmodule-metadata-arrays.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"sort-ngmodule-metadata-arrays.d.ts","sourceRoot":"","sources":["../../src/rules/sort-ngmodule-metadata-arrays.ts"],"names":[],"mappings":"AAKA,MAAM,MAAM,OAAO,GAAG;IACpB;QACE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;KACzB;CACF,CAAC;AACF,MAAM,MAAM,UAAU,GAAG,4BAA4B,CAAC;AACtD,eAAO,MAAM,SAAS,kCAAkC,CAAC;;AAGzD,wBA2DG"}

package/dist/rules/sort-ngmodule-metadata-arrays.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RULE_NAME = void 0;
-const utils_1 = require("@angular-eslint/utils");
-const utils_2 = require("@typescript-eslint/utils");
-const create_eslint_rule_1 = require("../utils/create-eslint-rule");
-exports.RULE_NAME = 'sort-ngmodule-metadata-arrays';
-const DEFAULT_LOCALE = 'en-US';
-exports.default = (0, create_eslint_rule_1.createESLintRule)({
-    name: exports.RULE_NAME,
-    meta: {
-        type: 'suggestion',
-        deprecated: true,
-        docs: {
-            description: 'Ensures ASC alphabetical order for `NgModule` metadata arrays for easy visual scanning',
-        },
-        fixable: 'code',
-        schema: [
-            {
-                type: 'object',
-                properties: {
-                    locale: {
-                        type: 'string',
-                        description: 'A string with a BCP 47 language tag.',
-                        default: DEFAULT_LOCALE,
-                    },
-                },
-                additionalProperties: false,
-            },
-        ],
-        messages: {
-            sortNgmoduleMetadataArrays: '`NgModule` metadata arrays should be sorted in ASC alphabetical order',
-        },
-    },
-    defaultOptions: [
-        {
-            locale: DEFAULT_LOCALE,
-        },
-    ],
-    create(context, [{ locale }]) {
-        return {
-            [`${utils_1.Selectors.MODULE_CLASS_DECORATOR} Property[key.name!="deps"] > ArrayExpression`]({ elements, }) {
-                const unorderedNodes = elements
-                    .filter(utils_2.ASTUtils.isIdentifier)
-                    .map((current, index, list) => [current, list[index + 1]])
-                    .find(([current, next]) => {
-                    return next && current.name.localeCompare(next.name, locale) === 1;
-                });
-                if (!unorderedNodes)
-                    return;
-                const [unorderedNode, nextNode] = unorderedNodes;
-                context.report({
-                    node: nextNode,
-                    messageId: 'sortNgmoduleMetadataArrays',
-                    fix: (fixer) => [
-                        fixer.replaceText(unorderedNode, nextNode.name),
-                        fixer.replaceText(nextNode, unorderedNode.name),
-                    ],
-                });
-            },
-        };
-    },
-});