@lingual/i18n-check 0.3.1 → 0.5.0

package/README.md

@@ -63,7 +63,7 @@ node_modules/.bin/i18n-check
 
 ## General Usage
 
-For i18n-check to work you need to provide it at a minimum the source locale (`--source, -s`) for the primary language and the path to the locale translation files (`--locales, -l`).
+For i18n-check to work you need to provide it at a minimum the source locale (`--source, -s`) for the primary language and the path to the locale translation files (`--locales, -l`). Currently supported file formats are JSON and YAML.
 
 Example:
 
@@ -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 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) for more details.
 
 ```bash
 yarn i18n:check --locales translations/i18NextMessageExamples -s en-US -f i18next
@@ -138,14 +138,20 @@ yarn i18n:check --locales translations/messageExamples -s en-US -c missingKeys,i
 
 ### --unused, -u
 
-This feature is currently only supported for react-intl and is useful if you need to know which keys exist in your translation files but not in your codebase. Via the `-u` or `--unused` option you provide a source path to the code, which will be parsed to find all unused keys in the primary target language.
+This feature is currently only supported for `react-intl` and `i18next` based React applications and is useful when you need to know which keys exist in your translation files but not in your codebase. Via the `-u` or `--unused` option you provide a source path to the code, which will be parsed to find all unused keys in the primary target language.
 
-It is important to note that you must also provide the `-f` or `--format` option with `react-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` or `i18next` as value. See the [`format` section](#--format) for more information.
 
 ```bash
 yarn i18n:check --locales translations/messageExamples -s en-US -u client/ -f react-intl
 ```
 
+or
+
+```bash
+yarn i18n:check --locales translations/messageExamples -s en-US -u client/ -f i18next
+```
+
 ### --reporter, -r
 
 The standard reporting prints out all the missing or invalid keys.
@@ -208,7 +214,7 @@ yarn i18n:check --locales locales -s locales/en-us.json
 
 ### Folder per locale
 
-If the locales are **organised as folders** containing a single json file:
+If the locales are **organised as folders** containing a single JSON/YAML file:
 
 ```
 locales/
@@ -226,7 +232,7 @@ yarn i18n:check --locales locales -s en-US
 
 ### Folder per locale with multiple files
 
-If the locales are **organised as folders** containing multiple json files:
+If the locales are **organised as folders** containing multiple JSON/YAML files:
 
 ```
 locales/
@@ -248,7 +254,7 @@ yarn i18n:check --locales locales -s en-US
 
 #### Multiple folders containing locales
 
-If the locales are **organised as folders** containing multiple json files:
+If the locales are **organised as folders** containing multiple JSON/YAML files:
 
 ```
 - spaceOne

package/dist/bin/index.js

@@ -13,11 +13,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const glob_1 = require("glob");
 const chalk_1 = __importDefault(require("chalk"));
+const commander_1 = require("commander");
 const fs_1 = __importDefault(require("fs"));
+const glob_1 = require("glob");
+const js_yaml_1 = __importDefault(require("js-yaml"));
 const process_1 = require("process");
-const commander_1 = require("commander");
 const __1 = require("..");
 const errorReporters_1 = require("../errorReporters");
 const flattenTranslations_1 = require("../utils/flattenTranslations");
@@ -25,7 +26,7 @@ commander_1.program
     .version("0.3.0")
     .option("-l, --locales <locales...>", "name of the directory containing the locales to validate")
     .option("-s, --source [source locale]", "the source locale to validate against")
-    .option("-f, --format [format type]", "define the specific format, i.e. i18next")
+    .option("-f, --format [format type]", "define the specific format: i18next or react-intl")
     .option("-c, --check [checks]", "define the specific checks you want to run: invalid, missing. By default the check will validate against missing and invalid keys, i.e. --check invalidKeys,missingKeys")
     .option("-r, --reporter [error reporting style]", "define the reporting style: standard or summary")
     .option("-e, --exclude <exclude...>", "define the file(s) and/or folders(s) that should be excluded from the check")
