@angular-eslint/eslint-plugin 19.7.0-alpha.0 → 19.7.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-alpha.0",
+  "version": "19.7.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-alpha.0",
-    "@angular-eslint/utils": "19.7.0-alpha.0"
+    "@angular-eslint/bundled-angular-compiler": "19.7.0",
+    "@angular-eslint/utils": "19.7.0"
   },
   "devDependencies": {
-    "@angular-eslint/test-utils": "19.7.0-alpha.0"
+    "@angular-eslint/test-utils": "19.7.0"
   },
   "peerDependencies": {
     "@typescript-eslint/utils": "^7.11.0 || ^8.0.0",