eslint-plugin-formatjs 2.20.2 → 2.21.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-formatjs",
-  "version": "2.20.2",
+  "version": "2.21.0",
   "description": "ESLint plugin for formatjs",
   "main": "index.js",
   "repository": {
@@ -20,11 +20,11 @@
   },
   "homepage": "https://github.com/formatjs/formatjs#readme",
   "dependencies": {
-    "@formatjs/icu-messageformat-parser": "2.0.16",
-    "@formatjs/ts-transformer": "3.8.2",
+    "@formatjs/icu-messageformat-parser": "2.0.18",
+    "@formatjs/ts-transformer": "3.9.2",
     "@types/eslint": "8",
-    "@typescript-eslint/typescript-estree": "^4.11.0",
-    "emoji-regex": "^9.2.0",
+    "@typescript-eslint/typescript-estree": "^5.9.1",
+    "emoji-regex": "^10.0.0",
     "tslib": "^2.1.0",
     "typescript": "^4.5"
   },

package/rules/enforce-id.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enforce-id.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin-formatjs/rules/enforce-id.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;;AAoF3B,wBA0CoB"}
+{"version":3,"file":"enforce-id.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin-formatjs/rules/enforce-id.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;;AA0G3B,wBAgEoB"}

package/rules/enforce-id.js

@@ -2,11 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 var util_1 = require("../util");
 var ts_transformer_1 = require("@formatjs/ts-transformer");
-function checkNode(context, node) {
+function checkNode(context, node, _a) {
+    var idInterpolationPattern = _a.idInterpolationPattern, idWhitelistRegexps = _a.idWhitelistRegexps;
     var msgs = (0, util_1.extractMessages)(node, context.settings);
-    var options = context.options;
-    var _a = options[0], opt = _a === void 0 ? {} : _a;
-    var idInterpolationPattern = opt.idInterpolationPattern;
     var _loop_1 = function (defaultMessage, description, id, idPropNode, descriptionNode, messagePropNode) {
         if (!idInterpolationPattern && !idPropNode) {
             context.report({
@@ -28,6 +26,11 @@ function checkNode(context, node) {
                 });
             }
             else {
+                if (idWhitelistRegexps &&
+                    id &&
+                    idWhitelistRegexps.some(function (r) { return r.test(id); })) {
+                    return { value: void 0 };
+                }
                 var correctId_1 = (0, ts_transformer_1.interpolateName)({
                     resourcePath: context.getFilename(),
                 }, idInterpolationPattern, {
@@ -36,9 +39,15 @@ function checkNode(context, node) {
                         : defaultMessage,
                 });
                 if (id !== correctId_1) {
+                    var message = "\"id\" does not match with hash pattern ".concat(idInterpolationPattern);
+                    if (idWhitelistRegexps) {
+                        message += " or whitelisted patterns [\"".concat(idWhitelistRegexps
+                            .map(function (r) { return r.toString(); })
+                            .join('", "'), "\"]");
+                    }
                     context.report({
                         node: node,
-                        message: "\"id\" does not match with hash pattern ".concat(idInterpolationPattern, ".\nExpected: ").concat(correctId_1, "\nActual: ").concat(id),
+                        message: "".concat(message, ".\nExpected: ").concat(correctId_1, "\nActual: ").concat(id),
                         fix: function (fixer) {
                             if (idPropNode) {
                                 if (idPropNode.type === 'JSXAttribute') {
@@ -59,7 +68,9 @@ function checkNode(context, node) {
     };
     for (var _i = 0, msgs_1 = msgs; _i < msgs_1.length; _i++) {
         var _b = msgs_1[_i][0], _c = _b.message, defaultMessage = _c.defaultMessage, description = _c.description, id = _c.id, idPropNode = _b.idPropNode, descriptionNode = _b.descriptionNode, messagePropNode = _b.messagePropNode;
-        _loop_1(defaultMessage, description, id, idPropNode, descriptionNode, messagePropNode);
+        var state_1 = _loop_1(defaultMessage, description, id, idPropNode, descriptionNode, messagePropNode);
+        if (typeof state_1 === "object")
+            return state_1.value;
     }
 }
 exports.default = {
@@ -78,6 +89,14 @@ exports.default = {
                 properties: {
                     idInterpolationPattern: {
                         type: 'string',
+                        description: 'Pattern to verify ID against. Recommended value: [sha512:contenthash:base64:6]',
+                    },
+                    idWhitelist: {
+                        type: 'array',
+                        description: "An array of strings with regular expressions. This array allows whitelist custom ids for messages. For example '`\\\\.`' allows any id which has dot; `'^payment_.*'` - allows any custom id which has prefix `payment_`. Be aware that any backslash \\ provided via string must be escaped with an additional backslash.",
+                        items: {
+                            type: 'string',
+                        },
                     },
                 },
                 required: ['idInterpolationPattern'],
@@ -86,8 +105,17 @@ exports.default = {
         ],
     },
     create: function (context) {
+        var _a;
+        var tmp = (_a = context === null || context === void 0 ? void 0 : context.options) === null || _a === void 0 ? void 0 : _a[0];
+        var opts = {
+            idInterpolationPattern: tmp === null || tmp === void 0 ? void 0 : tmp.idInterpolationPattern,
+        };
+        if (Array.isArray(tmp === null || tmp === void 0 ? void 0 : tmp.idWhitelist)) {
+            var idWhitelist = tmp.idWhitelist;
+            opts.idWhitelistRegexps = idWhitelist.map(function (str) { return new RegExp(str, 'i'); });
+        }
         var callExpressionVisitor = function (node) {
-            return checkNode(context, node);
+            return checkNode(context, node, opts);
         };
         if (context.parserServices.defineTemplateBodyVisitor) {
             return context.parserServices.defineTemplateBodyVisitor({
@@ -97,7 +125,9 @@ exports.default = {
             });
         }
         return {
-            JSXOpeningElement: function (node) { return checkNode(context, node); },
+            JSXOpeningElement: function (node) {
+                return checkNode(context, node, opts);
+            },
             CallExpression: callExpressionVisitor,
         };
     },