eslint-plugin-formatjs 3.1.3 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-formatjs",
-  "version": "3.1.3",
+  "version": "4.0.0",
   "description": "ESLint plugin for formatjs",
   "main": "index.js",
   "repository": {
@@ -20,11 +20,13 @@
   },
   "homepage": "https://github.com/formatjs/formatjs#readme",
   "dependencies": {
-    "@formatjs/icu-messageformat-parser": "2.1.2",
-    "@formatjs/ts-transformer": "3.9.6",
+    "@formatjs/icu-messageformat-parser": "2.1.3",
+    "@formatjs/ts-transformer": "3.9.8",
     "@types/eslint": "7 || 8",
+    "@types/picomatch": "^2.3.0",
     "@typescript-eslint/typescript-estree": "^5.9.1",
     "emoji-regex": "^10.0.0",
+    "picomatch": "^2.3.1",
     "tslib": "2.4.0",
     "typescript": "^4.5"
   },

package/rules/no-complex-selectors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"no-complex-selectors.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin-formatjs/rules/no-complex-selectors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AA8D3B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAiDhB,CAAA;AAED,eAAe,IAAI,CAAA"}
+{"version":3,"file":"no-complex-selectors.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin-formatjs/rules/no-complex-selectors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAwE3B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAiDhB,CAAA;AAED,eAAe,IAAI,CAAA"}

package/rules/no-complex-selectors.js