@@ -65,8 +66,8 @@ const main = () => __awaiter(void 0, void 0, void 0, function* () {
     let srcFiles = [];
     let localeFiles = [];
     const pattern = isMultiFolders
-        ? `{${localePath.join(",").trim()}}/**/*.json`
-        : `${localePath.join(",").trim()}/**/*.json`;
+        ? `{${localePath.join(",").trim()}}/**/*.{json,yaml,yml}`
+        : `${localePath.join(",").trim()}/**/*.{json,yaml,yml}`;
     const files = yield (0, glob_1.glob)(pattern, {
         ignore: ["node_modules/**"].concat(excludedPaths),
     });
@@ -81,17 +82,25 @@ const main = () => __awaiter(void 0, void 0, void 0, function* () {
     };
     const fileInfos = [];
     files.sort().forEach((file) => {
-        var _a;
+        var _a, _b;
         const path = file.split("/");
         const name = (_a = path.pop()) !== null && _a !== void 0 ? _a : "";
+        const extension = (_b = name.split(".").pop()) !== null && _b !== void 0 ? _b : "json";
         fileInfos.push({
+            extension,
             file,
-            path,
             name,
+            path,
         });
     });
-    fileInfos.forEach(({ file, name, path }) => {
-        const rawContent = JSON.parse(fs_1.default.readFileSync(file, "utf-8"));
+    fileInfos.forEach(({ extension, file, name, path }) => {
+        let rawContent;
+        if (extension === "yaml") {
+            rawContent = js_yaml_1.default.load(fs_1.default.readFileSync(file, "utf-8"));
+        }
+        else {
+            rawContent = JSON.parse(fs_1.default.readFileSync(file, "utf-8"));
+        }
         const content = (0, flattenTranslations_1.flattenTranslations)(rawContent);
         if (isSource({ file, name, path }, srcPath)) {
             srcFiles.push({

package/dist/bin/index.test.js

@@ -2,10 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const child_process_1 = require("child_process");
 describe("CLI", () => {
-    it("should return the missing keys for single folder translations", (done) => {
-        (0, child_process_1.exec)("node dist/bin/index.js -s en-US -l translations/flattenExamples", (_error, stdout, _stderr) => {
-            const result = stdout.split("Done")[0];
-            expect(result).toEqual(`i18n translations checker
+    describe("JSON", () => {
+        it("should return the missing keys for single folder translations", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js -s en-US -l translations/flattenExamples", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
 Source: en-US
 
 Found missing keys!
@@ -19,13 +20,13 @@ Found missing keys!
 No invalid translations found!
 
 `);
-            done();
+                done();
+            });
         });
-    });
-    it("should return the missing/invalid keys for folder per locale with single file", (done) => {
-        (0, child_process_1.exec)("node dist/bin/index.js -l translations/folderExample/ -s en-US", (_error, stdout, _stderr) => {
-            const result = stdout.split("Done")[0];
-            expect(result).toEqual(`i18n translations checker
+        it("should return the missing/invalid keys for folder per locale with single file", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js -l translations/folderExample/ -s en-US", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
 Source: en-US
 
 Found missing keys!
@@ -43,13 +44,13 @@ Found invalid keys!
 └───────────────────────────────────────────────┴──────────────────┘
 
 `);
-            done();
+                done();
+            });
         });
-    });
-    it("should return the missing/invalid keys for folder per locale with multiple files", (done) => {
-        (0, child_process_1.exec)("node dist/bin/index.js -l translations/multipleFilesFolderExample/ -s en-US", (_error, stdout, _stderr) => {
-            const result = stdout.split("Done")[0];
-            expect(result).toEqual(`i18n translations checker
+        it("should return the missing/invalid keys for folder per locale with multiple files", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js -l translations/multipleFilesFolderExample/ -s en-US", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
 Source: en-US
 
 Found missing keys!
@@ -69,13 +70,13 @@ Found invalid keys!
 └────────────────────────────────────────────────────────────┴─────────────────────┘
 
 `);
-            done();
+                done();
+            });
         });
-    });
-    it("should return the missing/invalid keys for folder containing multiple locale folders", (done) => {
-        (0, child_process_1.exec)("node dist/bin/index.js -l translations/multipleFoldersExample -s en-US", (_error, stdout, _stderr) => {
-            const result = stdout.split("Done")[0];
-            expect(result).toEqual(`i18n translations checker
+        it("should return the missing/invalid keys for folder containing multiple locale folders", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js -l translations/multipleFoldersExample -s en-US", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
 Source: en-US
 
 Found missing keys!
@@ -99,13 +100,13 @@ Found invalid keys!
 └─────────────────────────────────────────────────────────────────────────┴───────────────────────┘
 
 `);
-            done();
+                done();
+            });
         });
-    });
-    it("should return the missing/invalid keys for multiple locale folders", (done) => {
-        (0, child_process_1.exec)("node dist/bin/index.js -l translations/multipleFoldersExample/spaceOne translations/multipleFoldersExample/spaceTwo -s en-US", (_error, stdout, _stderr) => {
-            const result = stdout.split("Done")[0];
-            expect(result).toEqual(`i18n translations checker
+        it("should return the missing/invalid keys for multiple locale folders", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js -l translations/multipleFoldersExample/spaceOne translations/multipleFoldersExample/spaceTwo -s en-US", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
 Source: en-US
 
 Found missing keys!
@@ -129,13 +130,13 @@ Found invalid keys!
 └─────────────────────────────────────────────────────────────────────────┴───────────────────────┘
 
 `);
-            done();
+                done();
+            });
         });
-    });
-    it("should return the missing/invalid keys for all files in the provided locale folders", (done) => {
-        (0, child_process_1.exec)("node dist/bin/index.js --source en-US --locales translations/flattenExamples translations/messageExamples", (_error, stdout, _stderr) => {
-            const result = stdout.split("Done")[0];
-            expect(result).toEqual(`i18n translations checker
+        it("should return the missing/invalid keys for all files in the provided locale folders", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js --source en-US --locales translations/flattenExamples translations/messageExamples", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
 Source: en-US
 
 Found missing keys!
@@ -160,13 +161,13 @@ Found invalid keys!
 └───────────────────────────────────────────┴─────────────────────┘
 
 `);
-            done();
+                done();
+            });
         });
-    });
-    it("should return the missing/invalid keys for all files with source matching folder and source matching file", (done) => {
-        (0, child_process_1.exec)("node dist/bin/index.js -l translations/multipleFilesFolderExample translations/flattenExamples -s en-US", (_error, stdout, _stderr) => {
-            const result = stdout.split("Done")[0];
-            expect(result).toEqual(`i18n translations checker
+        it("should return the missing/invalid keys for all files with source matching folder and source matching file", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js -l translations/multipleFilesFolderExample translations/flattenExamples -s en-US", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
 Source: en-US
 
 Found missing keys!
@@ -188,13 +189,13 @@ Found invalid keys!
 └────────────────────────────────────────────────────────────┴─────────────────────┘
 
 `);
-            done();
+                done();
+            });
         });
