@lingual/i18n-check 0.5.5 → 0.6.0

package/README.md

@@ -138,7 +138,9 @@ yarn i18n:check --locales translations/messageExamples -s en-US -o missingKeys i
 
 ### --unused, -u
 
-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.
+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. Additionally an inverse check is run to find any keys that exist in the codebase but not in the translation files.
+
+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` or `i18next` as value. See the [`format` section](#--format) for more information.
 

package/dist/bin/index.js

@@ -32,7 +32,7 @@ commander_1.program
     .option("-o, --only <only...>", "define the specific checks you want to run: invalid, missing. By default the check will validate against missing and invalid keys, i.e. --only invalidKeys,missingKeys")
     .option("-r, --reporter <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")
-    .option("-u, --unused <path>", "define the source path to find all unused keys")
+    .option("-u, --unused <path>", "define the source path to find all unused and undefined keys")
     .option("--parser-component-functions <components...>", "a list of component names to parse when using the --unused option")
     .parse();
 const getCheckOptions = () => {
@@ -165,8 +165,15 @@ const main = () => __awaiter(void 0, void 0, void 0, function* () {
         const result = (0, __1.checkTranslations)(srcFiles, localeFiles, options);
         printTranslationResult(result);
         if (unusedSrcPath) {
-            const unusedKeys = yield (0, __1.checkUnusedKeys)(srcFiles, unusedSrcPath, options, componentFunctions);
+            const filesToParse = (0, glob_1.globSync)(`${unusedSrcPath}/**/*.{ts,tsx}`, {
+                ignore: ["node_modules/**"],
+            });
+            const unusedKeys = yield (0, __1.checkUnusedKeys)(srcFiles, filesToParse, options, componentFunctions);
             printUnusedKeysResult({ unusedKeys });
+            const undefinedKeys = yield (0, __1.checkUndefinedKeys)(srcFiles, filesToParse, options, componentFunctions);
+            printUndefinedKeysResult({
+                undefinedKeys,
+            });
         }
         const end = performance.now();
         console.log(chalk_1.default.green(`\nDone in ${Math.round(((end - start) * 100) / 1000) / 100}s.`));
@@ -214,7 +221,7 @@ const printTranslationResult = ({ missingKeys, invalidKeys, }) => {
 const printUnusedKeysResult = ({ unusedKeys, }) => {
     const reporter = commander_1.program.getOptionValue("reporter");
     const isSummary = reporter === "summary";
-    if (unusedKeys && hasUnusedKeys(unusedKeys)) {
+    if (unusedKeys && hasKeys(unusedKeys)) {
         console.log(chalk_1.default.red("\nFound unused keys!"));
         if (isSummary) {
             console.log(chalk_1.default.red((0, errorReporters_1.summaryReporter)(getSummaryRows(unusedKeys))));
@@ -227,6 +234,22 @@ const printUnusedKeysResult = ({ unusedKeys, }) => {
         console.log(chalk_1.default.green("\nNo unused keys found!"));
     }
 };
+const printUndefinedKeysResult = ({ undefinedKeys, }) => {
+    const reporter = commander_1.program.getOptionValue("reporter");
+    const isSummary = reporter === "summary";
+    if (undefinedKeys && hasKeys(undefinedKeys)) {
+        console.log(chalk_1.default.red("\nFound undefined keys!"));
+        if (isSummary) {
+            console.log(chalk_1.default.red((0, errorReporters_1.summaryReporter)(getSummaryRows(undefinedKeys))));
+        }
+        else {
+            console.log(chalk_1.default.red((0, errorReporters_1.standardReporter)(getStandardRows(undefinedKeys))));
+        }
+    }
+    else if (undefinedKeys) {
+        console.log(chalk_1.default.green("\nNo undefined keys found!"));
+    }
+};
 const truncate = (chars) => chars.length > 80 ? `${chars.substring(0, 80)}...` : chars;
 const getSummaryRows = (checkResult) => {
     const formattedRows = [];
@@ -250,7 +273,7 @@ const getStandardRows = (checkResult) => {
     }
     return formattedRows;
 };
-const hasUnusedKeys = (checkResult) => {
+const hasKeys = (checkResult) => {
     for (const [_, keys] of Object.entries(checkResult)) {
         if (keys.length > 0) {
             return true;

package/dist/bin/index.test.js

@@ -264,7 +264,7 @@ No invalid translations found!
                 done();
             });
         });
-        it("should find unused keys for react-i18next applications", (done) => {
+        it("should find unused and undefined 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 --parser-component-functions WrappedTransComponent", (_error, stdout, _stderr) => {
                 const result = stdout.split("Done")[0];
                 expect(result).toEqual(`i18n translations checker
@@ -283,6 +283,43 @@ Found unused keys!
 │  translations/codeExamples/reacti18next/locales/en/translation.json  │  nonExistentKey  │
 └──────────────────────────────────────────────────────────────────────┴──────────────────┘
 