@@ -26,9 +26,20 @@ function checkNode(context, node) {
         if (!defaultMessage || !messageNode) {
             continue;
         }
-        var hoistedAst = (0, manipulator_1.hoistSelectors)((0, icu_messageformat_parser_1.parse)(defaultMessage, {
-            ignoreTag: context.settings.ignoreTag,
-        }));
+        var ast = void 0;
+        try {
+            ast = (0, icu_messageformat_parser_1.parse)(defaultMessage, {
+                ignoreTag: context.settings.ignoreTag,
+            });
+        }
+        catch (e) {
+            context.report({
+                node: messageNode,
+                message: e instanceof Error ? e.message : String(e),
+            });
+            return;
+        }
+        var hoistedAst = (0, manipulator_1.hoistSelectors)(ast);
         var complexity = calculateComplexity(hoistedAst);
         if (complexity > config.limit) {
             context.report({

package/rules/no-literal-string-in-jsx.d.ts

@@ -0,0 +1,4 @@
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;
+//# sourceMappingURL=no-literal-string-in-jsx.d.ts.map

package/rules/no-literal-string-in-jsx.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-literal-string-in-jsx.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin-formatjs/rules/no-literal-string-in-jsx.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAqDhC,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA4JhB,CAAA;AAED,eAAe,IAAI,CAAA"}

package/rules/no-literal-string-in-jsx.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var picomatch_1 = (0, tslib_1.__importDefault)(require("picomatch"));
+var typescript_estree_1 = require("@typescript-eslint/typescript-estree");
+var propMatcherSchema = {
+    type: 'array',
+    items: {
+        type: 'array',
+        items: [{ type: 'string' }, { type: 'string' }],
+    },
+};
+var defaultPropIncludePattern = [
+    ['*', 'aria-{label,description,details,errormessage}'],
+    ['[a-z]*([a-z0-9])', '(placeholder|title)'],
+    ['img', 'alt'],
+];
+var defaultPropExcludePattern = [];
+function stringifyJsxTagName(tagName) {
+    switch (tagName.type) {
+        case typescript_estree_1.TSESTree.AST_NODE_TYPES.JSXIdentifier:
+            return tagName.name;
+        case typescript_estree_1.TSESTree.AST_NODE_TYPES.JSXMemberExpression:
+            return "".concat(stringifyJsxTagName(tagName.object), ".").concat(tagName.property.name);
+        case typescript_estree_1.TSESTree.AST_NODE_TYPES.JSXNamespacedName:
+            return "".concat(tagName.namespace.name, ":").concat(tagName.name.name);
+    }
+}
+function compilePropMatcher(propMatcher) {
+    return propMatcher.map(function (_a) {
+        var tagNamePattern = _a[0], propNamePattern = _a[1];
+        return [
+            picomatch_1.default.makeRe(tagNamePattern, { contains: false }),
+            picomatch_1.default.makeRe(propNamePattern, { contains: false }),
+        ];
+    });
+}
+var rule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Disallow untranslated literal strings without translation.',
+            category: 'Errors',
+            recommended: false,
+            url: 'https://formatjs.io/docs/tooling/linter#no-literal-string-in-jsx',
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    props: {
+                        type: 'object',
+                        properties: {
+                            include: (0, tslib_1.__assign)({}, propMatcherSchema),
+                            exclude: (0, tslib_1.__assign)({}, propMatcherSchema),
+                        },
+                    },
+                },
+            },
+        ],
+    },
+    // TODO: Vue support
+    create: function (context) {
+        var _a, _b, _c, _d;
+        var userConfig = context.options[0] || {};
+        var propIncludePattern = compilePropMatcher((0, tslib_1.__spreadArray)((0, tslib_1.__spreadArray)([], defaultPropIncludePattern, true), ((_b = (_a = userConfig.props) === null || _a === void 0 ? void 0 : _a.include) !== null && _b !== void 0 ? _b : []), true));
+        var propExcludePattern = compilePropMatcher((0, tslib_1.__spreadArray)((0, tslib_1.__spreadArray)([], defaultPropExcludePattern, true), ((_d = (_c = userConfig.props) === null || _c === void 0 ? void 0 : _c.exclude) !== null && _d !== void 0 ? _d : []), true));
+        var lexicalJsxStack = [];
+        var shouldSkipCurrentJsxAttribute = function (node) {
+            var currentJsxNode = lexicalJsxStack[lexicalJsxStack.length - 1];
+            if (currentJsxNode.type === 'JSXFragment') {
+                return false;
+            }
+            var nameString = stringifyJsxTagName(currentJsxNode.openingElement.name);
+            var attributeName = typeof node.name.name === 'string'
+                ? node.name.name
+                : node.name.name.name;
+            // match exclude
+            for (var _i = 0, propExcludePattern_1 = propExcludePattern; _i < propExcludePattern_1.length; _i++) {
+                var _a = propExcludePattern_1[_i], tagNamePattern = _a[0], propNamePattern = _a[1];
+                if (tagNamePattern.test(nameString) &&
+                    propNamePattern.test(attributeName)) {
+                    return true;
+                }
+            }
+            // match include
+            for (var _b = 0, propIncludePattern_1 = propIncludePattern; _b < propIncludePattern_1.length; _b++) {
+                var _c = propIncludePattern_1[_b], tagNamePattern = _c[0], propNamePattern = _c[1];
+                if (tagNamePattern.test(nameString) &&
+                    propNamePattern.test(attributeName)) {
+                    return false;
+                }
+            }
+            return true;
+        };
+        var checkJSXExpression = function (node) {
+            // Check if this is either a string literal / template literal, or the concat of them.
+            if ((node.type === 'Literal' && typeof node.value === 'string') ||
+                node.type === 'TemplateLiteral') {
+                context.report({
+                    node: node,
+                    message: 'Cannot have untranslated text in JSX',
+                });
+            }
+            else if (node.type === 'BinaryExpression' && node.operator === '+') {
+                checkJSXExpression(node.left);
+                checkJSXExpression(node.right);
+            }
+        };
+        return {
+            JSXElement: function (node) {
+                lexicalJsxStack.push(node);
+            },
+            'JSXElement:exit': function () {
+                lexicalJsxStack.pop();
+            },
+            JSXFragment: function (node) {
+                lexicalJsxStack.push(node);
+            },
+            'JSXFragment:exit': function () {
+                lexicalJsxStack.pop();
+            },
+            JSXAttribute: function (node) {
+                if (shouldSkipCurrentJsxAttribute(node)) {
+                    return;
+                }
+                if (!node.value) {
+                    return;
+                }
+                if (node.value.type === 'Literal') {
+                    context.report({
+                        node: node,
+                        message: 'Cannot have untranslated text in JSX',
+                    });
+                }
+                else if (node.value.type === 'JSXExpressionContainer' &&
+                    node.value.expression.type !== 'JSXEmptyExpression') {
+                    checkJSXExpression(node.value.expression);
+                }
+            },
+            JSXText: function (node) {
+                // Ignore purely spacing fragments
+                if (!node.value.replace(/\s*/gm, '')) {
+                    return;
+                }
+                context.report({
+                    node: node,
+                    message: 'Cannot have untranslated text in JSX',
+                });
+            },
+            // Children expression container
+            'JSXElement > JSXExpressionContainer': function (node) {
+                if (node.expression.type !== 'JSXEmptyExpression') {
+                    checkJSXExpression(node.expression);
+                }
+            },
+        };
+    },
+};
+exports.default = rule;

