@lingual/i18n-check 0.5.1 → 0.5.3

package/dist/bin/index.js

@@ -214,7 +214,7 @@ const printTranslationResult = ({ missingKeys, invalidKeys, }) => {
 const printUnusedKeysResult = ({ unusedKeys, }) => {
     const reporter = commander_1.program.getOptionValue("reporter");
     const isSummary = reporter === "summary";
-    if (unusedKeys && Object.keys(unusedKeys).length > 0) {
+    if (unusedKeys && hasUnusedKeys(unusedKeys)) {
         console.log(chalk_1.default.red("\nFound unused keys!"));
         if (isSummary) {
             console.log(chalk_1.default.red((0, errorReporters_1.summaryReporter)(getSummaryRows(unusedKeys))));
@@ -224,7 +224,7 @@ const printUnusedKeysResult = ({ unusedKeys, }) => {
         }
     }
     else if (unusedKeys) {
-        console.log(chalk_1.default.green("\nNo unused found!"));
+        console.log(chalk_1.default.green("\nNo unused keys found!"));
     }
 };
 const truncate = (chars) => chars.length > 80 ? `${chars.substring(0, 80)}...` : chars;
@@ -250,4 +250,12 @@ const getStandardRows = (checkResult) => {
     }
     return formattedRows;
 };
+const hasUnusedKeys = (checkResult) => {
+    for (const [_, keys] of Object.entries(checkResult)) {
+        if (keys.length > 0) {
+            return true;
+        }
+    }
+    return false;
+};
 main();

package/dist/index.js

@@ -19,7 +19,6 @@ const findInvalidi18nTranslations_1 = require("./utils/findInvalidi18nTranslatio
 const glob_1 = require("glob");
 const cli_lib_1 = require("@formatjs/cli-lib");
 const fs_1 = __importDefault(require("fs"));
-const vinyl_1 = __importDefault(require("vinyl"));
 const checkInvalidTranslations = (source, targets, options = { format: "icu" }) => {
     return options.format === "i18next"
         ? (0, findInvalidi18nTranslations_1.findInvalid18nTranslations)(source, targets)
@@ -95,37 +94,53 @@ const findUnusedI18NextTranslations = (source_1, codebaseSrc_1, ...args_1) => __
     let extractedResult = [];
     // @ts-ignore
     const { transform } = yield import("i18next-parser");
+    const i18nextParser = new transform({
+        lexers: {
+            jsx: [
+                {
+                    lexer: "JsxLexer",
+                    componentFunctions: componentFunctions.concat(["Trans"]),
+                },
+            ],
+            tsx: [
+                {
+                    lexer: "JsxLexer",
+                    componentFunctions: componentFunctions.concat(["Trans"]),
+                },
+            ],
+        },
+    });
+    // Skip any parsed keys that have the `returnObjects` property set to true
+    // As these are used dynamically, they will be skipped to prevent
+    // these keys from being marked as unused.
+    const skippableKeys = [];
     unusedKeysFiles.forEach((file) => {
-        const rawContent = fs_1.default.readFileSync(file);
-        const i18nextParser = new transform({
-            lexers: {
-                jsx: [
-                    {
-                        lexer: "JsxLexer",
-                        componentFunctions: componentFunctions.concat(["Trans"]),
-                    },
-                ],
-                tsx: [
-                    {
-                        lexer: "JsxLexer",
-                        componentFunctions: componentFunctions.concat(["Trans"]),
-                    },
-                ],
-            },
-        });
-        i18nextParser.once("data", (file) => {
-            extractedResult = extractedResult.concat(Object.keys(flatten(JSON.parse(file.contents))));
-        });
-        i18nextParser.end(new vinyl_1.default({
-            contents: rawContent,
-            path: file,
-        }));
+        const rawContent = fs_1.default.readFileSync(file, "utf-8");
+        const entries = i18nextParser.parser.parse(rawContent, file);
+        // Intermediate solution to retrieve all keys from the parser.
+        // This will be built out to also include the namespace and check
+        // the key against the namespace corresponding file.
+        // The current implementation considers the key as used no matter the namespace.
+        for (const entry of entries) {
+            if (entry.returnObjects) {
+                skippableKeys.push(entry.key);
+            }
+            else {
+                extractedResult.push(entry.key);
+            }
+        }
     });
     const extractedResultSet = new Set(extractedResult);
     source.forEach(({ name, content }) => {
         const keysInSource = Object.keys(content);
         const found = [];
         for (const keyInSource of keysInSource) {
+            const isSkippable = skippableKeys.find((skippableKey) => {
+                return keyInSource.includes(skippableKey);
+            });
+            if (isSkippable !== undefined) {
+                continue;
+            }
             if (!extractedResultSet.has(keyInSource)) {
                 found.push(keyInSource);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingual/i18n-check",
-  "version": "0.5.1",
+  "version": "0.5.3",
   "description": "i18n translation messages check",
   "license": "MIT",
   "main": "dist/index.js",
@@ -18,19 +18,18 @@
     "dist/"
   ],
   "dependencies": {
-    "@formatjs/cli-lib": "^6.4.2",
-    "@formatjs/icu-messageformat-parser": "^2.9.7",
+    "@formatjs/cli-lib": "^6.6.6",
+    "@formatjs/icu-messageformat-parser": "^2.11.0",
     "chalk": "^4.1.2",
     "commander": "^12.1.0",
-    "glob": "^11.0.0",
-    "i18next-parser": "^9.0.2",
-    "js-yaml": "^4.1.0",
-    "vinyl": "^3.0.0"
+    "glob": "^11.0.1",
+    "i18next-parser": "^9.1.0",
+    "js-yaml": "^4.1.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.14",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^22.10.1",
+    "@types/node": "^22.10.10",
     "@types/vinyl": "^2.0.12",
     "braces": "^3.0.3",
     "jest": "^29.7.0",