@lingual/i18n-check 0.8.4 → 0.8.6

package/README.md

@@ -4,9 +4,9 @@
 It compares the defined source language with all target translation files and finds inconsistencies between source and target files.
 You can run these checks as a pre-commit hook or on the CI depending on your use-case and setup.
 
-![example 1](./assets/i18n-check-screenshot-full.png)
+![example 1](./assets/i18n_check_multipleFilesFolderExample_basic_v2.png)
 
-![example 2](./assets/i18n-check-screenshot-summary.png)
+![example 2](./assets/i18n_check_multipleFilesFolderExample_react_intl_unused_v2.png)
 
 ## Table of Contents
 
@@ -106,7 +106,7 @@ Additionally the `i18next` format is supported and can be set via the `-f` or `-
 
 There are i18n libraries that have their own specific format, which might not be based on ICU and therefore can not be validated against currently. On a side-note: there might be future support for more specific formats.
 
-Hint: If you want to use the `--unused` flag, you should provide `react-intl` or `i18-next` as the format. Also see the [`unused` section](#--unused) for more details.
+Hint: If you want to use the `--unused` flag, you should provide `react-intl` or `i18-next` as the format. Also see the [`unused` section](#--unused--u) for more details.
 
 ```bash
 yarn i18n:check --locales translations/i18NextMessageExamples -s en-US -f i18next
@@ -165,7 +165,7 @@ This feature is currently only supported for `react-intl` and `i18next` as well
 
 Via the `-u` or `--unused` option you provide a source path to the code, which will be parsed to find all unused as well as undefined keys in the primary target language.
 