-    });
-    it("should ignore the excluded file", (done) => {
-        (0, child_process_1.exec)("node dist/bin/index.js --source en-US --locales translations/flattenExamples translations/messageExamples --exclude translations/flattenExamples/de-de.json", (_error, stdout, _stderr) => {
-            const result = stdout.split("Done")[0];
-            expect(result).toEqual(`i18n translations checker
+        it("should ignore the excluded file", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js --source en-US --locales translations/flattenExamples translations/messageExamples --exclude translations/flattenExamples/de-de.json", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
 Source: en-US
 
 Found missing keys!
@@ -217,13 +218,13 @@ Found invalid keys!
 └───────────────────────────────────────────┴─────────────────────┘
 
 `);
-            done();
+                done();
+            });
         });
-    });
-    it("should ignore the excluded folder", (done) => {
-        (0, child_process_1.exec)("node dist/bin/index.js --source en-US --locales translations/flattenExamples translations/messageExamples --exclude translations/flattenExamples/*", (_error, stdout, _stderr) => {
-            const result = stdout.split("Done")[0];
-            expect(result).toEqual(`i18n translations checker
+        it("should ignore the excluded folder", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js --source en-US --locales translations/flattenExamples translations/messageExamples --exclude translations/flattenExamples/*", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
 Source: en-US
 
 Found missing keys!
@@ -246,13 +247,13 @@ Found invalid keys!
 └───────────────────────────────────────────┴─────────────────────┘
 
 `);
-            done();
+                done();
+            });
         });
