eslint-plugin-formatjs 5.0.2 → 5.1.1

package/index.js

@@ -18,6 +18,7 @@ const no_literal_string_in_jsx_1 = require("./rules/no-literal-string-in-jsx");
 const no_useless_message_1 = require("./rules/no-useless-message");
 const prefer_formatted_message_1 = require("./rules/prefer-formatted-message");
 const prefer_pound_in_plural_1 = require("./rules/prefer-pound-in-plural");
+const no_missing_icu_plural_one_placeholders_1 = require("./rules/no-missing-icu-plural-one-placeholders");
 const plugin = {
     rules: {
         [blocklist_elements_1.name]: blocklist_elements_1.rule,
@@ -38,6 +39,7 @@ const plugin = {
         [no_useless_message_1.name]: no_useless_message_1.rule,
         [prefer_formatted_message_1.name]: prefer_formatted_message_1.rule,
         [prefer_pound_in_plural_1.name]: prefer_pound_in_plural_1.rule,
+        [no_missing_icu_plural_one_placeholders_1.name]: no_missing_icu_plural_one_placeholders_1.rule,
     },
 };
 module.exports = plugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-formatjs",
-  "version": "5.0.2",
+  "version": "5.1.1",
   "description": "ESLint plugin for formatjs",
   "main": "index.js",
   "repository": {
@@ -22,15 +22,15 @@
   "dependencies": {
     "@types/eslint": "9",
     "@types/picomatch": "^2.3.0",
-    "@typescript-eslint/utils": "8.5.0",
+    "@typescript-eslint/utils": "8.10.0",
     "emoji-regex": "^10.2.1",
     "magic-string": "^0.30.0",
     "picomatch": "^2.3.1",
-    "tslib": "2.6.2",
+    "tslib": "^2.7.0",
     "typescript": "5",
     "unicode-emoji-utils": "^1.2.0",
-    "@formatjs/icu-messageformat-parser": "2.7.9",
-    "@formatjs/ts-transformer": "3.13.15"
+    "@formatjs/icu-messageformat-parser": "2.7.10",
+    "@formatjs/ts-transformer": "3.13.16"
   },
   "peerDependencies": {
     "eslint": "9"

package/rules/no-missing-icu-plural-one-placeholders.d.ts

@@ -0,0 +1,6 @@
+import { RuleModule } from '@typescript-eslint/utils/ts-eslint';
+export declare const name = "no-missing-icu-plural-one-placeholders";
+export type MessageIds = 'noMissingIcuPluralOnePlaceholders';
+type Options = [];
+export declare const rule: RuleModule<MessageIds, Options>;
+export {};

package/rules/no-missing-icu-plural-one-placeholders.js

@@ -0,0 +1,103 @@
+"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"));
+const context_compat_1 = require("../context-compat");
+const util_1 = require("../util");
+exports.name = 'no-missing-icu-plural-one-placeholders';
+function verifyAst(context, messageNode, ast) {
+    const patches = [];
+    _verifyAstAndReplace(ast);
+    if (patches.length > 0) {
+        const patchedMessage = (0, util_1.patchMessage)(messageNode, ast, content => {
+            return patches
+                .reduce((magicString, patch) => {
+                switch (patch.type) {
+                    case 'prependLeft':
+                        return magicString.prependLeft(patch.index, patch.content);
+                    case 'remove':
+                        return magicString.remove(patch.start, patch.end);
+                    case 'update':
+                        return magicString.update(patch.start, patch.end, patch.content);
+                }
+            }, new magic_string_1.default(content))
+                .toString();
+        });
+        context.report({
+            node: messageNode,
+            messageId: 'noMissingIcuPluralOnePlaceholders',
+            fix: patchedMessage !== null
+                ? fixer => fixer.replaceText(messageNode, patchedMessage)
+                : null,
+        });
+    }
+    function _verifyAstAndReplace(ast, root = true) {
+        for (const el of ast) {
+            if ((0, icu_messageformat_parser_1.isPluralElement)(el) && el.options['one']) {
+                _verifyAstAndReplace(el.options['one'].value, false);
+            }
+            else if ((0, icu_messageformat_parser_1.isSelectElement)(el)) {
+                for (const { value } of Object.values(el.options)) {
+                    _verifyAstAndReplace(value, root);
+                }
+            }
+            else if ((0, icu_messageformat_parser_1.isTagElement)(el)) {
+                _verifyAstAndReplace(el.children, root);
+            }
+            else if (!root && (0, icu_messageformat_parser_1.isLiteralElement)(el)) {
+                const match = el.value.match(/\b1\b/);
+                if (match && el.location) {
+                    patches.push({
+                        type: 'update',
+                        start: el.location.start.offset,
+                        end: el.location.end.offset,
+                        content: el.value.replace(match[0], '#'),
+                    });
+                }
+            }
+        }
+    }
+}
+function checkNode(context, node) {
+    const msgs = (0, util_1.extractMessages)(node);
+    for (const [{ message: { defaultMessage }, messageNode, },] of msgs) {
+        if (!defaultMessage || !messageNode) {
+            continue;
+        }
+        verifyAst(context, messageNode, (0, icu_messageformat_parser_1.parse)(defaultMessage, { captureLocation: true }));
+    }
+}
+exports.rule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'We use `one {# item}` instead of `one {1 item}` in ICU messages as some locales use the `one` formatting for other similar numbers.',
+            url: 'https://formatjs.io/docs/tooling/linter#no-explicit-icu-plural',
+        },
+        fixable: 'code',
+        messages: {
+            noMissingIcuPluralOnePlaceholders: 'Use `one {# item}` instead of `one {1 item}` in ICU messages.',
+        },
+        schema: [],
+    },
+    defaultOptions: [],
+    create(context) {
+        const callExpressionVisitor = (node) => checkNode(context, node);
+        const parserServices = (0, context_compat_1.getParserServices)(context);
+        //@ts-expect-error defineTemplateBodyVisitor exists in Vue parser
+        if (parserServices.defineTemplateBodyVisitor) {
+            //@ts-expect-error
+            return parserServices.defineTemplateBodyVisitor({
+                CallExpression: callExpressionVisitor,
+            }, {
+                CallExpression: callExpressionVisitor,
+            });
+        }
+        return {
+            JSXOpeningElement: (node) => checkNode(context, node),
+            CallExpression: callExpressionVisitor,
+        };
+    },
+};

