eslint-plugin-formatjs 5.2.14 → 5.3.0

package/index.js

@@ -19,6 +19,7 @@ const no_offset_1 = require("./rules/no-offset");
 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_literal_string_in_object_1 = require("./rules/no-literal-string-in-object");
 const package_json_1 = require("./package.json");
 // All rules
 const rules = {
@@ -60,6 +61,8 @@ const rules = {
     [prefer_pound_in_plural_1.name]: prefer_pound_in_plural_1.rule,
     // @ts-expect-error
     [no_missing_icu_plural_one_placeholders_1.name]: no_missing_icu_plural_one_placeholders_1.rule,
+    // @ts-expect-error
+    [no_literal_string_in_object_1.name]: no_literal_string_in_object_1.rule,
 };
 // Base plugin
 const plugin = {

package/lib_esnext/index.js

@@ -17,6 +17,7 @@ import { rule as noOffset, name as noOffsetName } from './rules/no-offset';
 import { rule as noUselessMessage, name as noUselessMessageName, } from './rules/no-useless-message';
 import { rule as preferFormattedMessage, name as preferFormattedMessageName, } from './rules/prefer-formatted-message';
 import { rule as preferPoundInPlural, name as preferPoundInPluralName, } from './rules/prefer-pound-in-plural';
+import { rule as noLiteralStringInObject, name as noLiteralStringInObjectName, } from './rules/no-literal-string-in-object';
 import { name, version } from './package.json';
 // All rules
 const rules = {
@@ -58,6 +59,8 @@ const rules = {
     [preferPoundInPluralName]: preferPoundInPlural,
     // @ts-expect-error
     [noMissingIcuPluralOnePlaceholdersName]: noMissingIcuPluralOnePlaceholders,
+    // @ts-expect-error
+    [noLiteralStringInObjectName]: noLiteralStringInObject,
 };
 // Base plugin
 const plugin = {

package/lib_esnext/package.json

@@ -1,36 +1,31 @@
 {
     "name": "eslint-plugin-formatjs",
-    "version": "5.2.14",
     "description": "ESLint plugin for formatjs",
-    "main": "index.js",
-    "repository": {
-        "type": "git",
-        "url": "git+ssh://git@github.com/formatjs/formatjs.git"
-    },
-    "keywords": [
-        "eslint",
-        "eslintplugin",
-        "i18n",
-        "formatjs"
-    ],
-    "author": "Long Ho <holevietlong@gmail.com>",
+    "version": "5.3.0",
     "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/formatjs/formatjs/issues"
-    },
-    "homepage": "https://github.com/formatjs/formatjs#readme",
+    "author": "Long Ho <holevietlong@gmail.com>",
     "dependencies": {
         "@formatjs/icu-messageformat-parser": "workspace:*",
         "@formatjs/ts-transformer": "workspace:*",
-        "@types/eslint": "9",
-        "@types/picomatch": "3",
-        "@typescript-eslint/utils": "8.20.0",
+        "@types/eslint": "^9.6.1",
+        "@types/picomatch": "^3",
+        "@typescript-eslint/utils": "^8.27.0",
         "magic-string": "^0.30.0",
         "picomatch": "2 || 3 || 4",
-        "tslib": "2",
+        "tslib": "^2.8.0",
         "unicode-emoji-utils": "^1.2.0"
     },
     "peerDependencies": {
-        "eslint": "9"
-    }
+        "eslint": "^9.23.0"
+    },
+    "bugs": "https://github.com/formatjs/formatjs/issues",
+    "homepage": "https://github.com/formatjs/formatjs#readme",
+    "keywords": [
+        "eslint",
+        "eslintplugin",
+        "formatjs",
+        "i18n"
+    ],
+    "main": "index.js",
+    "repository": "formatjs/formatjs.git"
 }

package/lib_esnext/rules/no-literal-string-in-object.d.ts

@@ -0,0 +1,9 @@
+import { RuleModule } from '@typescript-eslint/utils/ts-eslint';
+type MessageIds = 'untranslatedProperty';
+type PropertyConfig = {
+    include: string[];
+};
+type Options = [PropertyConfig?];
+export declare const name = "no-literal-string-in-object";
+export declare const rule: RuleModule<MessageIds, Options>;
+export {};

package/lib_esnext/rules/no-literal-string-in-object.js

@@ -0,0 +1,90 @@
+import { TSESTree } from '@typescript-eslint/utils';
+import { getParserServices } from '../context-compat';
+export const name = 'no-literal-string-in-object';
+export const rule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Enforce translation of specific object properties',
+            url: 'https://formatjs.github.io/docs/tooling/linter#no-literal-string-in-object',
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    include: {
+                        type: 'array',
+                        items: { type: 'string' },
+                        default: ['label'],
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+        messages: {
+            untranslatedProperty: 'Object property: `{{propertyKey}}` might contain an untranslated literal string',
+        },
+    },
+    defaultOptions: [],
+    create(context) {
+        const propertyVisitor = (node) => {
+            checkProperty(context, node);
+        };
+        const parserServices = getParserServices(context);
+        //@ts-expect-error defineTemplateBodyVisitor exists in Vue parser
+        if (parserServices?.defineTemplateBodyVisitor) {
+            //@ts-expect-error
+            return parserServices.defineTemplateBodyVisitor({
+                Property: propertyVisitor,
+            }, {
+                Property: propertyVisitor,
+            });
+        }
+        return {
+            Property: propertyVisitor,
+        };
+    },
+};
+function checkProperty(context, node) {
+    const config = {
+        include: ['label'],
+        ...(context.options[0] || {}),
+    };
+    const propertyKey = node.key.type === TSESTree.AST_NODE_TYPES.Identifier
+        ? node.key.name
+        : node.key.type === TSESTree.AST_NODE_TYPES.Literal &&
+            typeof node.key.value === 'string'
+            ? node.key.value
+            : null;
+    if (!propertyKey || !config.include.includes(propertyKey)) {
+        return;
+    }
+    checkPropertyValue(context, node.value, propertyKey);
+}
+function checkPropertyValue(context, node, propertyKey) {
+    if ((node.type === 'Literal' &&
+        typeof node.value === 'string' &&
+        node.value.length > 0) ||
+        (node.type === 'TemplateLiteral' &&
+            (node.quasis.length > 1 || node.quasis[0].value.raw.length > 0))) {
+        context.report({
+            node: node,
+            messageId: 'untranslatedProperty',
+            data: {
+                propertyKey: propertyKey,
+            },
+        });
+    }
+    else if (node.type === 'BinaryExpression' && node.operator === '+') {
+        checkPropertyValue(context, node.left, propertyKey);
+        checkPropertyValue(context, node.right, propertyKey);
+    }
+    else if (node.type === 'ConditionalExpression') {
+        checkPropertyValue(context, node.consequent, propertyKey);
+        checkPropertyValue(context, node.alternate, propertyKey);
+    }
+    else if (node.type === 'LogicalExpression') {
+        checkPropertyValue(context, node.left, propertyKey);
+        checkPropertyValue(context, node.right, propertyKey);
+    }
+}

package/package.json

@@ -1,36 +1,31 @@
 {
   "name": "eslint-plugin-formatjs",
-  "version": "5.2.14",
   "description": "ESLint plugin for formatjs",
-  "main": "index.js",
-  "repository": {
-    "type": "git",
-    "url": "git+ssh://git@github.com/formatjs/formatjs.git"
-  },
-  "keywords": [
-    "eslint",
-    "eslintplugin",
-    "i18n",
-    "formatjs"
-  ],
-  "author": "Long Ho <holevietlong@gmail.com>",
+  "version": "5.3.0",
   "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/formatjs/formatjs/issues"
-  },
-  "homepage": "https://github.com/formatjs/formatjs#readme",
+  "author": "Long Ho <holevietlong@gmail.com>",
   "dependencies": {
-    "@types/eslint": "9",
-    "@types/picomatch": "3",
-    "@typescript-eslint/utils": "8.20.0",
+    "@types/eslint": "^9.6.1",
+    "@types/picomatch": "^3",
+    "@typescript-eslint/utils": "^8.27.0",
     "magic-string": "^0.30.0",
     "picomatch": "2 || 3 || 4",
-    "tslib": "2",
+    "tslib": "^2.8.0",
     "unicode-emoji-utils": "^1.2.0",
-    "@formatjs/icu-messageformat-parser": "2.11.1",
-    "@formatjs/ts-transformer": "3.13.32"
+    "@formatjs/icu-messageformat-parser": "2.11.2",
+    "@formatjs/ts-transformer": "3.13.33"
   },
   "peerDependencies": {
-    "eslint": "9"
-  }
+    "eslint": "^9.23.0"
+  },
+  "bugs": "https://github.com/formatjs/formatjs/issues",
+  "homepage": "https://github.com/formatjs/formatjs#readme",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "formatjs",
+    "i18n"
+  ],
+  "main": "index.js",
+  "repository": "formatjs/formatjs.git"
 }

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