-    });
-    it("should ignore the excluded multiple files", (done) => {
-        (0, child_process_1.exec)("node dist/bin/index.js --source en-US --locales translations/flattenExamples translations/messageExamples --exclude translations/flattenExamples/de-de.json translations/messageExamples/de-de.json", (_error, stdout, _stderr) => {
-            const result = stdout.split("Done")[0];
-            expect(result).toEqual(`i18n translations checker
+        it("should ignore the excluded multiple files", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js --source en-US --locales translations/flattenExamples translations/messageExamples --exclude translations/flattenExamples/de-de.json translations/messageExamples/de-de.json", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
 Source: en-US
 
 No missing keys found!
@@ -260,7 +261,222 @@ No missing keys found!
 No invalid translations found!
 
 `);
-            done();
+                done();
+            });
+        });
+        it("should find unused keys for react-i18next applications", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js --source en --locales translations/codeExamples/reacti18next/locales -f i18next -u translations/codeExamples/reacti18next/src", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
+Source: en
+Selected format is: i18next
+
+No missing keys found!
+
+No invalid translations found!
+
+Found unused keys!
+┌──────────────────────────────────────────────────────────────────────┬──────────────────┐
+│ file                                                                 │ key              │
+├──────────────────────────────────────────────────────────────────────┼──────────────────┤
+│  translations/codeExamples/reacti18next/locales/en/translation.json  │  format.ebook    │
+│  translations/codeExamples/reacti18next/locales/en/translation.json  │  nonExistentKey  │
+└──────────────────────────────────────────────────────────────────────┴──────────────────┘
+
+`);
+                done();
+            });
+        });
+    });
+    describe("YAML", () => {
+        it("should return the missing keys for single folder translations", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js -s en-US -l translations/yaml/flattenExamples", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
+Source: en-US
+
+Found missing keys!
+┌────────────────────────────────────────────────┬────────────────────────────────┐
+│ file                                           │ key                            │
+├────────────────────────────────────────────────┼────────────────────────────────┤
+│  translations/yaml/flattenExamples/de-de.yaml  │  other.nested.three            │
+│  translations/yaml/flattenExamples/de-de.yaml  │  other.nested.deep.more.final  │
+└────────────────────────────────────────────────┴────────────────────────────────┘
+
+No invalid translations found!
+
+`);
+                done();
+            });
+        });
+        it("should return the missing/invalid keys for folder per locale with single file", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js -l translations/yaml/folderExample/ -s en-US", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
+Source: en-US
+
+Found missing keys!
+┌────────────────────────────────────────────────────┬───────────────────────┐
+│ file                                               │ key                   │
+├────────────────────────────────────────────────────┼───────────────────────┤
+│  translations/yaml/folderExample/de-DE/index.yaml  │  message.text-format  │
+└────────────────────────────────────────────────────┴───────────────────────┘
+
+Found invalid keys!
+┌────────────────────────────────────────────────────┬──────────────────┐
+│ file                                               │ key              │
+├────────────────────────────────────────────────────┼──────────────────┤
+│  translations/yaml/folderExample/de-DE/index.yaml  │  message.select  │
+└────────────────────────────────────────────────────┴──────────────────┘
+
+`);
+                done();
+            });
+        });
+        it("should return the missing/invalid keys for folder per locale with multiple files", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js -l translations/yaml/multipleFilesFolderExample/ -s en-US", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
+Source: en-US
+
+Found missing keys!
+┌───────────────────────────────────────────────────────────────┬───────────────────────┐
+│ file                                                          │ key                   │
+├───────────────────────────────────────────────────────────────┼───────────────────────┤
+│  translations/yaml/multipleFilesFolderExample/de-DE/one.yaml  │  message.text-format  │
+│  translations/yaml/multipleFilesFolderExample/de-DE/two.yaml  │  test.drive.four      │
+└───────────────────────────────────────────────────────────────┴───────────────────────┘
+
+Found invalid keys!
+┌─────────────────────────────────────────────────────────────────┬─────────────────────┐
+│ file                                                            │ key                 │
+├─────────────────────────────────────────────────────────────────┼─────────────────────┤
+│  translations/yaml/multipleFilesFolderExample/de-DE/one.yaml    │  message.select     │
+│  translations/yaml/multipleFilesFolderExample/de-DE/three.yaml  │  multipleVariables  │
+└─────────────────────────────────────────────────────────────────┴─────────────────────┘
+
+`);
+                done();
+            });
+        });
+        it("should return the missing/invalid keys for folder containing multiple locale folders", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js -l translations/yaml/multipleFoldersExample -s en-US", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
+Source: en-US
+
+Found missing keys!
+┌────────────────────────────────────────────────────────────────────────────┬───────────────────────┐
+│ file                                                                       │ key                   │
+├────────────────────────────────────────────────────────────────────────────┼───────────────────────┤
+│  translations/yaml/multipleFoldersExample/spaceOne/locales/de-DE/one.yaml  │  message.text-format  │
+│  translations/yaml/multipleFoldersExample/spaceOne/locales/de-DE/two.yaml  │  test.drive.four      │
+│  translations/yaml/multipleFoldersExample/spaceTwo/locales/de-DE/one.yaml  │  message.plural       │
+│  translations/yaml/multipleFoldersExample/spaceTwo/locales/de-DE/two.yaml  │  test.drive.two       │
+└────────────────────────────────────────────────────────────────────────────┴───────────────────────┘
+
+Found invalid keys!
+┌──────────────────────────────────────────────────────────────────────────────┬───────────────────────┐
+│ file                                                                         │ key                   │
+├──────────────────────────────────────────────────────────────────────────────┼───────────────────────┤
+│  translations/yaml/multipleFoldersExample/spaceOne/locales/de-DE/one.yaml    │  message.select       │
+│  translations/yaml/multipleFoldersExample/spaceOne/locales/de-DE/three.yaml  │  multipleVariables    │
+│  translations/yaml/multipleFoldersExample/spaceTwo/locales/de-DE/one.yaml    │  message.text-format  │
+│  translations/yaml/multipleFoldersExample/spaceTwo/locales/de-DE/three.yaml  │  numberFormat         │
+└──────────────────────────────────────────────────────────────────────────────┴───────────────────────┘
+
+`);
+                done();
+            });
+        });
+        it("should return the missing/invalid keys for multiple locale folders", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js -l translations/yaml/multipleFoldersExample/spaceOne translations/yaml/multipleFoldersExample/spaceTwo -s en-US", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
+Source: en-US
+
+Found missing keys!
+┌────────────────────────────────────────────────────────────────────────────┬───────────────────────┐
+│ file                                                                       │ key                   │
+├────────────────────────────────────────────────────────────────────────────┼───────────────────────┤
+│  translations/yaml/multipleFoldersExample/spaceOne/locales/de-DE/one.yaml  │  message.text-format  │
+│  translations/yaml/multipleFoldersExample/spaceOne/locales/de-DE/two.yaml  │  test.drive.four      │
+│  translations/yaml/multipleFoldersExample/spaceTwo/locales/de-DE/one.yaml  │  message.plural       │
+│  translations/yaml/multipleFoldersExample/spaceTwo/locales/de-DE/two.yaml  │  test.drive.two       │
+└────────────────────────────────────────────────────────────────────────────┴───────────────────────┘
+
+Found invalid keys!
+┌──────────────────────────────────────────────────────────────────────────────┬───────────────────────┐
+│ file                                                                         │ key                   │
+├──────────────────────────────────────────────────────────────────────────────┼───────────────────────┤
+│  translations/yaml/multipleFoldersExample/spaceOne/locales/de-DE/one.yaml    │  message.select       │
+│  translations/yaml/multipleFoldersExample/spaceOne/locales/de-DE/three.yaml  │  multipleVariables    │
+│  translations/yaml/multipleFoldersExample/spaceTwo/locales/de-DE/one.yaml    │  message.text-format  │
+│  translations/yaml/multipleFoldersExample/spaceTwo/locales/de-DE/three.yaml  │  numberFormat         │
+└──────────────────────────────────────────────────────────────────────────────┴───────────────────────┘
+
+`);
+                done();
+            });
+        });
+        it("should return the missing/invalid keys for all files in the provided locale folders", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js --source en-US --locales translations/yaml/flattenExamples translations/yaml/messageExamples", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
+Source: en-US
+
+Found missing keys!
+┌────────────────────────────────────────────────┬────────────────────────────────┐
+│ file                                           │ key                            │
+├────────────────────────────────────────────────┼────────────────────────────────┤
+│  translations/yaml/flattenExamples/de-de.yaml  │  other.nested.three            │
+│  translations/yaml/flattenExamples/de-de.yaml  │  other.nested.deep.more.final  │
+│  translations/yaml/messageExamples/de-de.yaml  │  richText                      │
+│  translations/yaml/messageExamples/de-de.yaml  │  yo                            │
+│  translations/yaml/messageExamples/de-de.yaml  │  nesting1                      │
+│  translations/yaml/messageExamples/de-de.yaml  │  nesting2                      │
+│  translations/yaml/messageExamples/de-de.yaml  │  nesting3                      │
+│  translations/yaml/messageExamples/de-de.yaml  │  key1                          │
+└────────────────────────────────────────────────┴────────────────────────────────┘
+
+Found invalid keys!
+┌────────────────────────────────────────────────┬─────────────────────┐
+│ file                                           │ key                 │
+├────────────────────────────────────────────────┼─────────────────────┤
+│  translations/yaml/messageExamples/de-de.yaml  │  multipleVariables  │
+└────────────────────────────────────────────────┴─────────────────────┘
+
+`);
+                done();
+            });
+        });
+        it("should return the missing/invalid keys for all files with source matching folder and source matching file", (done) => {
+            (0, child_process_1.exec)("node dist/bin/index.js -l translations/yaml/multipleFilesFolderExample translations/yaml/flattenExamples -s en-US", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
+Source: en-US
+
+Found missing keys!
+┌───────────────────────────────────────────────────────────────┬────────────────────────────────┐
+│ file                                                          │ key                            │
+├───────────────────────────────────────────────────────────────┼────────────────────────────────┤
+│  translations/yaml/flattenExamples/de-de.yaml                 │  other.nested.three            │
+│  translations/yaml/flattenExamples/de-de.yaml                 │  other.nested.deep.more.final  │
+│  translations/yaml/multipleFilesFolderExample/de-DE/one.yaml  │  message.text-format           │
+│  translations/yaml/multipleFilesFolderExample/de-DE/two.yaml  │  test.drive.four               │
+└───────────────────────────────────────────────────────────────┴────────────────────────────────┘
+
+Found invalid keys!
+┌─────────────────────────────────────────────────────────────────┬─────────────────────┐
+│ file                                                            │ key                 │
+├─────────────────────────────────────────────────────────────────┼─────────────────────┤
+│  translations/yaml/multipleFilesFolderExample/de-DE/one.yaml    │  message.select     │
+│  translations/yaml/multipleFilesFolderExample/de-DE/three.yaml  │  multipleVariables  │
+└─────────────────────────────────────────────────────────────────┴─────────────────────┘
+
+`);
+                done();
+            });
         });
     });
 });

