@lingual/i18n-check 0.5.0 → 0.5.1

package/README.md

@@ -112,28 +112,28 @@ Hint: If you want to use the `--unused` flag, you should provide `react-intl` or
 yarn i18n:check --locales translations/i18NextMessageExamples -s en-US -f i18next
 ```
 
-### --check, -c
+### --only, -o
 
-By default i18n-check will perform a validation against any **missing** and/or **invalid** keys. There are situations where only a specific check should run. By using the `-c` or `--check` option you can specify a specific check to run.
+By default i18n-check will perform a validation against any **missing** and/or **invalid** keys. There are situations where only a specific check should run. By using the `-o` or `--only` option you can specify a specific check to run.
 
 The available options are `missingKeys`, which will check against any missing keys in the target files and `invalidKeys` will check for invalid keys, where the target translations has a different type then the one defined in the source file.
 
 Check for missing keys:
 
 ```bash
-yarn i18n:check --locales translations/messageExamples -s en-US -c missingKeys
+yarn i18n:check --locales translations/messageExamples -s en-US -o missingKeys
 ```
 
 Check for invalid keys:
 
 ```bash
-yarn i18n:check --locales translations/messageExamples -s en-US -c invalidKeys
+yarn i18n:check --locales translations/messageExamples -s en-US -o invalidKeys
 ```
 
 Check for missing and invalid keys (which is the default):
 
 ```bash