@@ -0,0 +1,9 @@
+import { RuleModule } from '@typescript-eslint/utils/ts-eslint';
+type MessageIds = 'untranslatedProperty';
+type PropertyConfig = {
+    include: string[];
+};
+type Options = [PropertyConfig?];
+export declare const name = "no-literal-string-in-object";
+export declare const rule: RuleModule<MessageIds, Options>;
+export {};

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

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rule = exports.name = void 0;
+const utils_1 = require("@typescript-eslint/utils");
+const context_compat_1 = require("../context-compat");
+exports.name = 'no-literal-string-in-object';
+exports.rule = {
+    meta: {
+        type: 'problem',
+        docs: {
+            description: 'Enforce translation of specific object properties',
+            url: 'https://formatjs.github.io/docs/tooling/linter#no-literal-string-in-object',
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    include: {
+                        type: 'array',
+                        items: { type: 'string' },
+                        default: ['label'],
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+        messages: {
+            untranslatedProperty: 'Object property: `{{propertyKey}}` might contain an untranslated literal string',
+        },
+    },
+    defaultOptions: [],
+    create(context) {
+        const propertyVisitor = (node) => {
+            checkProperty(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({
+                Property: propertyVisitor,
+            }, {
+                Property: propertyVisitor,
+            });
+        }
+        return {
+            Property: propertyVisitor,
+        };
+    },
+};
+function checkProperty(context, node) {
+    const config = {
+        include: ['label'],
+        ...(context.options[0] || {}),
+    };
+    const propertyKey = node.key.type === utils_1.TSESTree.AST_NODE_TYPES.Identifier
+        ? node.key.name
+        : node.key.type === utils_1.TSESTree.AST_NODE_TYPES.Literal &&
+            typeof node.key.value === 'string'
+            ? node.key.value
+            : null;
+    if (!propertyKey || !config.include.includes(propertyKey)) {
+        return;
+    }
+    checkPropertyValue(context, node.value, propertyKey);
+}
+function checkPropertyValue(context, node, propertyKey) {
+    if ((node.type === 'Literal' &&
+        typeof node.value === 'string' &&
+        node.value.length > 0) ||
+        (node.type === 'TemplateLiteral' &&
+            (node.quasis.length > 1 || node.quasis[0].value.raw.length > 0))) {
+        context.report({
+            node: node,
+            messageId: 'untranslatedProperty',
+            data: {
+                propertyKey: propertyKey,
+            },
+        });
+    }
+    else if (node.type === 'BinaryExpression' && node.operator === '+') {
+        checkPropertyValue(context, node.left, propertyKey);
+        checkPropertyValue(context, node.right, propertyKey);
+    }
+    else if (node.type === 'ConditionalExpression') {
+        checkPropertyValue(context, node.consequent, propertyKey);
+        checkPropertyValue(context, node.alternate, propertyKey);
+    }
+    else if (node.type === 'LogicalExpression') {
+        checkPropertyValue(context, node.left, propertyKey);
+        checkPropertyValue(context, node.right, propertyKey);
+    }
+}