package/util.js

@@ -1,13 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.patchMessage = exports.extractMessages = exports.extractMessageDescriptor = exports.isIntlFormatMessageCall = exports.getSettings = void 0;
+exports.getSettings = getSettings;
+exports.isIntlFormatMessageCall = isIntlFormatMessageCall;
+exports.extractMessageDescriptor = extractMessageDescriptor;
+exports.extractMessages = extractMessages;
+exports.patchMessage = patchMessage;
 const FORMAT_FUNCTION_NAMES = new Set(['$formatMessage', 'formatMessage', '$t']);
 const COMPONENT_NAMES = new Set(['FormattedMessage']);
 const DECLARATION_FUNCTION_NAMES = new Set(['defineMessage']);
 function getSettings({ settings }) {
     return settings.formatjs ?? settings;
 }
-exports.getSettings = getSettings;
 function isStringLiteral(node) {
     return node.type === 'Literal' && typeof node.value === 'string';
 }
@@ -41,7 +44,6 @@ function isIntlFormatMessageCall(node) {
         node.arguments.length >= 1 &&
         node.arguments[0].type === 'ObjectExpression');
 }
-exports.isIntlFormatMessageCall = isIntlFormatMessageCall;
 function isSingleMessageDescriptorDeclaration(node, functionNames) {
     return (node.type === 'CallExpression' &&
         node.callee.type === 'Identifier' &&
@@ -100,7 +102,6 @@ function extractMessageDescriptor(node) {
     }
     return result;
 }
-exports.extractMessageDescriptor = extractMessageDescriptor;
 function extractMessageDescriptorFromJSXElement(node) {
     if (!node || !node.attributes) {
         return;
@@ -243,7 +244,6 @@ function extractMessages(node, { additionalComponentNames, additionalFunctionNam
     }
     return [];
 }
-exports.extractMessages = extractMessages;
 /**
  * Apply changes to the ICU message in code. The return value can be used in
  * `fixer.replaceText(messageNode, <return value>)`. If the return value is null,
@@ -266,4 +266,3 @@ function patchMessage(messageNode, ast, patcher) {
     }
     return null;
 }
-exports.patchMessage = patchMessage;