@lingual/i18n-check 0.7.0 → 0.7.1

package/README.md

@@ -114,28 +114,51 @@ yarn i18n:check --locales translations/i18NextMessageExamples -s en-US -f i18nex
 
 ### --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 `-o` or `--only` option you can specify a specific check to run.
+By default i18n-check will perform a validation against any **missing** and/or **invalid** keys, additionally **unused** and **undefined** checks if the `--unused` option is set. 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.
+The available options are:
 
-Check for missing keys:
+- `missingKeys`: will check against any missing keys in the target files.
+- `invalidKeys`: will check for invalid keys, where the target translations has a different type then the one defined in the source file.
+- `unused`: will check for any locale keys that do not exist in the codebase.
+- `undefined`: will check for any keys that exist in the codebase but not in the source locale files.
+
+Check for missing keys only:
 
 ```bash
 yarn i18n:check --locales translations/messageExamples -s en-US -o missingKeys
 ```
 
-Check for invalid keys:
+Check for invalid keys only:
 
 ```bash
 yarn i18n:check --locales translations/messageExamples -s en-US -o invalidKeys
 ```
 
+Check for unused key only:
+
+```bash
+yarn i18n:check --locales translations/messageExamples -s en-US -o unused
+```
+
+Check for undefined keys only:
+
+```bash
+yarn i18n:check --locales translations/messageExamples -s en-US -o undefined
+```
+
 Check for missing and invalid keys (which is the default):
 
 ```bash
 yarn i18n:check --locales translations/messageExamples -s en-US -o missingKeys invalidKeys
 ```
 
+Check for unused and undefined keys only:
+
+```bash
+yarn i18n:check --locales translations/messageExamples -s en-US -o unused undefined
+```
+
 ### --unused, -u
 
 This feature is currently only supported for `react-intl` and `i18next` as well as `next-intl` (experimental at the moment) 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.

package/dist/bin/index.js

@@ -20,7 +20,7 @@ commander_1.program
     .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: invalid, missing. By default the check will validate against missing and invalid keys, i.e. --only invalidKeys,missingKeys")
+    .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 <path>", "define the source path to find all unused and undefined keys")
@@ -32,10 +32,10 @@ const getCheckOptions = () => {
         console.log(chalk_1.default.yellow("The --check option has been deprecated, use the --only option instead."));
     }
     if (!checkOption) {
-        return ["invalidKeys", "missingKeys"];
+        return errorReporters_1.CheckOptions;
     }
-    const checks = checkOption.filter((check) => ["invalidKeys", "missingKeys"].includes(check.trim()));
-    return checks.length > 0 ? checks : ["invalidKeys", "missingKeys"];
+    const checks = checkOption.filter((check) => errorReporters_1.CheckOptions.includes(check.trim()));
+    return checks.length > 0 ? checks : errorReporters_1.CheckOptions;
 };
 const isSource = (fileInfo, srcPath) => {
     return (fileInfo.path.some((path) => path.toLowerCase() === srcPath.toLowerCase()) || fileInfo.name.toLowerCase().slice(0, -5) === srcPath.toLowerCase());

package/dist/errorReporters.d.ts

@@ -1,4 +1,5 @@
-export type Context = "missingKeys" | "invalidKeys";
+export declare const CheckOptions: string[];
+export type Context = (typeof CheckOptions)[number];
 export declare const contextMapping: Record<Context, string>;
 export declare const standardReporter: (result: {
     file: string;

package/dist/errorReporters.js

@@ -1,11 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createTable = exports.summaryReporter = exports.standardReporter = exports.contextMapping = void 0;
+exports.createTable = exports.summaryReporter = exports.standardReporter = exports.contextMapping = exports.CheckOptions = void 0;
 const console_1 = require("console");
 const stream_1 = require("stream");
+exports.CheckOptions = [
+    "invalidKeys",
+    "missingKeys",
+    "unused",
+    "undefined",
+];
 exports.contextMapping = {
     invalidKeys: "invalid",
     missingKeys: "missing",
+    unused: "unused",
+    undefined: "undefined",
 };
 const standardReporter = (result) => {
     return (0, exports.createTable)(result.map(({ file, key }) => ({ file, key })));

package/dist/index.js

@@ -48,10 +48,14 @@ const checkTranslations = (source, targets, options = { format: "icu", checks: [
 exports.checkTranslations = checkTranslations;
 const checkUnusedKeys = async (translationFiles, filesToParse, options = {
     format: "react-intl",
+    checks: [],
 }, componentFunctions = []) => {
     if (!options.format || !ParseFormats.includes(options.format)) {
         return undefined;
     }
+    if (!options.checks || !options.checks.includes("unused")) {
+        return undefined;
+    }
     if (options.format === "react-intl") {
         return findUnusedReactIntlTranslations(translationFiles, filesToParse);
     }
@@ -119,10 +123,14 @@ const findUnusedNextIntlTranslations = async (translationFiles, filesToParse) =>
 };
 const checkUndefinedKeys = async (source, filesToParse, options = {
     format: "react-intl",
+    checks: [],
 }, componentFunctions = []) => {
     if (!options.format || !ParseFormats.includes(options.format)) {
         return undefined;
     }
+    if (!options.checks || !options.checks.includes("undefined")) {
+        return undefined;
+    }
     if (options.format === "react-intl") {
         return findUndefinedReactIntlKeys(source, filesToParse);
     }

package/package.json

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