@lingual/i18n-check 0.8.1 → 0.8.3

package/README.md

@@ -371,7 +371,7 @@ Aside from using the CLI, i18n-check also exposes a set of check functions that
 Start by importing i18n-check:
 
 ```ts
-import * as i18nCheck from "@lingual/i18n-check";
+import * as i18nCheck from '@lingual/i18n-check';
 ```
 
 ### `i18nCheck.checkTranslations(source, targets [, options])`
@@ -379,10 +379,10 @@ import * as i18nCheck from "@lingual/i18n-check";
 `checkTranslations` expects the base and comparison or target files and returns an object containing the missing and invalid keys. The optional `options` objects can be provided as a third argument to define the format style via the `format` property, this is useful if you want to validate `i18next` specific translations.
 
 ```ts
-import { checkTranslations } from "@lingual/i18n-check";
+import { checkTranslations } from '@lingual/i18n-check';
 
 const options = {
-  format: "i18next",
+  format: 'i18next',
 };
 
 const { invalidKeys, missingKeys } = checkTranslations(
@@ -395,11 +395,11 @@ const { invalidKeys, missingKeys } = checkTranslations(
 Additionally the `options` object enables to also define which checks should run via the `checks` property, f.e. if you only want to check for missing or invalid keys only.
 
 ```ts
-import { checkTranslations } from "@lingual/i18n-check";
+import { checkTranslations } from '@lingual/i18n-check';
 
 const options = {
-  format: "icu",
-  checks: ["invalidKeys"],
+  format: 'icu',
+  checks: ['invalidKeys'],
 };
 
 const { invalidKeys } = checkTranslations(source, targets, options);
@@ -433,7 +433,7 @@ The result for `missingKeys` as well as `invalidKeys` is an object containing th
 `checkMissingTranslations` checks for any missing keys in the target files. All files are compared against the source file.
 
 ```ts
-import { checkMissingTranslations } from "@lingual/i18n-check";
+import { checkMissingTranslations } from '@lingual/i18n-check';
 
 const result = checkMissingTranslations(source, targets);
 
@@ -450,10 +450,10 @@ The result is an object containing the provided locales and their corresponding
 `checkInvalidTranslations` checks if there are any invalid keys in the target files. All files are compared against the source file.
 
 ```ts
-import { checkInvalidTranslations } from "@lingual/i18n-check";
+import { checkInvalidTranslations } from '@lingual/i18n-check';
 
 const options = {
-  format: "i18next",
+  format: 'i18next',
 };
 
 const result = checkInvalidTranslations(source, targets, options);
@@ -470,7 +470,7 @@ The result is an object containing the provided locales and their corresponding
 
 If you want to checkout and run the code, you need to run the `build` command first.
 
-Run `yarn build`, `pnpm run build` or `npm run build` and then depending on the scenario one of the following commands.
+Run `pnpm run build` and then depending on the scenario one of the following commands.
 
 Basic icu translation example:
 
