eslint-plugin-formatjs 2.20.5 → 3.0.1

package/index.d.ts

@@ -1,6 +1,6 @@
 declare const plugin: {
     rules: {
-        'blacklist-elements': import("eslint").Rule.RuleModule;
+        'blocklist-elements': import("eslint").Rule.RuleModule;
         'enforce-default-message': import("eslint").Rule.RuleModule;
         'enforce-description': import("eslint").Rule.RuleModule;
         'enforce-id': import("eslint").Rule.RuleModule;

package/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var tslib_1 = require("tslib");
-var blacklist_elements_1 = (0, tslib_1.__importDefault)(require("./rules/blacklist-elements"));
+var blocklist_elements_1 = (0, tslib_1.__importDefault)(require("./rules/blocklist-elements"));
 var enforce_default_message_1 = (0, tslib_1.__importDefault)(require("./rules/enforce-default-message"));
 var enforce_description_1 = (0, tslib_1.__importDefault)(require("./rules/enforce-description"));
 var enforce_id_1 = (0, tslib_1.__importDefault)(require("./rules/enforce-id"));
@@ -16,7 +16,7 @@ var no_multiple_whitespaces_1 = (0, tslib_1.__importDefault)(require("./rules/no
 var no_offset_1 = (0, tslib_1.__importDefault)(require("./rules/no-offset"));
 var plugin = {
     rules: {
-        'blacklist-elements': blacklist_elements_1.default,
+        'blocklist-elements': blocklist_elements_1.default,
         'enforce-default-message': enforce_default_message_1.default,
         'enforce-description': enforce_description_1.default,
         'enforce-id': enforce_id_1.default,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-formatjs",
-  "version": "2.20.5",
+  "version": "3.0.1",
   "description": "ESLint plugin for formatjs",
   "main": "index.js",
   "repository": {
@@ -20,8 +20,8 @@
   },
   "homepage": "https://github.com/formatjs/formatjs#readme",
   "dependencies": {
-    "@formatjs/icu-messageformat-parser": "2.0.17",
-    "@formatjs/ts-transformer": "3.9.1",
+    "@formatjs/icu-messageformat-parser": "2.0.19",
+    "@formatjs/ts-transformer": "3.9.3",
     "@types/eslint": "8",
     "@typescript-eslint/typescript-estree": "^5.9.1",
     "emoji-regex": "^10.0.0",

package/rules/{blacklist-elements.d.ts → blocklist-elements.d.ts}

@@ -1,4 +1,4 @@
 import { Rule } from 'eslint';
 declare const rule: Rule.RuleModule;
 export default rule;
-//# sourceMappingURL=blacklist-elements.d.ts.map
+//# sourceMappingURL=blocklist-elements.d.ts.map

package/rules/blocklist-elements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"blocklist-elements.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin-formatjs/rules/blocklist-elements.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAkH3B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAyChB,CAAA;AAED,eAAe,IAAI,CAAA"}

package/rules/{blacklist-elements.js → blocklist-elements.js}

@@ -7,7 +7,7 @@ var BlacklistElement = /** @class */ (function (_super) {
     (0, tslib_1.__extends)(BlacklistElement, _super);
     function BlacklistElement(type) {
         var _this = _super.call(this) || this;
-        _this.message = "".concat(type, " element is blacklisted");
+        _this.message = "".concat(type, " element is blocklisted");
         return _this;
     }
     return BlacklistElement;
@@ -24,36 +24,36 @@ var Element;
     Element["plural"] = "plural";
     Element["tag"] = "tag";
 })(Element || (Element = {}));
-function verifyAst(blacklist, ast) {
+function verifyAst(blocklist, ast) {
     for (var _i = 0, ast_1 = ast; _i < ast_1.length; _i++) {
         var el = ast_1[_i];
-        if ((0, icu_messageformat_parser_1.isLiteralElement)(el) && blacklist.includes(Element.literal)) {
+        if ((0, icu_messageformat_parser_1.isLiteralElement)(el) && blocklist.includes(Element.literal)) {
             throw new BlacklistElement(Element.literal);
         }
-        if ((0, icu_messageformat_parser_1.isArgumentElement)(el) && blacklist.includes(Element.argument)) {
+        if ((0, icu_messageformat_parser_1.isArgumentElement)(el) && blocklist.includes(Element.argument)) {
             throw new BlacklistElement(Element.argument);
         }
-        if ((0, icu_messageformat_parser_1.isNumberElement)(el) && blacklist.includes(Element.number)) {
+        if ((0, icu_messageformat_parser_1.isNumberElement)(el) && blocklist.includes(Element.number)) {
             throw new BlacklistElement(Element.number);
         }
-        if ((0, icu_messageformat_parser_1.isDateElement)(el) && blacklist.includes(Element.date)) {
+        if ((0, icu_messageformat_parser_1.isDateElement)(el) && blocklist.includes(Element.date)) {
             throw new BlacklistElement(Element.date);
         }
-        if ((0, icu_messageformat_parser_1.isTimeElement)(el) && blacklist.includes(Element.time)) {
+        if ((0, icu_messageformat_parser_1.isTimeElement)(el) && blocklist.includes(Element.time)) {
             throw new BlacklistElement(Element.time);
         }
-        if ((0, icu_messageformat_parser_1.isSelectElement)(el) && blacklist.includes(Element.select)) {
+        if ((0, icu_messageformat_parser_1.isSelectElement)(el) && blocklist.includes(Element.select)) {
             throw new BlacklistElement(Element.select);
         }
-        if ((0, icu_messageformat_parser_1.isTagElement)(el) && blacklist.includes(Element.tag)) {
+        if ((0, icu_messageformat_parser_1.isTagElement)(el) && blocklist.includes(Element.tag)) {
             throw new BlacklistElement(Element.tag);
         }
         if ((0, icu_messageformat_parser_1.isPluralElement)(el)) {
-            if (blacklist.includes(Element.plural)) {
+            if (blocklist.includes(Element.plural)) {
                 throw new BlacklistElement(Element.argument);
             }
             if (el.pluralType === 'ordinal' &&
-                blacklist.includes(Element.selectordinal)) {
+                blocklist.includes(Element.selectordinal)) {
                 throw new BlacklistElement(Element.selectordinal);
             }
         }
@@ -61,7 +61,7 @@ function verifyAst(blacklist, ast) {
             var options = el.options;
             for (var _a = 0, _b = Object.keys(options); _a < _b.length; _a++) {
                 var selector = _b[_a];
-                verifyAst(blacklist, options[selector].value);
+                verifyAst(blocklist, options[selector].value);
             }
         }
     }
@@ -71,8 +71,8 @@ function checkNode(context, node) {
     if (!msgs.length) {
         return;
     }
-    var blacklist = context.options[0];
-    if (!Array.isArray(blacklist) || !blacklist.length) {
+    var blocklist = context.options[0];
+    if (!Array.isArray(blocklist) || !blocklist.length) {
         return;
     }
     for (var _i = 0, msgs_1 = msgs; _i < msgs_1.length; _i++) {
@@ -100,7 +100,7 @@ var rule = {
             description: 'Disallow specific elements in ICU message format',
             category: 'Errors',
             recommended: false,
-            url: 'https://formatjs.io/docs/tooling/linter#blacklist-elements',
+            url: 'https://formatjs.io/docs/tooling/linter#blocklist-elements',
         },
         fixable: 'code',
         schema: [

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 allowlisted 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 allowlist 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,
         };
     },

package/rules/blacklist-elements.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"blacklist-elements.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin-formatjs/rules/blacklist-elements.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAkH3B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAyChB,CAAA;AAED,eAAe,IAAI,CAAA"}