-It is important to note that you must also provide the `-f` or `--format` option with `react-intl`, `i18next` or `next-intl` as value. See the [`format` section](#--format) for more information.
+It is important to note that you must also provide the `-f` or `--format` option with `react-intl`, `i18next` or `next-intl` as value. See the [`format` section](#--format--f) for more information.
 
 ```bash
 yarn i18n:check --locales translations/messageExamples -s en-US -u client/ -f react-intl

package/dist/bin/index.js

@@ -160,6 +160,7 @@ const main = async () => {
     }
     try {
         const result = (0, __1.checkTranslations)(srcFiles, targetFiles, options);
+        let undefinedKeyResult = undefined;
         printTranslationResult(result);
         if (unusedSrcPath) {
             const isMultiUnusedFolders = unusedSrcPath.length > 1;
@@ -176,11 +177,13 @@ const main = async () => {
             printUndefinedKeysResult({
                 undefinedKeys,
             });
+            undefinedKeyResult = undefinedKeys;
         }
         const end = performance.now();
         console.log(chalk_1.default.green(`\nDone in ${Math.round(((end - start) * 100) / 1000) / 100}s.`));
         if ((result.missingKeys && Object.keys(result.missingKeys).length > 0) ||
-            (result.invalidKeys && Object.keys(result.invalidKeys).length > 0)) {
+            (result.invalidKeys && Object.keys(result.invalidKeys).length > 0) ||
+            (undefinedKeyResult && Object.keys(undefinedKeyResult).length > 0)) {
             (0, node_process_1.exit)(1);
         }
         else {

package/dist/index.js

@@ -32,12 +32,12 @@ const checkTranslations = (source, targets, options = { format: 'icu', checks: [
         const files = Object.fromEntries(targets
             .filter(({ reference }) => reference === name)
             .map(({ name, content }) => [name, content]));
+        const filteredContent = filterKeys(content, options.ignore ?? []);
         if (hasMissingKeysCheck) {
-            const filteredContent = filterKeys(content, options.ignore ?? []);
             merge(missingKeys, (0, exports.checkMissingTranslations)(filteredContent, files));
         }
         if (hasInvalidKeysCheck) {
-            merge(invalidKeys, (0, exports.checkInvalidTranslations)(content, files, options));
+            merge(invalidKeys, (0, exports.checkInvalidTranslations)(filteredContent, files, options));
         }
     });
     return {

package/dist/utils/nextIntlSrcParser.js

@@ -140,6 +140,49 @@ const getKeys = (path) => {
                         }
                     }
                 }
+                // Check if getTranslations is called inside a promise.all
+                // Example:
+                // const [data, t] = await Promise.all([
+                //    loadData(id),
+                //    getTranslations('asyncPromiseAll'),
+                // ]);
+                if (ts.isCallExpression(node.initializer.expression) &&
+                    node.initializer.expression.arguments.length > 0 &&
+                    ts.isArrayLiteralExpression(node.initializer.expression.arguments[0])) {
+                    const functionNameIndex = node.initializer.expression.arguments[0].elements.findIndex((argument) => {
+                        return (ts.isCallExpression(argument) &&
+                            ts.isIdentifier(argument.expression) &&
+                            argument.expression.text === GET_TRANSLATIONS);
+                    });
+                    // Try to find the correct function name via the position in the variable declaration
+                    if (functionNameIndex !== -1 &&
+                        ts.isArrayBindingPattern(node.name) &&
+                        ts.isBindingElement(node.name.elements[functionNameIndex]) &&
+                        ts.isIdentifier(node.name.elements[functionNameIndex].name)) {
+                        const variable = node.name.elements[functionNameIndex].name.text;
+                        const [argument] = ts.isCallExpression(node.initializer.expression.arguments[0].elements[functionNameIndex])
+                            ? node.initializer.expression.arguments[0].elements[functionNameIndex].arguments
+                            : [];
+                        if (argument && ts.isObjectLiteralExpression(argument)) {
+                            argument.properties.forEach((property) => {
+                                if (property &&
+                                    ts.isPropertyAssignment(property) &&
+                                    property.name &&
+                                    ts.isIdentifier(property.name) &&
+                                    property.name.text === 'namespace' &&
+                                    ts.isStringLiteral(property.initializer)) {
+                                    pushNamespace({ name: property.initializer.text, variable });
+                                }
+                            });
+                        }
+                        else if (argument && ts.isStringLiteral(argument)) {
+                            pushNamespace({ name: argument.text, variable });
+                        }
+                        else if (argument === undefined) {
+                            pushNamespace({ name: '', variable });
+                        }
+                    }
+                }
             }
         }
         // Search for direct inline calls and extract namespace and key

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingual/i18n-check",
-  "version": "0.8.4",
+  "version": "0.8.6",
   "description": "i18n translation messages check",
   "license": "MIT",
   "main": "dist/index.js",
@@ -10,7 +10,7 @@
   },
   "types": "dist/index.d.ts",
   "scripts": {
-    "build": "tsc",
+    "build": "tsc -p tsconfig.production.json",
     "format": "prettier --write .",
     "lint": "eslint src",
     "lint:fix": "eslint src --fix ",
@@ -19,31 +19,32 @@
     "test:cli": "tsc && jest src/bin/index.test.ts"
   },
   "files": [
-    "dist/"
+    "dist/",
+    "!dist/**/*.test.*"
   ],
   "dependencies": {
     "@formatjs/cli-lib": "^6.6.6",
     "@formatjs/icu-messageformat-parser": "^2.11.2",
     "chalk": "^4.1.2",
     "commander": "^12.1.0",
-    "glob": "^11.0.2",
+    "glob": "11.0.2",
     "i18next-parser": "^9.3.0",
     "js-yaml": "^4.1.0",
     "typescript": "^5.8.3"
   },
   "devDependencies": {
-    "@eslint/js": "^9.26.0",
+    "@eslint/js": "^9.30.1",
     "@types/jest": "^29.5.14",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^22.14.1",
+    "@types/node": "^22.16.0",
     "@types/vinyl": "^2.0.12",
     "braces": "^3.0.3",
-    "eslint": "^9.26.0",
-    "globals": "^16.0.0",
+    "eslint": "^9.30.1",
+    "globals": "^16.3.0",
     "jest": "^29.7.0",
-    "prettier": "^3.5.3",
-    "ts-jest": "^29.3.2",
-    "typescript-eslint": "^8.31.1"
+    "prettier": "^3.6.2",
+    "ts-jest": "^29.4.0",
+    "typescript-eslint": "^8.35.1"
   },
   "repository": {
     "type": "git",

package/dist/bin/index.test.d.ts

@@ -1 +0,0 @@
-export {};