eslint-plugin-formatjs 4.6.0 → 4.7.0

package/index.d.ts

@@ -16,6 +16,8 @@ declare const plugin: {
         'no-multiple-whitespaces': import("eslint").Rule.RuleModule;
         'no-offset': import("eslint").Rule.RuleModule;
         'no-useless-message': import("eslint").Rule.RuleModule;
+        'prefer-formatted-message': import("eslint").Rule.RuleModule;
+        'prefer-pound-in-plural': 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":"AAiBA,QAAA,MAAM,MAAM;;;;;;;;;;;;;;;;;;;CAmBX,CAAA;AAED,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAmBA,QAAA,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;CAqBX,CAAA;AAED,MAAM,MAAM,MAAM,GAAG,OAAO,MAAM,CAAA"}

package/index.js

@@ -17,6 +17,8 @@ const no_multiple_whitespaces_1 = tslib_1.__importDefault(require("./rules/no-mu
 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 prefer_formatted_message_1 = tslib_1.__importDefault(require("./rules/prefer-formatted-message"));
+const prefer_pound_in_plural_1 = tslib_1.__importDefault(require("./rules/prefer-pound-in-plural"));
 const plugin = {
     rules: {
         'blocklist-elements': blocklist_elements_1.default,
@@ -35,6 +37,8 @@ const plugin = {
         'no-multiple-whitespaces': no_multiple_whitespaces_1.default,
         'no-offset': no_offset_1.default,
         'no-useless-message': no_useless_message_1.default,
+        'prefer-formatted-message': prefer_formatted_message_1.default,
+        'prefer-pound-in-plural': prefer_pound_in_plural_1.default,
     },
 };
 module.exports = plugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-formatjs",
-  "version": "4.6.0",
+  "version": "4.7.0",
   "description": "ESLint plugin for formatjs",
   "main": "index.js",
   "repository": {
@@ -26,6 +26,7 @@
     "@types/picomatch": "^2.3.0",
     "@typescript-eslint/typescript-estree": "5.45.0",
     "emoji-regex": "^10.2.1",
+    "magic-string": "^0.29.0",
     "picomatch": "^2.3.1",
     "tslib": "2.4.0",
     "typescript": "^4.7",

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

@@ -1 +1 @@
-{"version":3,"file":"no-multiple-whitespaces.d.ts","sourceRoot":"","sources":["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"}
+{"version":3,"file":"no-multiple-whitespaces.d.ts","sourceRoot":"","sources":["no-multiple-whitespaces.ts"],"names":[],"mappings":"AAOA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAiI3B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAkChB,CAAA;AAED,eAAe,IAAI,CAAA"}

package/rules/no-multiple-whitespaces.js

@@ -15,7 +15,6 @@ function isAstValid(ast) {
             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:
@@ -27,6 +26,8 @@ function isAstValid(ast) {
                 }
                 break;
             }
+            case icu_messageformat_parser_1.TYPE.tag:
+                return isAstValid(element.children);
         }
     }
     return true;
@@ -44,7 +45,6 @@ function trimMultiWhitespaces(message, ast) {
                 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:
@@ -54,6 +54,9 @@ function trimMultiWhitespaces(message, ast) {
                     }
                     break;
                 }
+                case icu_messageformat_parser_1.TYPE.tag:
+                    collectLiteralElements(element.children);
+                    break;
             }
         }
     };
@@ -91,29 +94,14 @@ function checkNode(context, node) {
             return;
         }
         if (!isAstValid(ast)) {
-            const reportObject = {
+            const newMessage = (0, util_1.patchMessage)(messageNode, ast, trimMultiWhitespaces);
+            context.report({
                 node: messageNode,
-                message: 'Multiple consecutive whitespaces are not allowed',
-            };
-            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, '`' +
-                        trimMultiWhitespaces(messageNode.quasis[0].value.cooked, ast)
-                            .replace(/\\/g, '\\\\')
-                            .replace(/`/g, '\\`') +
-                        '`');
-                };
-            }
-            context.report(reportObject);
+                messageId: 'noMultipleWhitespaces',
+                fix: newMessage !== null
+                    ? fixer => fixer.replaceText(messageNode, newMessage)
+                    : null,
+            });
         }
     }
 }
@@ -126,6 +114,9 @@ const rule = {
             recommended: false,
             url: 'https://formatjs.io/docs/tooling/linter#no-multiple-whitespaces',
         },
