eslint-plugin-formatjs 4.3.9 → 4.4.0

package/index.d.ts

@@ -10,11 +10,12 @@ declare const plugin: {
         'no-complex-selectors': import("eslint").Rule.RuleModule;
         'no-emoji': import("eslint").Rule.RuleModule;
         'no-id': import("eslint").Rule.RuleModule;
+        'no-invalid-icu': import("eslint").Rule.RuleModule;
         'no-literal-string-in-jsx': import("eslint").Rule.RuleModule;
         'no-multiple-plurals': import("eslint").Rule.RuleModule;
         'no-multiple-whitespaces': import("eslint").Rule.RuleModule;
-        'no-invalid-icu': import("eslint").Rule.RuleModule;
         'no-offset': import("eslint").Rule.RuleModule;
+        'no-useless-message': import("eslint").Rule.RuleModule;
     };
 };
 export type Plugin = typeof plugin;

package/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAeA,QAAA,MAAM,MAAM;;;;;;;;;;;;;;;;;;CAkBX,CAAA;AAED,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAiBA,QAAA,MAAM,MAAM;;;;;;;;;;;;;;;;;;;CAmBX,CAAA;AAED,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAA"}

package/index.js

@@ -16,6 +16,7 @@ const no_multiple_plurals_1 = tslib_1.__importDefault(require("./rules/no-multip
 const no_multiple_whitespaces_1 = tslib_1.__importDefault(require("./rules/no-multiple-whitespaces"));
 const no_offset_1 = tslib_1.__importDefault(require("./rules/no-offset"));
 const no_literal_string_in_jsx_1 = tslib_1.__importDefault(require("./rules/no-literal-string-in-jsx"));
+const no_useless_message_1 = tslib_1.__importDefault(require("./rules/no-useless-message"));
 const plugin = {
     rules: {
         'blocklist-elements': blocklist_elements_1.default,
@@ -28,11 +29,12 @@ const plugin = {
         'no-complex-selectors': no_complex_selectors_1.default,
         'no-emoji': no_emoji_1.default,
         'no-id': no_id_1.default,
+        'no-invalid-icu': no_invalid_icu_1.default,
         'no-literal-string-in-jsx': no_literal_string_in_jsx_1.default,
         'no-multiple-plurals': no_multiple_plurals_1.default,
         'no-multiple-whitespaces': no_multiple_whitespaces_1.default,
-        'no-invalid-icu': no_invalid_icu_1.default,
         'no-offset': no_offset_1.default,
-    },
+        'no-useless-message': no_useless_message_1.default
+    }
 };
 module.exports = plugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-formatjs",
-  "version": "4.3.9",
+  "version": "4.4.0",
   "description": "ESLint plugin for formatjs",
   "main": "index.js",
   "repository": {

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

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

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

@@ -7,8 +7,8 @@ const propMatcherSchema = {
     type: 'array',
     items: {
         type: 'array',
-        items: [{ type: 'string' }, { type: 'string' }],
-    },
+        items: [{ type: 'string' }, { type: 'string' }]
+    }
 };
 const defaultPropIncludePattern = [
     ['*', 'aria-{label,description,details,errormessage}'],
@@ -41,7 +41,7 @@ const rule = {
             description: 'Disallow untranslated literal strings without translation.',
             category: 'Errors',
             recommended: false,
-            url: 'https://formatjs.io/docs/tooling/linter#no-literal-string-in-jsx',
+            url: 'https://formatjs.io/docs/tooling/linter#no-literal-string-in-jsx'
         },
         schema: [
             {
@@ -51,16 +51,16 @@ const rule = {
                         type: 'object',
                         properties: {
                             include: {
-                                ...propMatcherSchema,
+                                ...propMatcherSchema
                             },
                             exclude: {
-                                ...propMatcherSchema,
-                            },
-                        },
-                    },
-                },
+                                ...propMatcherSchema
+                            }
+                        }
+                    }
+                }
             },
-        ],
+        ]
     },
     // TODO: Vue support
     create(context) {
@@ -109,13 +109,17 @@ const rule = {
                     (node.quasis.length > 1 || node.quasis[0].value.raw.length > 0))) {
                 context.report({
                     node: node,
-                    message: 'Cannot have untranslated text in JSX',
+                    message: 'Cannot have untranslated text in JSX'
                 });
             }
             else if (node.type === 'BinaryExpression' && node.operator === '+') {
                 checkJSXExpression(node.left);
                 checkJSXExpression(node.right);
             }