-yarn i18n:check --locales translations/messageExamples -s en-US -c missingKeys,invalidKeys
+yarn i18n:check --locales translations/messageExamples -s en-US -o missingKeys invalidKeys
 ```
 
 ### --unused, -u
@@ -192,6 +192,20 @@ yarn i18n:check --locales translations/folderExamples -s en-US -e translations/f
 The `--exclude` option also accepts a mix of files and folders, which follows the same pattern as above, i.e.
 `-e translations/folderExamples/fr/* translations/messageExamples/it.json`
 
+### --parser-component-functions
+
+When using the `--unused` option, there will be situations where the i18next-parser will not be able to find components that wrap a `Trans` component.The component names for i18next-parser to match should be provided via the `--parser-component-functions` option. This option should onlybe used to define additional names for matching, a by default `Trans` will always be matched.
+
+```bash
+yarn i18n:check --locales translations/i18NextMessageExamples -s en-US -f i18next
+-u src --parser-component-functions WrappedTransComponent
+```
+
+```bash
+yarn i18n:check --locales translations/i18NextMessageExamples -s en-US -f i18next
+-u src --parser-component-functions WrappedTransComponent AnotherWrappedTransComponent
+```
+
 ## Examples
 
 i18n-check is able to load and validate against different locale folder structures. Depending on how the locale files are organized, there are different configuration options.
@@ -206,7 +220,7 @@ locales/
   de-de.json
 ```
 
-Use the `t` or `target` option to define the directory that should be checked for target files. With the `s` or `source` option you can specify the base/reference file to compare the target files against.
+Use the `-l` or `--locales` option to define the directory that should be checked for target files. With the `s` or `source` option you can specify the base/reference file to compare the target files against.
 
 ```bash
 yarn i18n:check --locales locales -s locales/en-us.json

package/dist/bin/index.js

@@ -13,33 +13,37 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_process_1 = require("node:process");
 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 __1 = require("..");
 const errorReporters_1 = require("../errorReporters");
 const flattenTranslations_1 = require("../utils/flattenTranslations");
+const version = require("../../package.json").version;
 commander_1.program
-    .version("0.3.0")
+    .version(version)
     .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: 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("-s, --source <locale>", "the source locale to validate against")
+    .option("-f, --format <type>", "define the specific format: i18next or react-intl")
+    .option("-c, --check <checks...>", "this option is deprecated - use -o or --only instead")
+    .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 [folder]", "define the source path to find all unused keys")
+    .option("-u, --unused <path>", "define the source path to find all unused keys")
+    .option("--parser-component-functions <components...>", "a list of component names to parse when using the --unused option")
     .parse();
 const getCheckOptions = () => {
-    const checkOption = commander_1.program.getOptionValue("check");
+    const checkOption = commander_1.program.getOptionValue("only") || commander_1.program.getOptionValue("check");
+    if (commander_1.program.getOptionValue("check")) {
+        console.log(chalk_1.default.yellow("The --check option has been deprecated, use the --only option instead."));
+    }
     if (!checkOption) {
         return ["invalidKeys", "missingKeys"];
     }
-    const checks = checkOption
-        .split(",")
-        .filter((check) => ["invalidKeys", "missingKeys"].includes(check.trim()));
+    const checks = checkOption.filter((check) => ["invalidKeys", "missingKeys"].includes(check.trim()));
     return checks.length > 0 ? checks : ["invalidKeys", "missingKeys"];
 };
 const isSource = (fileInfo, srcPath) => {
@@ -52,13 +56,14 @@ const main = () => __awaiter(void 0, void 0, void 0, function* () {
     const format = commander_1.program.getOptionValue("format");
     const exclude = commander_1.program.getOptionValue("exclude");
     const unusedSrcPath = commander_1.program.getOptionValue("unused");
+    const componentFunctions = commander_1.program.getOptionValue("parserComponentFunctions");
     if (!srcPath) {
         console.log(chalk_1.default.red("Source not found. Please provide a valid source locale, i.e. -s en-US"));
-        (0, process_1.exit)(1);
+        (0, node_process_1.exit)(1);
     }
     if (!localePath || localePath.length === 0) {
         console.log(chalk_1.default.red("Locale file(s) not found. Please provide valid locale file(s), i.e. -locales translations/"));
-        (0, process_1.exit)(1);
+        (0, node_process_1.exit)(1);
     }
     const excludedPaths = exclude !== null && exclude !== void 0 ? exclude : [];
     const localePathFolders = localePath;
@@ -96,10 +101,10 @@ const main = () => __awaiter(void 0, void 0, void 0, function* () {
     fileInfos.forEach(({ extension, file, name, path }) => {
         let rawContent;
         if (extension === "yaml") {
-            rawContent = js_yaml_1.default.load(fs_1.default.readFileSync(file, "utf-8"));
+            rawContent = js_yaml_1.default.load(node_fs_1.default.readFileSync(file, "utf-8"));
         }
         else {
-            rawContent = JSON.parse(fs_1.default.readFileSync(file, "utf-8"));
+            rawContent = JSON.parse(node_fs_1.default.readFileSync(file, "utf-8"));
         }
         const content = (0, flattenTranslations_1.flattenTranslations)(rawContent);
         if (isSource({ file, name, path }, srcPath)) {
@@ -150,32 +155,32 @@ const main = () => __awaiter(void 0, void 0, void 0, function* () {
     });
     if (srcFiles.length === 0) {
         console.log(chalk_1.default.red("Source not found. Please provide a valid source locale, i.e. -s en-US"));
-        (0, process_1.exit)(1);
+        (0, node_process_1.exit)(1);
     }
     if (localeFiles.length === 0) {
         console.log(chalk_1.default.red("Locale file(s) not found. Please provide valid locale file(s), i.e. --locales translations/"));
-        (0, process_1.exit)(1);
+        (0, node_process_1.exit)(1);
     }
     try {
         const result = (0, __1.checkTranslations)(srcFiles, localeFiles, options);
         printTranslationResult(result);
         if (unusedSrcPath) {
-            const unusedKeys = yield (0, __1.checkUnusedKeys)(srcFiles, unusedSrcPath, options);
+            const unusedKeys = yield (0, __1.checkUnusedKeys)(srcFiles, unusedSrcPath, options, componentFunctions);
             printUnusedKeysResult({ unusedKeys });
         }
         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)) {
-            (0, process_1.exit)(1);
+            (0, node_process_1.exit)(1);
         }
         else {
-            (0, process_1.exit)(0);
+            (0, node_process_1.exit)(0);
         }
     }
     catch (e) {
         console.log(chalk_1.default.red("\nError: Can't validate translations. Check if the format is supported or specify the translation format i.e. -f i18next"));
-        (0, process_1.exit)(1);
+        (0, node_process_1.exit)(1);
     }
 });
 const printTranslationResult = ({ missingKeys, invalidKeys, }) => {

package/dist/bin/index.test.js

@@ -265,7 +265,7 @@ No invalid translations found!
             });
         });
         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) => {
+            (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
 Source: en

package/dist/index.d.ts

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

package/dist/index.js

@@ -57,22 +57,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 = {
     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);
+        : findUnusedI18NextTranslations(source, codebaseSrc, componentFunctions);
 });
 exports.checkUnusedKeys = checkUnusedKeys;
 const findUnusedReactIntlTranslations = (source, codebaseSrc) => __awaiter(void 0, void 0, void 0, function* () {
     let unusedKeys = {};
     // find any unused keys in a react-intl code base
-    const unsuedKeysFiles = (0, glob_1.globSync)(codebaseSrc, {
+    const unusedKeysFiles = (0, glob_1.globSync)(codebaseSrc, {
         ignore: ["node_modules/**"],
     });
-    const extracted = yield (0, cli_lib_1.extract)(unsuedKeysFiles, {});
+    const extracted = yield (0, cli_lib_1.extract)(unusedKeysFiles, {});
     const extractedResultSet = new Set(Object.keys(JSON.parse(extracted)));
     source.forEach(({ name, content }) => {
         const keysInSource = Object.keys(content);
@@ -86,7 +86,7 @@ const findUnusedReactIntlTranslations = (source, codebaseSrc) => __awaiter(void
     });
     return unusedKeys;
 });
-const findUnusedi18NextTranslations = (source, codebaseSrc) => __awaiter(void 0, void 0, void 0, function* () {
+const findUnusedI18NextTranslations = (source_1, codebaseSrc_1, ...args_1) => __awaiter(void 0, [source_1, codebaseSrc_1, ...args_1], void 0, function* (source, codebaseSrc, componentFunctions = []) {
     let unusedKeys = {};
     // find any unused keys in a react-i18next code base
     const unusedKeysFiles = (0, glob_1.globSync)(`${codebaseSrc}/**/*.tsx`, {
@@ -97,7 +97,22 @@ const findUnusedi18NextTranslations = (source, codebaseSrc) => __awaiter(void 0,
     const { transform } = yield import("i18next-parser");
     unusedKeysFiles.forEach((file) => {
         const rawContent = fs_1.default.readFileSync(file);
-        const i18nextParser = new transform();
+        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))));
         });

package/dist/utils/findInvalidi18nTranslations.test.js

@@ -11,6 +11,11 @@ describe("findInvalid18nTranslations:compareTranslationFiles", () => {
     it("should return the invalid keys in the target file", () => {
         expect((0, findInvalidi18nTranslations_1.compareTranslationFiles)((0, flattenTranslations_1.flattenTranslations)(Object.assign(Object.assign({}, sourceFile), { "ten.eleven.twelve": "ten eleven twelve" })), (0, flattenTranslations_1.flattenTranslations)(targetFile))).toEqual(["key_with_broken_de", "intlNumber_broken_de"]);
     });
+    it("should return an empty array if the strings contain paranthesis that have different content", () => {
+        expect((0, findInvalidi18nTranslations_1.compareTranslationFiles)((0, flattenTranslations_1.flattenTranslations)({
+            keyText: "Key(s)",
+        }), (0, flattenTranslations_1.flattenTranslations)({ keyText: "Taste(n)" }))).toEqual([]);
+    });
     it("should return empty array if placeholders are identical but in different positions", () => {
         expect((0, findInvalidi18nTranslations_1.compareTranslationFiles)({
             basic: "added {{this}} and {{that}} should work.",

package/dist/utils/i18NextParser.js

@@ -2,7 +2,7 @@
 //  Based on https://github.com/i18next/i18next-translation-parser/blob/v1.0.0/src/parse.js
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parse = void 0;
-const REGEXP = new RegExp("({{[^}]+}}|\\$t{[^}]+}|\\$t\\([^\\)]+\\)|\\([0-9\\-inf]+\\)|<[^>]+>)", "g");
+const REGEXP = new RegExp("({{[^}]+}}|\\$t{[^}]+}|\\$t\\([^\\)]+\\)|\\([0-9\\-inf]+\\)(?=\\[)|<[^>]+>)", "g");
 const DOUBLE_BRACE = "{{";
 const $_T_BRACE = "$t{";
 const $_T_PARENTHESIS = "$t(";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lingual/i18n-check",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "i18n translation messages check",
   "license": "MIT",
   "main": "dist/index.js",
@@ -40,5 +40,8 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/lingualdev/i18n-check.git"
+  },
+  "engines": {
+    "node": ">=20"
   }
 }