package/dist/index.js

@@ -8,6 +8,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.checkUnusedKeys = exports.checkTranslations = exports.checkMissingTranslations = exports.checkInvalidTranslations = void 0;
 const findMissingKeys_1 = require("./utils/findMissingKeys");
@@ -15,6 +18,8 @@ const findInvalidTranslations_1 = require("./utils/findInvalidTranslations");
 const findInvalidi18nTranslations_1 = require("./utils/findInvalidi18nTranslations");
 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)
@@ -58,7 +63,7 @@ const checkUnusedKeys = (source_1, codebaseSrc_1, ...args_1) => __awaiter(void 0
     }
     return options.format === "react-intl"
         ? findUnusedReactIntlTranslations(source, codebaseSrc)
-        : undefined;
+        : findUnusedi18NextTranslations(source, codebaseSrc);
 });
 exports.checkUnusedKeys = checkUnusedKeys;
 const findUnusedReactIntlTranslations = (source, codebaseSrc) => __awaiter(void 0, void 0, void 0, function* () {
@@ -81,3 +86,55 @@ const findUnusedReactIntlTranslations = (source, codebaseSrc) => __awaiter(void
     });
     return unusedKeys;
 });
+const findUnusedi18NextTranslations = (source, codebaseSrc) => __awaiter(void 0, void 0, void 0, function* () {
+    let unusedKeys = {};
+    // find any unused keys in a react-i18next code base
+    const unusedKeysFiles = (0, glob_1.globSync)(`${codebaseSrc}/**/*.tsx`, {
+        ignore: ["node_modules/**"],
+    });
+    let extractedResult = [];
+    // @ts-ignore
+    const { transform } = yield import("i18next-parser");
+    unusedKeysFiles.forEach((file) => {
+        const rawContent = fs_1.default.readFileSync(file);
+        const i18nextParser = new transform();
+        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 extractedResultSet = new Set(extractedResult);
+    source.forEach(({ name, content }) => {
+        const keysInSource = Object.keys(content);
+        const found = [];
+        for (const keyInSource of keysInSource) {
+            if (!extractedResultSet.has(keyInSource)) {
+                found.push(keyInSource);
+            }
+        }
+        Object.assign(unusedKeys, { [name]: found });
+    });
+    return unusedKeys;
+});
+const isRecord = (data) => {
+    return (typeof data === "object" &&
+        !Array.isArray(data) &&
+        data !== null &&
+        data !== undefined);
+};
+function flatten(object, prefix = null, result = {}) {
+    for (let key in object) {
+        let propName = prefix ? `${prefix}.${key}` : key;
+        const data = object[key];
+        if (isRecord(data)) {
+            flatten(data, propName, result);
+        }
+        else {
+            result[propName] = data;
+        }
+    }
+    return result;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingual/i18n-check",
-  "version": "0.3.1",
+  "version": "0.5.0",
   "description": "i18n translation messages check",
   "license": "MIT",
   "main": "dist/index.js",
@@ -19,18 +19,23 @@
   ],
   "dependencies": {
     "@formatjs/cli-lib": "^6.4.2",
-    "@formatjs/icu-messageformat-parser": "^2.7.8",
+    "@formatjs/icu-messageformat-parser": "^2.9.7",
     "chalk": "^4.1.2",
     "commander": "^12.1.0",
     "glob": "^11.0.0",
-    "typescript": "^5.6.2"
+    "i18next-parser": "^9.0.2",
+    "js-yaml": "^4.1.0",
+    "vinyl": "^3.0.0"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.13",
-    "@types/node": "^22.5.5",
+    "@types/jest": "^29.5.14",
+    "@types/js-yaml": "^4.0.9",
+    "@types/node": "^22.10.1",
+    "@types/vinyl": "^2.0.12",
     "braces": "^3.0.3",
     "jest": "^29.7.0",
-    "ts-jest": "^29.2.5"
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.7.3"
   },
   "repository": {
     "type": "git",