+            else if (node.type === 'ConditionalExpression') {
+                checkJSXExpression(node.consequent);
+                checkJSXExpression(node.alternate);
+            }
         };
         return {
             JSXElement: (node) => {
@@ -142,7 +146,7 @@ const rule = {
                     node.value.value.length > 0) {
                     context.report({
                         node: node,
-                        message: 'Cannot have untranslated text in JSX',
+                        message: 'Cannot have untranslated text in JSX'
                     });
                 }
                 else if (node.value.type === 'JSXExpressionContainer' &&
@@ -157,7 +161,7 @@ const rule = {
                 }
                 context.report({
                     node: node,
-                    message: 'Cannot have untranslated text in JSX',
+                    message: 'Cannot have untranslated text in JSX'
                 });
             },
             // Children expression container
@@ -165,8 +169,8 @@ const rule = {
                 if (node.expression.type !== 'JSXEmptyExpression') {
                     checkJSXExpression(node.expression);
                 }
-            },
+            }
         };
-    },
+    }
 };
 exports.default = rule;

package/rules/no-useless-message.d.ts

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

package/rules/no-useless-message.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"no-useless-message.d.ts","sourceRoot":"","sources":["no-useless-message.ts"],"names":[],"mappings":"AAMA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAmE3B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA6BhB,CAAA;AAED,eAAe,IAAI,CAAA"}

package/rules/no-useless-message.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const icu_messageformat_parser_1 = require("@formatjs/icu-messageformat-parser");
+const util_1 = require("../util");
+class JustArgument extends Error {
+    constructor() {
+        super(...arguments);
+        this.message = 'Unnecessary formatted message.';
+    }
+}
+class JustNumber extends Error {
+    constructor() {
+        super(...arguments);
+        this.message = 'Unnecessary formatted message: just use FormattedNumber or intl.formatNumber.';
+    }
+}
+class JustDate extends Error {
+    constructor() {
+        super(...arguments);
+        this.message = 'Unnecessary formatted message: just use FormattedDate or intl.formatDate.';
+    }
+}
+class JustTime extends Error {
+    constructor() {
+        super(...arguments);
+        this.message = 'Unnecessary formatted message: just use FormattedTime or intl.formatTime.';
+    }
+}
+function verifyAst(ast) {
+    if (ast.length !== 1) {
+        return;
+    }
+    switch (ast[0].type) {
+        case icu_messageformat_parser_1.TYPE.argument:
+            throw new JustArgument();
+        case icu_messageformat_parser_1.TYPE.number:
+            throw new JustNumber();
+        case icu_messageformat_parser_1.TYPE.date:
+            throw new JustDate();
+        case icu_messageformat_parser_1.TYPE.time:
+            throw new JustTime();
+    }
+}
+function checkNode(context, node) {
+    const settings = (0, util_1.getSettings)(context);
+    const msgs = (0, util_1.extractMessages)(node, settings);
+    for (const [{ message: { defaultMessage }, messageNode, },] of msgs) {
+        if (!defaultMessage || !messageNode) {
+            continue;
+        }
+        try {
+            verifyAst((0, icu_messageformat_parser_1.parse)(defaultMessage, {
+                ignoreTag: settings.ignoreTag
+            }));
+        }
+        catch (e) {
+            context.report({
+                node: messageNode,
+                message: e instanceof Error ? e.message : String(e)
+            });
+        }
+    }
+}
+const rule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Disallow unnecessary formatted message',
+            recommended: true,
+            url: 'https://formatjs.io/docs/tooling/linter#no-useless-message'
+        },
+        fixable: 'code'
+    },
+    create(context) {
+        const callExpressionVisitor = (node) => checkNode(context, node);
+        if (context.parserServices.defineTemplateBodyVisitor) {
+            return context.parserServices.defineTemplateBodyVisitor({
+                CallExpression: callExpressionVisitor
+            }, {
+                CallExpression: callExpressionVisitor
+            });
+        }
+        return {
+            JSXOpeningElement: (node) => checkNode(context, node),
+            CallExpression: callExpressionVisitor
+        };
+    }
+};
+exports.default = rule;