+        messages: {
+            noMultipleWhitespaces: 'Multiple consecutive whitespaces are not allowed',
+        },
         fixable: 'code',
     },
     create(context) {

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-formatted-message.d.ts","sourceRoot":"","sources":["prefer-formatted-message.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAIhC,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAiChB,CAAA;AAED,eAAe,IAAI,CAAA"}

package/rules/prefer-formatted-message.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../util");
+const 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.',
+        },
+    },
+    // TODO: Vue support
+    create(context) {
+        return {
+            JSXElement: (node) => {
+                node.children.forEach(child => {
+                    if (child.type !== 'JSXExpressionContainer' ||
+                        !(0, util_1.isIntlFormatMessageCall)(child.expression)) {
+                        return;
+                    }
+                    context.report({
+                        node: node,
+                        messageId: 'jsxChildren',
+                    });
+                });
+            },
+        };
+    },
+};
+exports.default = rule;

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"prefer-pound-in-plural.d.ts","sourceRoot":"","sources":["prefer-pound-in-plural.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AA6MhC,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAmChB,CAAA;AAED,eAAe,IAAI,CAAA"}

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

@@ -0,0 +1,187 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const icu_messageformat_parser_1 = require("@formatjs/icu-messageformat-parser");
+const util_1 = require("../util");
+const magic_string_1 = tslib_1.__importDefault(require("magic-string"));
+function verifyAst(context, messageNode, ast) {
+    const patches = [];
+    _verifyAst(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: 'preferPoundInPlurals',
+            fix: patchedMessage !== null
+                ? fixer => fixer.replaceText(messageNode, patchedMessage)
+                : null,
+        });
+    }
+    function _verifyAst(ast) {
+        for (let i = 0; i < ast.length; i++) {
+            const current = ast[i];
+            switch (current.type) {
+                case icu_messageformat_parser_1.TYPE.argument:
+                case icu_messageformat_parser_1.TYPE.number: {
+                    // Applicable to only plain argument or number argument without any style
+                    if (current.type === icu_messageformat_parser_1.TYPE.number && current.style) {
+                        break;
+                    }
+                    const next = ast[i + 1];
+                    const nextNext = ast[i + 2];
+                    if (next &&
+                        nextNext &&
+                        next.type === icu_messageformat_parser_1.TYPE.literal &&
+                        next.value === ' ' &&
+                        nextNext.type === icu_messageformat_parser_1.TYPE.plural &&
+                        nextNext.value === current.value) {
+                        // `{A} {A, plural, one {B} other {Bs}}` => `{A, plural, one {# B} other {# Bs}}`
+                        _removeRangeAndPrependPluralClauses(current.location.start.offset, next.location.end.offset, nextNext, '# ');
+                    }
+                    else if (next &&
+                        next.type === icu_messageformat_parser_1.TYPE.plural &&
+                        next.value === current.value) {
+                        // `{A}{A, plural, one {B} other {Bs}}` => `{A, plural, one {#B} other {#Bs}}`
+                        _removeRangeAndPrependPluralClauses(current.location.start.offset, current.location.end.offset, next, '#');
+                    }
+                    break;
+                }
+                case icu_messageformat_parser_1.TYPE.plural: {
+                    // `{A, plural, one {{A} B} other {{A} Bs}}` => `{A, plural, one {# B} other {# Bs}}`
+                    const name = current.value;
+                    for (const { value } of Object.values(current.options)) {
+                        _replacementArgumentWithPound(name, value);
+                    }
+                    break;
+                }
+                case icu_messageformat_parser_1.TYPE.select: {
+                    for (const { value } of Object.values(current.options)) {
+                        _verifyAst(value);
+                    }
+                    break;
+                }
+                case icu_messageformat_parser_1.TYPE.tag:
+                    _verifyAst(current.children);
+                    break;
+                default:
+                    break;
+            }
+        }
+    }
+    // Replace plain argument of number argument w/o style option that matches
+    // the name with a pound sign.
+    function _replacementArgumentWithPound(name, ast) {
+        for (const element of ast) {
+            switch (element.type) {
+                case icu_messageformat_parser_1.TYPE.argument:
+                case icu_messageformat_parser_1.TYPE.number: {
+                    if (element.value === name &&
+                        // Either plain argument or number argument without any style
+                        (element.type !== icu_messageformat_parser_1.TYPE.number || !element.style)) {
+                        patches.push({
+                            type: 'update',
+                            start: element.location.start.offset,
+                            end: element.location.end.offset,
+                            content: '#',
+                        });
+                    }
+                    break;
+                }
+                case icu_messageformat_parser_1.TYPE.tag: {
+                    _replacementArgumentWithPound(name, element.children);
+                    break;
+                }
+                case icu_messageformat_parser_1.TYPE.select: {
+                    for (const { value } of Object.values(element.options)) {
+                        _replacementArgumentWithPound(name, value);
+                    }
+                    break;
+                }
+                default:
+                    break;
+            }
+        }
+    }
+    // Helper to remove a certain text range and then prepend the specified text to
+    // each plural clause.
+    function _removeRangeAndPrependPluralClauses(rangeToRemoveStart, rangeToRemoveEnd, pluralElement, prependText) {
+        // Delete both the `{A}` and ` `
+        patches.push({
+            type: 'remove',
+            start: rangeToRemoveStart,
+            end: rangeToRemoveEnd,
+        });
+        // Insert `# ` to the beginning of every option clause
+        for (const { location } of Object.values(pluralElement.options)) {
+            // location marks the entire clause with the surrounding braces
+            patches.push({
+                type: 'prependLeft',
+                index: location.start.offset + 1,
+                content: prependText,
+            });
+        }
+    }
+}
+function checkNode(context, node) {
+    const msgs = (0, util_1.extractMessages)(node, (0, util_1.getSettings)(context));
+    for (const [{ message: { defaultMessage }, messageNode, },] of msgs) {
+        if (!defaultMessage || !messageNode) {
+            continue;
+        }
+        let 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;
+        }
+        verifyAst(context, messageNode, ast);
+    }
+}
+const 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.',
+        },
+        fixable: 'code',
+    },
+    // TODO: Vue support
+    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;

