eslint-plugin-formatjs 4.7.2 → 4.8.0

package/package.json

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

package/rules/enforce-placeholders.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enforce-placeholders.d.ts","sourceRoot":"","sources":["enforce-placeholders.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAiH3B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA6ChB,CAAA;AAED,eAAe,IAAI,CAAA"}
+{"version":3,"file":"enforce-placeholders.d.ts","sourceRoot":"","sources":["enforce-placeholders.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAyH3B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA4ChB,CAAA;AAED,eAAe,IAAI,CAAA"}

package/rules/enforce-placeholders.js

@@ -2,52 +2,32 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const util_1 = require("../util");
 const icu_messageformat_parser_1 = require("@formatjs/icu-messageformat-parser");
-class PlaceholderEnforcement extends Error {
-    constructor(message) {
-        super();
-        this.message = message;
-    }
-}
-function keyExistsInExpression(key, values) {
-    if (!values) {
-        return false;
-    }
-    if (values.type !== 'ObjectExpression') {
-        return true; // True bc we cannot evaluate this
-    }
-    if (values.properties.find(prop => prop.type === 'SpreadElement')) {
-        return true; // True bc there's a spread element
-    }
-    return !!values.properties.find(prop => {
-        if (prop.type !== 'Property') {
-            return false;
-        }
-        switch (prop.key.type) {
-            case 'Identifier':
-                return prop.key.name === key;
-            case 'Literal':
-                return prop.key.value === key;
-        }
-        return false;
-    });
-}
-function verifyAst(ast, values, ignoreList) {
-    for (const el of ast) {
-        if ((0, icu_messageformat_parser_1.isLiteralElement)(el) || (0, icu_messageformat_parser_1.isPoundElement)(el)) {
-            continue;
-        }
-        const key = el.value;
-        if (!ignoreList.has(key) && !keyExistsInExpression(key, values)) {
-            throw new PlaceholderEnforcement(`Missing value for placeholder "${el.value}"`);
-        }
-        if ((0, icu_messageformat_parser_1.isPluralElement)(el) || (0, icu_messageformat_parser_1.isSelectElement)(el)) {
-            for (const selector of Object.keys(el.options)) {
-                verifyAst(el.options[selector].value, values, ignoreList);
+function collectPlaceholderNames(ast) {
+    const placeholderNames = new Set();
+    _traverse(ast);
+    return placeholderNames;
+    function _traverse(ast) {
+        for (const element of ast) {
+            switch (element.type) {
+                case icu_messageformat_parser_1.TYPE.literal:
+                case icu_messageformat_parser_1.TYPE.pound:
+                    break;
+                case icu_messageformat_parser_1.TYPE.tag:
+                    placeholderNames.add(element.value);
+                    _traverse(element.children);
+                    break;
+                case icu_messageformat_parser_1.TYPE.plural:
+                case icu_messageformat_parser_1.TYPE.select:
+                    placeholderNames.add(element.value);
+                    for (const { value } of Object.values(element.options)) {
+                        _traverse(value);
+                    }
+                    break;
+                default:
+                    placeholderNames.add(element.value);
+                    break;
             }
         }
-        if ((0, icu_messageformat_parser_1.isTagElement)(el)) {
-            verifyAst(el.children, values, ignoreList);
-        }
     }
 }
 function checkNode(context, node) {
@@ -62,17 +42,49 @@ function checkNode(context, node) {
         if (!defaultMessage || !messageNode) {
             continue;
         }
-        try {
-            verifyAst((0, icu_messageformat_parser_1.parse)(defaultMessage, {
-                ignoreTag: settings.ignoreTag,
-            }), values, ignoreList);
+        if (values && values.type !== 'ObjectExpression') {
+            // cannot evaluate this
+            continue;
+        }
+        if (values?.properties.find(prop => prop.type === 'SpreadElement')) {
+            // cannot evaluate the spread element
+            continue;
+        }
+        const literalElementByLiteralKey = new Map();
+        if (values) {
+            for (const prop of values.properties) {
+                if ((prop.type === 'MethodDefinition' || prop.type === 'Property') &&
+                    !prop.computed &&
+                    prop.key.type !== 'PrivateIdentifier') {
+                    const name = prop.key.type === 'Identifier'
+                        ? prop.key.name
+                        : String(prop.key.value);
+                    literalElementByLiteralKey.set(name, prop);
+                }
+            }
         }
-        catch (e) {
+        const ast = (0, icu_messageformat_parser_1.parse)(defaultMessage, { ignoreTag: settings.ignoreTag });
+        const placeholderNames = collectPlaceholderNames(ast);
+        const missingPlaceholders = [];
+        placeholderNames.forEach(name => {
+            if (!ignoreList.has(name) && !literalElementByLiteralKey.has(name)) {
+                missingPlaceholders.push(name);
+            }
+        });
+        if (missingPlaceholders.length > 0) {
             context.report({
                 node: messageNode,
-                message: e instanceof Error ? e.message : String(e),
+                message: `Missing value(s) for the following placeholder(s): ${missingPlaceholders.join(', ')}.`,
             });
         }
+        literalElementByLiteralKey.forEach((element, key) => {
+            if (!ignoreList.has(key) && !placeholderNames.has(key)) {
+                context.report({
+                    node: element,
+                    message: 'Value not used by the message.',
+                });
+            }
+        });
     }
 }
 const rule = {
@@ -84,7 +96,6 @@ const rule = {
             recommended: true,
             url: 'https://formatjs.io/docs/tooling/linter#enforce-placeholders',
         },
-        fixable: 'code',
         schema: [
             {
                 type: 'object',

package/rules/no-complex-selectors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"no-complex-selectors.d.ts","sourceRoot":"","sources":["no-complex-selectors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAyE3B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAiDhB,CAAA;AAED,eAAe,IAAI,CAAA"}
+{"version":3,"file":"no-complex-selectors.d.ts","sourceRoot":"","sources":["no-complex-selectors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAiF3B,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAiDhB,CAAA;AAED,eAAe,IAAI,CAAA"}

package/rules/no-complex-selectors.js

@@ -41,8 +41,17 @@ function checkNode(context, node) {
             });
             return;
         }
-        const hoistedAst = (0, manipulator_1.hoistSelectors)(ast);
-        const complexity = calculateComplexity(hoistedAst);
+        let complexity = 0;
+        try {
+            const hoistedAst = (0, manipulator_1.hoistSelectors)(ast);
+            complexity = calculateComplexity(hoistedAst);
+        }
+        catch (e) {
+            context.report({
+                node: messageNode,
+                message: e instanceof Error ? e.message : e,
+            });
+        }
         if (complexity > config.limit) {
             context.report({
                 node: messageNode,