eslint-plugin-formatjs 4.11.2 → 4.12.0

package/rules/no-invalid-icu.d.ts

@@ -1,3 +1,6 @@
-import { Rule } from 'eslint';
-declare const rule: Rule.RuleModule;
-export default rule;
+import { RuleModule, RuleListener } from '@typescript-eslint/utils/ts-eslint';
+type MessageIds = 'icuError';
+type Options = [];
+export declare const name = "no-invalid-icu";
+export declare const rule: RuleModule<MessageIds, Options, RuleListener>;
+export {};

package/rules/no-invalid-icu.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.rule = exports.name = void 0;
 const icu_messageformat_parser_1 = require("@formatjs/icu-messageformat-parser");
 const util_1 = require("../util");
+exports.name = 'no-invalid-icu';
 function checkNode(context, node) {
     const settings = (0, util_1.getSettings)(context);
     const msgs = (0, util_1.extractMessages)(node, settings);
@@ -21,24 +23,30 @@ function checkNode(context, node) {
             const msg = e instanceof Error ? e.message : e;
             context.report({
                 node: messageNode,
-                message: `Error parsing ICU string: ${msg}`,
+                messageId: 'icuError',
+                data: { message: `Error parsing ICU string: ${msg}` },
             });
         }
     }
 }
-const rule = {
+exports.rule = {
     meta: {
         type: 'problem',
         docs: {
             description: `Make sure ICU messages are formatted correctly with no bad select statements, plurals, etc.`,
-            category: 'Errors',
-            recommended: true,
         },
         fixable: 'code',
+        schema: [],
+        messages: {
+            icuError: 'Invalid ICU Message format: {{message}}',
+        },
     },
+    defaultOptions: [],
     create(context) {
         const callExpressionVisitor = (node) => checkNode(context, node);
+        //@ts-expect-error defineTemplateBodyVisitor exists in Vue parser
         if (context.parserServices.defineTemplateBodyVisitor) {
+            //@ts-expect-error
             return context.parserServices.defineTemplateBodyVisitor({
                 CallExpression: callExpressionVisitor,
             }, {
@@ -51,4 +59,3 @@ const rule = {
         };
     },
 };
-exports.default = rule;

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

@@ -1,3 +1,13 @@
-import type { Rule } from 'eslint';
-declare const rule: Rule.RuleModule;
-export default rule;
+import { RuleModule, RuleListener } from '@typescript-eslint/utils/ts-eslint';
+type PropMatcher = readonly [TagNamePattern: string, PropNamePattern: string][];
+type Config = {
+    props?: {
+        include?: PropMatcher;
+        exclude?: PropMatcher;
+    };
+};
+type MessageIds = 'noLiteralStringInJsx';
+type Options = [Config?];
+export declare const name = "no-literal-string-in-jsx";
+export declare const rule: RuleModule<MessageIds, Options, RuleListener>;
+export {};

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

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.rule = exports.name = void 0;
 const tslib_1 = require("tslib");
 const utils_1 = require("@typescript-eslint/utils");
 const picomatch_1 = tslib_1.__importDefault(require("picomatch"));
@@ -34,13 +35,12 @@ function compilePropMatcher(propMatcher) {
         ];
     });
 }
-const rule = {
+exports.name = 'no-literal-string-in-jsx';
+exports.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: [
@@ -61,7 +61,11 @@ const rule = {
                 },
             },
         ],
+        messages: {
+            noLiteralStringInJsx: 'Cannot have untranslated text in JSX',
+        },
     },
+    defaultOptions: [],
     // TODO: Vue support
     create(context) {
         const userConfig = context.options[0] || {};
@@ -109,7 +113,7 @@ const rule = {
                     (node.quasis.length > 1 || node.quasis[0].value.raw.length > 0))) {
                 context.report({
                     node: node,
-                    message: 'Cannot have untranslated text in JSX',
+                    messageId: 'noLiteralStringInJsx',
                 });
             }
             else if (node.type === 'BinaryExpression' && node.operator === '+') {
@@ -150,7 +154,7 @@ const rule = {
                     node.value.value.length > 0) {
                     context.report({
                         node: node,
-                        message: 'Cannot have untranslated text in JSX',
+                        messageId: 'noLiteralStringInJsx',
                     });
                 }
                 else if (node.value.type === 'JSXExpressionContainer' &&
@@ -165,7 +169,7 @@ const rule = {
                 }
                 context.report({
                     node: node,
-                    message: 'Cannot have untranslated text in JSX',
+                    messageId: 'noLiteralStringInJsx',
                 });
             },
             // Children expression container
@@ -177,4 +181,3 @@ const rule = {
         };
     },
 };