package/util.d.ts

@@ -1,5 +1,6 @@
 import { Rule } from 'eslint';
 import { TSESTree } from '@typescript-eslint/typescript-estree';
+import { MessageFormatElement } from '@formatjs/icu-messageformat-parser';
 export interface MessageDescriptor {
     id?: string;
     defaultMessage?: string;
@@ -20,5 +21,13 @@ export interface MessageDescriptorNodeInfo {
     idPropNode?: TSESTree.Property | TSESTree.JSXAttribute;
 }
 export declare function getSettings({ settings }: Rule.RuleContext): 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]>;
+/**
+ * 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,
+ * it means that the patch cannot be applied.
+ */
+export declare function patchMessage(messageNode: TSESTree.Node, ast: MessageFormatElement[], patcher: (messageContent: string, ast: MessageFormatElement[]) => string): string | null;
 //# sourceMappingURL=util.d.ts.map

package/util.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAC3B,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;AAED,wBAAgB,WAAW,CAAC,EAAC,QAAQ,EAAC,EAAE,IAAI,CAAC,WAAW,GAAG,QAAQ,CAElE;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":["util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAC3B,OAAO,EAAC,QAAQ,EAAC,MAAM,sCAAsC,CAAA;AAC7D,OAAO,EAAC,oBAAoB,EAAC,MAAM,oCAAoC,CAAA;AAEvE,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;AAED,wBAAgB,WAAW,CAAC,EAAC,QAAQ,EAAC,EAAE,IAAI,CAAC,WAAW,GAAG,QAAQ,CAElE;AA8BD,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,QAAQ,CAAC,IAAI,GAClB,IAAI,IAAI,QAAQ,CAAC,cAAc,CAWjC;AAqBD,wBAAgB,wBAAwB,CACtC,IAAI,CAAC,EAAE,QAAQ,CAAC,UAAU,GACzB,yBAAyB,GAAG,SAAS,CA8CvC;AA8GD,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;AAED;;;;GAIG;AACH,wBAAgB,YAAY,CAC1B,WAAW,EAAE,QAAQ,CAAC,IAAI,EAC1B,GAAG,EAAE,oBAAoB,EAAE,EAC3B,OAAO,EAAE,CAAC,cAAc,EAAE,MAAM,EAAE,GAAG,EAAE,oBAAoB,EAAE,KAAK,MAAM,GACvE,MAAM,GAAG,IAAI,CAsBf"}

package/util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractMessages = exports.getSettings = void 0;
+exports.patchMessage = exports.extractMessages = exports.extractMessageDescriptor = exports.isIntlFormatMessageCall = exports.getSettings = void 0;
 const FORMAT_FUNCTION_NAMES = new Set(['$formatMessage', 'formatMessage', '$t']);
 const COMPONENT_NAMES = new Set(['FormattedMessage']);
 const DECLARATION_FUNCTION_NAMES = new Set(['defineMessage']);
@@ -37,6 +37,7 @@ 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' &&
@@ -95,6 +96,7 @@ function extractMessageDescriptor(node) {
     }
     return result;
 }
+exports.extractMessageDescriptor = extractMessageDescriptor;
 function extractMessageDescriptorFromJSXElement(node) {
     if (!node || !node.attributes) {
         return;
@@ -238,3 +240,26 @@ 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,
+ * it means that the patch cannot be applied.
+ */
+function patchMessage(messageNode, ast, patcher) {
+    if (messageNode.type === 'Literal' &&
+        messageNode.value &&
+        typeof messageNode.value === 'string') {
+        return JSON.stringify(patcher(messageNode.value, ast));
+    }
+    else if (messageNode.type === 'TemplateLiteral' &&
+        messageNode.quasis.length === 1 &&
+        messageNode.expressions.length === 0) {
+        return ('`' +
+            patcher(messageNode.quasis[0].value.cooked, ast)
+                .replace(/\\/g, '\\\\')
+                .replace(/`/g, '\\`') +
+            '`');
+    }
+    return null;
+}
+exports.patchMessage = patchMessage;