@@ -516,14 +516,6 @@ To run the tests use one of the following commands:
 pnpm test
 ```
 
-```bash
-yarn test
-```
-
-```bash
-npm test
-```
-
 ## Links
 
 - [Introducing i18n-check](https://lingual.dev/blog/introducing-i18n-check/)

package/dist/bin/index.js

@@ -13,23 +13,24 @@ const js_yaml_1 = __importDefault(require("js-yaml"));
 const __1 = require("..");
 const errorReporters_1 = require("../errorReporters");
 const flattenTranslations_1 = require("../utils/flattenTranslations");
-const version = require("../../package.json").version;
+const node_path_1 = __importDefault(require("node:path"));
+const version = require('../../package.json').version;
 commander_1.program
     .version(version)
-    .option("-l, --locales <locales...>", "name of the directory containing the locales to validate")
-    .option("-s, --source <locale>", "the source locale to validate against")
-    .option("-f, --format <type>", "define the specific format: i18next, react-intl or next-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: invalidKeys, missingKeys, unused, undefined. 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 <paths...>", "define the source path(s) to find all unused and undefined keys")
-    .option("--parser-component-functions <components...>", "a list of component names to parse when using the --unused option")
+    .option('-l, --locales <locales...>', 'name of the directory containing the locales to validate')
+    .option('-s, --source <locale>', 'the source locale to validate against')
+    .option('-f, --format <type>', 'define the specific format: i18next, react-intl or next-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: invalidKeys, missingKeys, unused, undefined. 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 <paths...>', 'define the source path(s) 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 = () => {
-    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."));
+    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 errorReporters_1.CheckOptions;
@@ -42,32 +43,33 @@ const isSource = (fileInfo, srcPath) => {
 };
 const main = async () => {
     const start = performance.now();
-    const srcPath = commander_1.program.getOptionValue("source");
-    const localePath = commander_1.program.getOptionValue("locales");
-    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");
+    const srcPath = commander_1.program.getOptionValue('source');
+    const localePath = commander_1.program.getOptionValue('locales');
+    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"));
+        console.log(chalk_1.default.red('Source not found. Please provide a valid source locale, i.e. -s en-US'));
         (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/"));
+        console.log(chalk_1.default.red('Locale file(s) not found. Please provide valid locale file(s), i.e. -locales translations/'));
         (0, node_process_1.exit)(1);
     }
     const excludedPaths = exclude ?? [];
     const localePathFolders = localePath;
     const isMultiFolders = localePathFolders.length > 1;
-    let srcFiles = [];
-    let targetFiles = [];
+    const srcFiles = [];
+    const targetFiles = [];
     const pattern = isMultiFolders
-        ? `{${localePath.join(",").trim()}}/**/*.{json,yaml,yml}`
-        : `${localePath.join(",").trim()}/**/*.{json,yaml,yml}`;
+        ? `{${localePath.join(',').trim()}}/**/*.{json,yaml,yml}`
+        : `${localePath.join(',').trim()}/**/*.{json,yaml,yml}`;
     const files = await (0, glob_1.glob)(pattern, {
-        ignore: ["node_modules/**"].concat(excludedPaths),
+        ignore: ['node_modules/**'].concat(excludedPaths),
+        windowsPathsNoEscape: true,
     });
-    console.log("i18n translations checker");
+    console.log('i18n translations checker');
     console.log(chalk_1.default.gray(`Source: ${srcPath}`));
     if (format) {
         console.log(chalk_1.default.blackBright(`Selected format is: ${format}`));
@@ -78,23 +80,23 @@ const main = async () => {
     };
     const fileInfos = [];
     files.sort().forEach((file) => {
-        const path = file.split("/");
-        const name = path.pop() ?? "";
-        const extension = name.split(".").pop() ?? "json";
+        const filePath = file.split(node_path_1.default.sep);
+        const name = filePath.pop() ?? '';
+        const extension = name.split('.').pop() ?? 'json';
         fileInfos.push({
             extension,
             file,
             name,
-            path,
+            path: filePath,
         });
     });
     fileInfos.forEach(({ extension, file, name, path }) => {
         let rawContent;
-        if (extension === "yaml") {
-            rawContent = js_yaml_1.default.load(node_fs_1.default.readFileSync(file, "utf-8"));
+        if (extension === 'yaml') {
+            rawContent = js_yaml_1.default.load(node_fs_1.default.readFileSync(file, 'utf-8'));
         }
         else {
-            rawContent = JSON.parse(node_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)) {
@@ -105,12 +107,12 @@ const main = async () => {
             });
         }
         else {
-            const fullPath = path.join("-");
+            const fullPath = path.join('-');
             const reference = fileInfos.find((fileInfo) => {
                 if (!isSource(fileInfo, srcPath)) {
                     return false;
                 }
-                if (fileInfo.path.join("-") === fullPath) {
+                if (fileInfo.path.join('-') === fullPath) {
                     return true;
                 }
                 // Check if the folder path matches - ignoring the last folder
@@ -128,8 +130,8 @@ const main = async () => {
                 //
                 // Referencing: `path/to/locales/en-US/one.json`, `path/to/locales/de-DE/one.json`
                 // Non Referencing: `path/to/locales/en-US/one.json`, `path/to/other/locales/de-DE/one.json`
-                if (fileInfo.path.slice(0, fileInfo.path.length - 1).join("-") ===
-                    path.slice(0, path.length - 1).join("-")) {
+                if (fileInfo.path.slice(0, fileInfo.path.length - 1).join('-') ===
+                    path.slice(0, path.length - 1).join('-')) {
                     return fileInfo.name === name;
                 }
                 return false;
@@ -144,13 +146,13 @@ const main = async () => {
         }
     });
     if (srcFiles.length === 0) {
-        console.log(chalk_1.default.red("Source not found. Please provide a valid source locale, i.e. -s en-US"));
+        console.log(chalk_1.default.red('Source not found. Please provide a valid source locale, i.e. -s en-US'));
         (0, node_process_1.exit)(1);
     }
-    if ((options.checks.includes("missingKeys") ||
-        options.checks.includes("invalidKeys")) &&
+    if ((options.checks.includes('missingKeys') ||
+        options.checks.includes('invalidKeys')) &&
         targetFiles.length === 0) {
-        console.log(chalk_1.default.red("Locale file(s) not found. Please provide valid locale file(s), i.e. --locales translations/"));
+        console.log(chalk_1.default.red('Locale file(s) not found. Please provide valid locale file(s), i.e. --locales translations/'));
         (0, node_process_1.exit)(1);
     }
     try {
@@ -159,10 +161,11 @@ const main = async () => {
         if (unusedSrcPath) {
             const isMultiUnusedFolders = unusedSrcPath.length > 1;
             const pattern = isMultiUnusedFolders
-                ? `{${unusedSrcPath.join(",").trim()}}/**/*.{ts,tsx}`
-                : `${unusedSrcPath.join(",").trim()}/**/*.{ts,tsx}`;
+                ? `{${unusedSrcPath.join(',').trim()}}/**/*.{ts,tsx}`
+                : `${unusedSrcPath.join(',').trim()}/**/*.{ts,tsx}`;
             const filesToParse = (0, glob_1.globSync)(pattern, {
-                ignore: ["node_modules/**"],
+                ignore: ['node_modules/**'],
+                windowsPathsNoEscape: true,
             });
             const unusedKeys = await (0, __1.checkUnusedKeys)(srcFiles, filesToParse, options, componentFunctions);
             printUnusedKeysResult({ unusedKeys });
@@ -180,6 +183,7 @@ const main = async () => {
         else {
             (0, node_process_1.exit)(0);
         }
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
     }
     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"));
@@ -187,97 +191,67 @@ const main = async () => {
     }
 };
 const printTranslationResult = ({ missingKeys, invalidKeys, }) => {
-    const reporter = commander_1.program.getOptionValue("reporter");
-    const isSummary = reporter === "summary";
+    const reporter = commander_1.program.getOptionValue('reporter');
+    const isSummary = reporter === 'summary';
     if (missingKeys && Object.keys(missingKeys).length > 0) {
-        console.log(chalk_1.default.red("\nFound missing keys!"));
+        console.log(chalk_1.default.red('\nFound missing keys!'));
         if (isSummary) {
-            console.log(chalk_1.default.red((0, errorReporters_1.summaryReporter)(getSummaryRows(missingKeys))));
+            console.log(chalk_1.default.red((0, errorReporters_1.formatSummaryTable)(missingKeys)));
         }
         else {
-            console.log(chalk_1.default.red((0, errorReporters_1.standardReporter)(getStandardRows(missingKeys))));
+            const table = (0, errorReporters_1.formatCheckResultTable)(missingKeys);
+            console.log(chalk_1.default.red(table));
         }
     }
     else if (missingKeys) {
-        console.log(chalk_1.default.green("\nNo missing keys found!"));
+        console.log(chalk_1.default.green('\nNo missing keys found!'));
     }
     if (invalidKeys && Object.keys(invalidKeys).length > 0) {
-        console.log(chalk_1.default.red("\nFound invalid keys!"));
+        console.log(chalk_1.default.red('\nFound invalid keys!'));
         if (isSummary) {
-            console.log(chalk_1.default.red((0, errorReporters_1.summaryReporter)(getSummaryRows(invalidKeys))));
+            console.log(chalk_1.default.red((0, errorReporters_1.formatSummaryTable)(invalidKeys)));
         }
         else {
-            console.log(chalk_1.default.red((0, errorReporters_1.standardReporter)(getStandardRows(invalidKeys), true)));
+            const table = (0, errorReporters_1.formatInvalidTranslationsResultTable)(invalidKeys);
+            console.log(chalk_1.default.red(table));
         }
     }
     else if (invalidKeys) {
-        console.log(chalk_1.default.green("\nNo invalid translations found!"));
+        console.log(chalk_1.default.green('\nNo invalid translations found!'));
     }
 };
 const printUnusedKeysResult = ({ unusedKeys, }) => {
-    const reporter = commander_1.program.getOptionValue("reporter");
-    const isSummary = reporter === "summary";
+    const reporter = commander_1.program.getOptionValue('reporter');
+    const isSummary = reporter === 'summary';
     if (unusedKeys && hasKeys(unusedKeys)) {
-        console.log(chalk_1.default.red("\nFound unused keys!"));
+        console.log(chalk_1.default.red('\nFound unused keys!'));
         if (isSummary) {
-            console.log(chalk_1.default.red((0, errorReporters_1.summaryReporter)(getSummaryRows(unusedKeys))));
+            console.log(chalk_1.default.red((0, errorReporters_1.formatSummaryTable)(unusedKeys)));
         }
         else {
-            console.log(chalk_1.default.red((0, errorReporters_1.standardReporter)(getStandardRows(unusedKeys))));
+            console.log(chalk_1.default.red((0, errorReporters_1.formatCheckResultTable)(unusedKeys)));
         }
     }
     else if (unusedKeys) {
-        console.log(chalk_1.default.green("\nNo unused keys found!"));
+        console.log(chalk_1.default.green('\nNo unused keys found!'));
     }
 };
 const printUndefinedKeysResult = ({ undefinedKeys, }) => {
-    const reporter = commander_1.program.getOptionValue("reporter");
-    const isSummary = reporter === "summary";
+    const reporter = commander_1.program.getOptionValue('reporter');
+    const isSummary = reporter === 'summary';
     if (undefinedKeys && hasKeys(undefinedKeys)) {
-        console.log(chalk_1.default.red("\nFound undefined keys!"));
+        console.log(chalk_1.default.red('\nFound undefined keys!'));
         if (isSummary) {
-            console.log(chalk_1.default.red((0, errorReporters_1.summaryReporter)(getSummaryRows(undefinedKeys))));
+            console.log(chalk_1.default.red((0, errorReporters_1.formatSummaryTable)(undefinedKeys)));
         }
         else {
-            console.log(chalk_1.default.red((0, errorReporters_1.standardReporter)(getStandardRows(undefinedKeys))));
+            console.log(chalk_1.default.red((0, errorReporters_1.formatCheckResultTable)(undefinedKeys)));
         }
     }
     else if (undefinedKeys) {
-        console.log(chalk_1.default.green("\nNo undefined keys found!"));
+        console.log(chalk_1.default.green('\nNo undefined keys found!'));
     }
 };
-const truncate = (chars, len = 80) => chars.length > 80 ? `${chars.substring(0, len)}...` : chars;
-const getSummaryRows = (checkResult) => {
-    const formattedRows = [];
-    for (const [file, keys] of Object.entries(checkResult)) {
-        formattedRows.push({
-            file: truncate(file),
-            total: keys.length,
-        });
-    }
-    return formattedRows;
-};
-const getStandardRows = (checkResult) => {
-    const formattedRows = [];
-    for (const [file, keys] of Object.entries(checkResult)) {
-        for (const entry of keys) {
-            if (typeof entry === "object") {
-                formattedRows.push({
-                    file: truncate(file),
-                    key: truncate(entry.key),
-                    msg: truncate(entry.msg, 120),
-                });
-            }
-            else {
-                formattedRows.push({
-                    file: truncate(file),
-                    key: truncate(entry),
-                });
-            }
-        }
-    }
-    return formattedRows;
-};
 const hasKeys = (checkResult) => {
     for (const [_, keys] of Object.entries(checkResult)) {
         if (keys.length > 0) {