+Found undefined keys!
+┌──────────────────────────────────────────────────────┬────────────────────────────────┐
+│ file                                                 │ key                            │
+├──────────────────────────────────────────────────────┼────────────────────────────────┤
+│  translations/codeExamples/reacti18next/src/App.tsx  │  some.key.that.is.not.defined  │
+└──────────────────────────────────────────────────────┴────────────────────────────────┘
+
+`);
+                done();
+            });
+        });
+        it("should find unused and undefined keys for react-intl applications", (done) => {
+            (0, child_process_1.exec)(" node dist/bin/index.js --source en-US --locales translations/codeExamples/react-intl/locales -f react-intl -u translations/codeExamples/react-intl/src", (_error, stdout, _stderr) => {
+                const result = stdout.split("Done")[0];
+                expect(result).toEqual(`i18n translations checker
+Source: en-US
+Selected format is: react-intl
+
+No missing keys found!
+
+No invalid translations found!
+
+Found unused keys!
+┌─────────────────────────────────────────────────────────────────┬─────────────────────────┐
+│ file                                                            │ key                     │
+├─────────────────────────────────────────────────────────────────┼─────────────────────────┤
+│  translations/codeExamples/react-intl/locales/en-US/one.json    │  message.number-format  │
+│  translations/codeExamples/react-intl/locales/en-US/three.json  │  multipleVariables      │
+└─────────────────────────────────────────────────────────────────┴─────────────────────────┘
+
+Found undefined keys!
+┌────────────────────────────────────────────────────┬────────────────────────────────┐
+│ file                                               │ key                            │
+├────────────────────────────────────────────────────┼────────────────────────────────┤
+│  translations/codeExamples/react-intl/src/App.tsx  │  some.key.that.is.not.defined  │
+└────────────────────────────────────────────────────┴────────────────────────────────┘
+
 `);
                 done();
             });

package/dist/index.d.ts

@@ -10,4 +10,5 @@ export declare const checkTranslations: (source: TranslationFile[], targets: Tra
     missingKeys: CheckResult | undefined;
     invalidKeys: CheckResult | undefined;
 };
-export declare const checkUnusedKeys: (source: TranslationFile[], codebaseSrc: string, options?: Options, componentFunctions?: never[]) => Promise<CheckResult | undefined>;
+export declare const checkUnusedKeys: (translationFiles: TranslationFile[], filesToParse: string[], options?: Options, componentFunctions?: never[]) => Promise<CheckResult | undefined>;
+export declare const checkUndefinedKeys: (source: TranslationFile[], filesToParse: string[], options?: Options, componentFunctions?: never[]) => Promise<CheckResult | undefined>;

package/dist/index.js

@@ -12,11 +12,10 @@ 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;
+exports.checkUndefinedKeys = exports.checkUnusedKeys = exports.checkTranslations = exports.checkMissingTranslations = exports.checkInvalidTranslations = void 0;
 const findMissingKeys_1 = require("./utils/findMissingKeys");
 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 checkInvalidTranslations = (source, targets, options = { format: "icu" }) => {
@@ -54,26 +53,22 @@ const checkTranslations = (source, targets, options = { format: "icu", checks: [
     };
 };
 exports.checkTranslations = checkTranslations;
-const checkUnusedKeys = (source_1, codebaseSrc_1, ...args_1) => __awaiter(void 0, [source_1, codebaseSrc_1, ...args_1], void 0, function* (source, codebaseSrc, options = {
+const checkUnusedKeys = (translationFiles_1, filesToParse_1, ...args_1) => __awaiter(void 0, [translationFiles_1, filesToParse_1, ...args_1], void 0, function* (translationFiles, filesToParse, options = {
     format: "react-intl",
 }, componentFunctions = []) {
     if (!options.format || !["react-intl", "i18next"].includes(options.format)) {
         return undefined;
     }
     return options.format === "react-intl"
-        ? findUnusedReactIntlTranslations(source, codebaseSrc)
-        : findUnusedI18NextTranslations(source, codebaseSrc, componentFunctions);
+        ? findUnusedReactIntlTranslations(translationFiles, filesToParse)
+        : findUnusedI18NextTranslations(translationFiles, filesToParse, componentFunctions);
 });
 exports.checkUnusedKeys = checkUnusedKeys;
-const findUnusedReactIntlTranslations = (source, codebaseSrc) => __awaiter(void 0, void 0, void 0, function* () {
+const findUnusedReactIntlTranslations = (translationFiles, keysInCode) => __awaiter(void 0, void 0, void 0, function* () {
     let unusedKeys = {};
-    // find any unused keys in a react-intl code base
-    const unusedKeysFiles = (0, glob_1.globSync)(codebaseSrc, {
-        ignore: ["node_modules/**"],
-    });
-    const extracted = yield (0, cli_lib_1.extract)(unusedKeysFiles, {});
+    const extracted = yield (0, cli_lib_1.extract)(keysInCode, {});
     const extractedResultSet = new Set(Object.keys(JSON.parse(extracted)));
-    source.forEach(({ name, content }) => {
+    translationFiles.forEach(({ name, content }) => {
         const keysInSource = Object.keys(content);
         const found = [];
         for (const keyInSource of keysInSource) {
@@ -85,13 +80,85 @@ const findUnusedReactIntlTranslations = (source, codebaseSrc) => __awaiter(void
     });
     return unusedKeys;
 });
-const findUnusedI18NextTranslations = (source_1, codebaseSrc_1, ...args_1) => __awaiter(void 0, [source_1, codebaseSrc_1, ...args_1], void 0, function* (source, codebaseSrc, componentFunctions = []) {
+const findUnusedI18NextTranslations = (source_1, filesToParse_1, ...args_1) => __awaiter(void 0, [source_1, filesToParse_1, ...args_1], void 0, function* (source, filesToParse, componentFunctions = []) {
     let unusedKeys = {};
-    // find any unused keys in a react-i18next code base
-    const unusedKeysFiles = (0, glob_1.globSync)(`${codebaseSrc}/**/*.{ts,tsx}`, {
-        ignore: ["node_modules/**"],
+    const { extractedResult, skippableKeys } = yield getI18NextKeysInCode(filesToParse, componentFunctions);
+    const extractedResultSet = new Set(extractedResult.map(({ key }) => key));
+    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);
+            }
+        }
+        Object.assign(unusedKeys, { [name]: found });
     });
-    let extractedResult = [];
+    return unusedKeys;
+});
+const checkUndefinedKeys = (source_1, filesToParse_1, ...args_1) => __awaiter(void 0, [source_1, filesToParse_1, ...args_1], void 0, function* (source, filesToParse, options = {
+    format: "react-intl",
+}, componentFunctions = []) {
+    if (!options.format || !["react-intl", "i18next"].includes(options.format)) {
+        return undefined;
+    }
+    return options.format === "react-intl"
+        ? findUndefinedReactIntlKeys(source, filesToParse)
+        : findUndefinedI18NextKeys(source, filesToParse, componentFunctions);
+});
+exports.checkUndefinedKeys = checkUndefinedKeys;
+const findUndefinedReactIntlKeys = (translationFiles, keysInCode) => __awaiter(void 0, void 0, void 0, function* () {
+    const sourceKeys = new Set(translationFiles.flatMap(({ content }) => {
+        return Object.keys(content);
+    }));
+    const extractedResult = yield (0, cli_lib_1.extract)(keysInCode, {
+        extractSourceLocation: true,
+    });
+    let undefinedKeys = {};
+    Object.entries(JSON.parse(extractedResult)).forEach(([key, meta]) => {
+        if (!sourceKeys.has(key)) {
+            // @ts-ignore
+            const file = meta.file;
+            if (!undefinedKeys[file]) {
+                undefinedKeys[file] = [];
+            }
+            undefinedKeys[file].push(key);
+        }
+    });
+    return undefinedKeys;
+});
+const findUndefinedI18NextKeys = (source_1, filesToParse_1, ...args_1) => __awaiter(void 0, [source_1, filesToParse_1, ...args_1], void 0, function* (source, filesToParse, componentFunctions = []) {
+    const { extractedResult, skippableKeys } = yield getI18NextKeysInCode(filesToParse, componentFunctions);
+    const sourceKeys = new Set(source.flatMap(({ content }) => {
+        return Object.keys(content);
+    }));
+    let undefinedKeys = {};
+    extractedResult.forEach(({ file, key }) => {
+        const isSkippable = skippableKeys.find((skippableKey) => {
+            return key.includes(skippableKey);
+        });
+        if (isSkippable === undefined && !sourceKeys.has(key)) {
+            if (!undefinedKeys[file]) {
+                undefinedKeys[file] = [];
+            }
+            undefinedKeys[file].push(key);
+        }
+    });
+    return undefinedKeys;
+});
+const isRecord = (data) => {
+    return (typeof data === "object" &&
+        !Array.isArray(data) &&
+        data !== null &&
+        data !== undefined);
+};
+const getI18NextKeysInCode = (filesToParse_1, ...args_1) => __awaiter(void 0, [filesToParse_1, ...args_1], void 0, function* (filesToParse, componentFunctions = []) {
     // @ts-ignore
     const { transform } = yield import("i18next-parser");
     const i18nextParser = new transform({
@@ -113,8 +180,9 @@ const findUnusedI18NextTranslations = (source_1, codebaseSrc_1, ...args_1) => __
     // 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.
+    let extractedResult = [];
     const skippableKeys = [];
-    unusedKeysFiles.forEach((file) => {
+    filesToParse.forEach((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.
@@ -126,35 +194,12 @@ const findUnusedI18NextTranslations = (source_1, codebaseSrc_1, ...args_1) => __
                 skippableKeys.push(entry.key);
             }
             else {
-                extractedResult.push(entry.key);
+                extractedResult.push({ file, key: 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);
-            }
-        }
-        Object.assign(unusedKeys, { [name]: found });
-    });
-    return unusedKeys;
+    return { extractedResult, skippableKeys };
 });
-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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingual/i18n-check",
-  "version": "0.5.5",
+  "version": "0.6.0",
   "description": "i18n translation messages check",
   "license": "MIT",
   "main": "dist/index.js",