package/rules/no-multiple-whitespaces.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"no-multiple-whitespaces.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin-formatjs/rules/no-multiple-whitespaces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAmC3B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA8BhB,CAAA;AAED,eAAe,IAAI,CAAA"}
+{"version":3,"file":"no-multiple-whitespaces.d.ts","sourceRoot":"","sources":["../../../../../../packages/eslint-plugin-formatjs/rules/no-multiple-whitespaces.ts"],"names":[],"mappings":"AAOA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAyJ3B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA+BhB,CAAA;AAED,eAAe,IAAI,CAAA"}

package/rules/no-multiple-whitespaces.js

@@ -1,21 +1,121 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+var icu_messageformat_parser_1 = require("@formatjs/icu-messageformat-parser");
 var util_1 = require("../util");
-var MULTIPLE_SPACES = /\s{2,}/g;
+function isAstValid(ast) {
+    for (var _i = 0, ast_1 = ast; _i < ast_1.length; _i++) {
+        var element = ast_1[_i];
+        switch (element.type) {
+            case icu_messageformat_parser_1.TYPE.literal:
+                if (/\s{2,}/gm.test(element.value)) {
+                    return false;
+                }
+                break;
+            case icu_messageformat_parser_1.TYPE.argument:
+            case icu_messageformat_parser_1.TYPE.date:
+            case icu_messageformat_parser_1.TYPE.literal:
+            case icu_messageformat_parser_1.TYPE.number:
+            case icu_messageformat_parser_1.TYPE.pound:
+            case icu_messageformat_parser_1.TYPE.tag:
+            case icu_messageformat_parser_1.TYPE.time:
+                break;
+            case icu_messageformat_parser_1.TYPE.plural:
+            case icu_messageformat_parser_1.TYPE.select: {
+                for (var _a = 0, _b = Object.values(element.options); _a < _b.length; _a++) {
+                    var option = _b[_a];
+                    if (!isAstValid(option.value)) {
+                        return false;
+                    }
+                }
+                break;
+            }
+        }
+    }
+    return true;
+}
+function trimMultiWhitespaces(message, ast) {
+    var literalElements = [];
+    var collectLiteralElements = function (elements) {
+        for (var _i = 0, elements_1 = elements; _i < elements_1.length; _i++) {
+            var element = elements_1[_i];
+            switch (element.type) {
+                case icu_messageformat_parser_1.TYPE.literal:
+                    literalElements.push(element);
+                    break;
+                case icu_messageformat_parser_1.TYPE.argument:
+                case icu_messageformat_parser_1.TYPE.date:
+                case icu_messageformat_parser_1.TYPE.literal:
+                case icu_messageformat_parser_1.TYPE.number:
+                case icu_messageformat_parser_1.TYPE.pound:
+                case icu_messageformat_parser_1.TYPE.tag:
+                case icu_messageformat_parser_1.TYPE.time:
+                    break;
+                case icu_messageformat_parser_1.TYPE.plural:
+                case icu_messageformat_parser_1.TYPE.select: {
+                    for (var _a = 0, _b = Object.values(element.options); _a < _b.length; _a++) {
+                        var option = _b[_a];
+                        collectLiteralElements(option.value);
+                    }
+                    break;
+                }
+            }
+        }
+    };
+    collectLiteralElements(ast);
+    // Surgically trim whitespaces in the literal element ranges.
+    // This is to preserve the original whitespaces and newlines info that are lost to parsing.
+    var trimmedFragments = [];
+    var currentOffset = 0;
+    for (var _i = 0, literalElements_1 = literalElements; _i < literalElements_1.length; _i++) {
+        var literal = literalElements_1[_i];
+        var _a = literal.location, start = _a.start, end = _a.end;
+        var startOffset = start.offset;
+        var endOffset = end.offset;
+        trimmedFragments.push(message.slice(currentOffset, startOffset));
+        trimmedFragments.push(message.slice(startOffset, endOffset).replace(/\s{2,}/gm, ' '));
+        currentOffset = endOffset;
+    }
+    trimmedFragments.push(message.slice(currentOffset));
+    return trimmedFragments.join('');
+}
 function checkNode(context, node) {
     var msgs = (0, util_1.extractMessages)(node, context.settings);
     var _loop_1 = function (defaultMessage, messageNode) {
         if (!defaultMessage || !messageNode) {
             return "continue";
         }
-        if (MULTIPLE_SPACES.test(defaultMessage)) {
+        var ast;
+        try {
+            ast = (0, icu_messageformat_parser_1.parse)(defaultMessage, { captureLocation: true });
+        }
+        catch (e) {
+            context.report({
+                node: messageNode,
+                message: e instanceof Error ? e.message : String(e),
+            });
+            return { value: void 0 };
+        }
+        if (!isAstValid(ast)) {
             var reportObject = {
                 node: messageNode,
                 message: 'Multiple consecutive whitespaces are not allowed',
             };
-            if (messageNode.type === 'Literal' && messageNode.raw) {
+            if (messageNode.type === 'Literal' &&
+                messageNode.value &&
+                typeof messageNode.value === 'string') {
+                reportObject.fix = function (fixer) {
+                    return fixer.replaceText(messageNode, JSON.stringify(trimMultiWhitespaces(messageNode.value, ast)));
+                };
+            }
+            else if (messageNode.type === 'TemplateLiteral' &&
+                messageNode.quasis.length === 1 &&
+                messageNode.expressions.length === 0) {
                 reportObject.fix = function (fixer) {
-                    return fixer.replaceText(messageNode, messageNode.raw.replace(MULTIPLE_SPACES, ' '));
+                    return fixer.replaceText(messageNode, '`' +
+                        trimMultiWhitespaces(messageNode.quasis[0].value.cooked, ast)
+                            .replace(/\\/g, '\\\\')
+                            .replace(/`/g, '\\`') +
+                        '`');
                 };
             }
             context.report(reportObject);
@@ -23,19 +123,21 @@ function checkNode(context, node) {
     };
     for (var _i = 0, msgs_1 = msgs; _i < msgs_1.length; _i++) {
         var _a = msgs_1[_i][0], defaultMessage = _a.message.defaultMessage, messageNode = _a.messageNode;
-        _loop_1(defaultMessage, messageNode);
+        var state_1 = _loop_1(defaultMessage, messageNode);
+        if (typeof state_1 === "object")
+            return state_1.value;
     }
 }
 var rule = {
     meta: {
         type: 'problem',
         docs: {
-            description: 'Disallow emojis in message',
+            description: 'Prevents usage of multiple consecutive whitespaces in message',
             category: 'Errors',
             recommended: false,
-            url: 'https://formatjs.io/docs/tooling/linter#no-emoji',
+            url: 'https://formatjs.io/docs/tooling/linter#no-multiple-whitespaces',
         },
-        fixable: 'whitespace',
+        fixable: 'code',
     },
     create: function (context) {
         var callExpressionVisitor = function (node) {

package/util.d.ts

@@ -2,7 +2,7 @@ import { TSESTree } from '@typescript-eslint/typescript-estree';
 export interface MessageDescriptor {
     id?: string;
     defaultMessage?: string;
-    description?: string;
+    description?: string | object;
 }
 export interface Settings {
     excludeMessageDeclCalls?: boolean;

package/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../../../packages/eslint-plugin-formatjs/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,sCAAsC,CAAA;AAE7D,MAAM,WAAW,iBAAiB;IAChC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAMD,MAAM,WAAW,QAAQ;IACvB,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAA;IAClC,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAA;IACnC,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AACD,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,iBAAiB,CAAA;IAC1B,WAAW,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;IACzE,eAAe,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAA;IAC3D,eAAe,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;IAC7E,WAAW,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;IACzE,UAAU,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAA;CACvD;AA4ND,wBAAgB,eAAe,CAC7B,IAAI,EAAE,QAAQ,CAAC,IAAI,EACnB,EACE,wBAAwB,EACxB,uBAAuB,EACvB,uBAAuB,GACxB,GAAE,QAAa,GACf,KAAK,CAAC,CAAC,yBAAyB,EAAE,QAAQ,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC,CAiDrE"}
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../../../packages/eslint-plugin-formatjs/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,sCAAsC,CAAA;AAE7D,MAAM,WAAW,iBAAiB;IAChC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAC9B;AAMD,MAAM,WAAW,QAAQ;IACvB,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAA;IAClC,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAA;IACnC,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AACD,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,iBAAiB,CAAA;IAC1B,WAAW,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;IACzE,eAAe,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAA;IAC3D,eAAe,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;IAC7E,WAAW,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC,OAAO,CAAC,CAAA;IACzE,UAAU,CAAC,EAAE,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAA;CACvD;AA4ND,wBAAgB,eAAe,CAC7B,IAAI,EAAE,QAAQ,CAAC,IAAI,EACnB,EACE,wBAAwB,EACxB,uBAAuB,EACvB,uBAAuB,GACxB,GAAE,QAAa,GACf,KAAK,CAAC,CAAC,yBAAyB,EAAE,QAAQ,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC,CAiDrE"}