-exports.default = rule;

package/rules/no-multiple-plurals.d.ts

@@ -1,3 +1,6 @@
-import { Rule } from 'eslint';
-declare const rule: Rule.RuleModule;
-export default rule;
+import { RuleModule, RuleListener } from '@typescript-eslint/utils/ts-eslint';
+type MessageIds = 'noMultiplePlurals';
+type Options = [];
+export declare const name = "no-multiple-plurals";
+export declare const rule: RuleModule<MessageIds, Options, RuleListener>;
+export {};

package/rules/no-multiple-plurals.js

@@ -1,26 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.rule = exports.name = void 0;
 const icu_messageformat_parser_1 = require("@formatjs/icu-messageformat-parser");
 const util_1 = require("../util");
-class MultiplePlurals extends Error {
-    constructor() {
-        super(...arguments);
-        this.message = 'Cannot specify more than 1 plural rules';
-    }
-}
 function verifyAst(ast, pluralCount = { count: 0 }) {
+    const errors = [];
     for (const el of ast) {
         if ((0, icu_messageformat_parser_1.isPluralElement)(el)) {
             pluralCount.count++;
             if (pluralCount.count > 1) {
-                throw new MultiplePlurals();
+                errors.push({ messageId: 'noMultiplePlurals', data: {} });
             }
             const { options } = el;
             for (const selector of Object.keys(options)) {
-                verifyAst(options[selector].value, pluralCount);
+                errors.push(...verifyAst(options[selector].value, pluralCount));
             }
         }
     }
+    return errors;
 }
 function checkNode(context, node) {
     const settings = (0, util_1.getSettings)(context);
@@ -29,33 +26,37 @@ function checkNode(context, node) {
         if (!defaultMessage || !messageNode) {
             continue;
         }
-        try {
-            verifyAst((0, icu_messageformat_parser_1.parse)(defaultMessage, {
-                ignoreTag: settings.ignoreTag,
-            }));
-        }
-        catch (e) {
+        const errors = verifyAst((0, icu_messageformat_parser_1.parse)(defaultMessage, {
+            ignoreTag: settings.ignoreTag,
+        }));
+        for (const error of errors) {
             context.report({
-                node: messageNode,
-                message: e instanceof Error ? e.message : String(e),
+                node,
+                ...error,
             });
         }
     }
 }
-const rule = {
+exports.name = 'no-multiple-plurals';
+exports.rule = {
     meta: {
         type: 'problem',
         docs: {
             description: 'Disallow multiple plural rules in the same message',
-            category: 'Errors',
-            recommended: false,
             url: 'https://formatjs.io/docs/tooling/linter#no-multiple-plurals',
         },
         fixable: 'code',
+        schema: [],
+        messages: {
+            noMultiplePlurals: 'Multiple plural rules in the same message',
+        },
     },
+    defaultOptions: [],
     create(context) {
         const callExpressionVisitor = (node) => checkNode(context, node);
+        //@ts-expect-error defineTemplateBodyVisitor exists in Vue parser
         if (context.parserServices.defineTemplateBodyVisitor) {
+            //@ts-expect-error
             return context.parserServices.defineTemplateBodyVisitor({
                 CallExpression: callExpressionVisitor,
             }, {
@@ -68,4 +69,3 @@ const rule = {
         };
     },
 };
-exports.default = rule;

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

@@ -1,3 +1,6 @@
-import { Rule } from 'eslint';
-declare const rule: Rule.RuleModule;
-export default rule;
+import { RuleModule, RuleListener } from '@typescript-eslint/utils/ts-eslint';
+type MessageIds = 'noMultipleWhitespaces' | 'parserError';
+type Options = [];
+export declare const name = "no-multiple-whitespaces";
+export declare const rule: RuleModule<MessageIds, Options, RuleListener>;
+export {};

package/rules/no-multiple-whitespaces.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.rule = exports.name = void 0;
 const icu_messageformat_parser_1 = require("@formatjs/icu-messageformat-parser");
 const util_1 = require("../util");
 function isAstValid(ast) {
@@ -89,7 +90,8 @@ function checkNode(context, node) {
         catch (e) {
             context.report({
                 node: messageNode,
-                message: e instanceof Error ? e.message : String(e),
+                messageId: 'parserError',
+                data: { message: e instanceof Error ? e.message : String(e) },
             });
             return;
         }
@@ -105,23 +107,27 @@ function checkNode(context, node) {
         }
     }
 }
-const rule = {
+exports.name = 'no-multiple-whitespaces';
+exports.rule = {
     meta: {
         type: 'problem',
         docs: {
             description: 'Prevents usage of multiple consecutive whitespaces in message',
-            category: 'Errors',
-            recommended: false,
             url: 'https://formatjs.io/docs/tooling/linter#no-multiple-whitespaces',
         },
         messages: {
             noMultipleWhitespaces: 'Multiple consecutive whitespaces are not allowed',
+            parserError: '{{message}}',
         },
         fixable: 'code',
+        schema: [],
     },
+    defaultOptions: [],
     create(context) {
         const callExpressionVisitor = (node) => checkNode(context, node);
+        //@ts-expect-error defineTemplateBodyVisitor exists in Vue parser
         if (context.parserServices.defineTemplateBodyVisitor) {
+            //@ts-expect-error
             return context.parserServices.defineTemplateBodyVisitor({
                 CallExpression: callExpressionVisitor,
             }, {
@@ -134,4 +140,3 @@ const rule = {
         };
     },
 };
-exports.default = rule;

package/rules/no-offset.d.ts

@@ -1,3 +1,6 @@
-import { Rule } from 'eslint';
-declare const rule: Rule.RuleModule;
-export default rule;
+import { RuleModule, RuleListener } from '@typescript-eslint/utils/ts-eslint';
+type MessageIds = 'noOffset';
+type Options = [];
+export declare const name = "no-offset";
+export declare const rule: RuleModule<MessageIds, Options, RuleListener>;
+export {};

package/rules/no-offset.js

@@ -1,25 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.rule = exports.name = void 0;
 const icu_messageformat_parser_1 = require("@formatjs/icu-messageformat-parser");
 const util_1 = require("../util");
-class NoOffsetError extends Error {
-    constructor() {
-        super(...arguments);
-        this.message = 'offset are not allowed in plural rules';
-    }
-}
 function verifyAst(ast) {
+    const errors = [];
     for (const el of ast) {
         if ((0, icu_messageformat_parser_1.isPluralElement)(el)) {
             if (el.offset) {
-                throw new NoOffsetError();
+                errors.push({ messageId: 'noOffset', data: {} });
             }
             const { options } = el;
             for (const selector of Object.keys(options)) {
-                verifyAst(options[selector].value);
+                errors.push(...verifyAst(options[selector].value));
             }
         }
     }
+    return errors;
 }
 function checkNode(context, node) {
     const settings = (0, util_1.getSettings)(context);
@@ -28,33 +25,37 @@ function checkNode(context, node) {
         if (!defaultMessage || !messageNode) {
             continue;
         }
-        try {
-            verifyAst((0, icu_messageformat_parser_1.parse)(defaultMessage, {
-                ignoreTag: settings.ignoreTag,
-            }));
-        }
-        catch (e) {
+        const errors = verifyAst((0, icu_messageformat_parser_1.parse)(defaultMessage, {
+            ignoreTag: settings.ignoreTag,
+        }));
+        for (const error of errors) {
             context.report({
                 node: messageNode,
-                message: e.message,
+                ...error,
             });
         }
     }
 }
-const rule = {
+exports.name = 'no-offset';
+exports.rule = {
     meta: {
         type: 'problem',
         docs: {
             description: 'Disallow offset in plural rules',
-            category: 'Errors',
-            recommended: false,
             url: 'https://formatjs.io/docs/tooling/linter#no-offset',
         },
         fixable: 'code',
+        messages: {
+            noOffset: 'offset is not allowed',
+        },
+        schema: [],
     },
+    defaultOptions: [],
     create(context) {
         const callExpressionVisitor = (node) => checkNode(context, node);
+        //@ts-expect-error defineTemplateBodyVisitor exists in Vue parser
         if (context.parserServices.defineTemplateBodyVisitor) {
+            //@ts-expect-error
             return context.parserServices.defineTemplateBodyVisitor({
                 CallExpression: callExpressionVisitor,
             }, {
@@ -67,4 +68,3 @@ const rule = {
         };
     },
 };
-exports.default = rule;

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

@@ -1,3 +1,6 @@
-import { Rule } from 'eslint';
-declare const rule: Rule.RuleModule;
-export default rule;
+import { RuleModule, RuleListener } from '@typescript-eslint/utils/ts-eslint';
+type MessageIds = 'unnecessaryFormat' | 'unnecessaryFormatNumber' | 'unnecessaryFormatDate' | 'unnecessaryFormatTime';
+type Options = [];
+export declare const name = "no-useless-message";
+export declare const rule: RuleModule<MessageIds, Options, RuleListener>;
+export {};

package/rules/no-useless-message.js

@@ -1,44 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.rule = exports.name = void 0;
 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();
+            return 'unnecessaryFormat';
         case icu_messageformat_parser_1.TYPE.number:
-            throw new JustNumber();
+            return 'unnecessaryFormatNumber';
         case icu_messageformat_parser_1.TYPE.date:
-            throw new JustDate();
+            return 'unnecessaryFormatDate';
         case icu_messageformat_parser_1.TYPE.time:
-            throw new JustTime();
+            return 'unnecessaryFormatTime';
     }
 }
 function checkNode(context, node) {
@@ -48,32 +25,40 @@ function checkNode(context, node) {
         if (!defaultMessage || !messageNode) {
             continue;
         }
-        try {
-            verifyAst((0, icu_messageformat_parser_1.parse)(defaultMessage, {
-                ignoreTag: settings.ignoreTag,
-            }));
-        }
-        catch (e) {
+        const messageId = verifyAst((0, icu_messageformat_parser_1.parse)(defaultMessage, {
+            ignoreTag: settings.ignoreTag,
+        }));
+        if (messageId)
             context.report({
                 node: messageNode,
-                message: e instanceof Error ? e.message : String(e),
+                messageId,
             });
-        }
     }
 }
-const rule = {
+exports.name = 'no-useless-message';
+exports.rule = {
     meta: {
         type: 'problem',
         docs: {
             description: 'Disallow unnecessary formatted message',
-            recommended: true,
+            recommended: 'recommended',
             url: 'https://formatjs.io/docs/tooling/linter#no-useless-message',
         },
         fixable: 'code',
+        schema: [],
+        messages: {
+            unnecessaryFormat: 'Unnecessary formatted message.',
+            unnecessaryFormatNumber: 'Unnecessary formatted message: just use FormattedNumber or intl.formatNumber.',
+            unnecessaryFormatDate: 'Unnecessary formatted message: just use FormattedDate or intl.formatDate.',
+            unnecessaryFormatTime: 'Unnecessary formatted message: just use FormattedTime or intl.formatTime.',
+        },
     },
+    defaultOptions: [],
     create(context) {
         const callExpressionVisitor = (node) => checkNode(context, node);
+        //@ts-expect-error defineTemplateBodyVisitor exists in Vue parser
         if (context.parserServices.defineTemplateBodyVisitor) {
+            //@ts-expect-error
             return context.parserServices.defineTemplateBodyVisitor({
                 CallExpression: callExpressionVisitor,
             }, {
@@ -86,4 +71,3 @@ const rule = {
         };
     },
 };
-exports.default = rule;

package/rules/prefer-formatted-message.d.ts

@@ -1,3 +1,6 @@
-import type { Rule } from 'eslint';
-declare const rule: Rule.RuleModule;
-export default rule;
+import { RuleModule, RuleListener } from '@typescript-eslint/utils/ts-eslint';
+type MessageIds = 'jsxChildren';
+type Options = [];
+export declare const name = "prefer-formatted-message";
+export declare const rule: RuleModule<MessageIds, Options, RuleListener>;
+export {};

package/rules/prefer-formatted-message.js

@@ -1,18 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.rule = exports.name = void 0;
 const util_1 = require("../util");
-const rule = {
+exports.name = 'prefer-formatted-message';
+exports.rule = {
     meta: {
         type: 'suggestion',
         docs: {
             description: 'Prefer `FormattedMessage` component over `intl.formatMessage` if applicable.',
-            recommended: false,
             url: 'https://formatjs.io/docs/tooling/linter#prefer-formatted-message',
         },
         messages: {
             jsxChildren: 'Prefer `FormattedMessage` over `intl.formatMessage` in the JSX children expression.',
         },
+        schema: [],
     },
+    defaultOptions: [],
     // TODO: Vue support
     create(context) {
         return {
@@ -31,4 +34,3 @@ const rule = {
         };
     },
 };
-exports.default = rule;

package/rules/prefer-pound-in-plural.d.ts

@@ -1,3 +1,6 @@
-import type { Rule } from 'eslint';
-declare const rule: Rule.RuleModule;
-export default rule;
+import { RuleModule, RuleListener } from '@typescript-eslint/utils/ts-eslint';
+type MessageIds = 'preferPoundInPlurals' | 'parseError';
+type Options = [];
+export declare const name = "prefer-pound-in-plural";
+export declare const rule: RuleModule<MessageIds, Options, RuleListener>;
+export {};

package/rules/prefer-pound-in-plural.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.rule = exports.name = void 0;
 const tslib_1 = require("tslib");
 const icu_messageformat_parser_1 = require("@formatjs/icu-messageformat-parser");
 const magic_string_1 = tslib_1.__importDefault(require("magic-string"));
@@ -148,30 +149,36 @@ function checkNode(context, node) {
         catch (e) {
             context.report({
                 node: messageNode,
-                message: e instanceof Error ? e.message : String(e),
+                messageId: 'parseError',
+                data: { message: e instanceof Error ? e.message : String(e) },
             });
             return;
         }
         verifyAst(context, messageNode, ast);
     }
 }
-const rule = {
+exports.name = 'prefer-pound-in-plural';
+exports.rule = {
     meta: {
         type: 'suggestion',
         docs: {
             description: 'Prefer using # to reference the count in the plural argument.',
-            recommended: false,
             url: 'https://formatjs.io/docs/tooling/linter#prefer-pound-in-plurals',
         },
         messages: {
             preferPoundInPlurals: 'Prefer using # to reference the count in the plural argument instead of repeating the argument.',
+            parseError: '{{message}}',
         },
         fixable: 'code',
+        schema: [],
     },
+    defaultOptions: [],
     // TODO: Vue support
     create(context) {
         const callExpressionVisitor = (node) => checkNode(context, node);
+        //@ts-expect-error defineTemplateBodyVisitor exists in Vue parser
         if (context.parserServices.defineTemplateBodyVisitor) {
+            //@ts-expect-error
             return context.parserServices.defineTemplateBodyVisitor({
                 CallExpression: callExpressionVisitor,
             }, {
@@ -184,4 +191,3 @@ const rule = {
         };
     },
 };
-exports.default = rule;

package/util.d.ts

@@ -1,6 +1,6 @@
 import { MessageFormatElement } from '@formatjs/icu-messageformat-parser';
 import { TSESTree } from '@typescript-eslint/utils';
-import { Rule } from 'eslint';
+import { RuleContext } from '@typescript-eslint/utils/ts-eslint';
 export interface MessageDescriptor {
     id?: string;
     defaultMessage?: string;
@@ -20,7 +20,7 @@ export interface MessageDescriptorNodeInfo {
     idValueNode?: TSESTree.Property['value'] | TSESTree.JSXAttribute['value'];
     idPropNode?: TSESTree.Property | TSESTree.JSXAttribute;
 }
-export declare function getSettings({ settings }: Rule.RuleContext): Settings;
+export declare function getSettings<TMessageIds extends string, TOptions extends readonly unknown[]>({ settings }: RuleContext<TMessageIds, TOptions>): Settings;
 export declare function isIntlFormatMessageCall(node: TSESTree.Node): node is TSESTree.CallExpression;
 export declare function extractMessageDescriptor(node?: TSESTree.Expression): MessageDescriptorNodeInfo | undefined;
 export declare function extractMessages(node: TSESTree.Node, { additionalComponentNames, additionalFunctionNames, excludeMessageDeclCalls, }?: Settings): Array<[MessageDescriptorNodeInfo, TSESTree.Expression | undefined]>;