@lingual/i18n-check 0.8.3 → 0.8.4

package/README.md

@@ -223,6 +223,28 @@ 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`
 
+### --ignore, -i
+
+There can be situations where we only want to translate a feature for a specific region and therefore need to ignore any missing key checks against non supported locales. Another scenario is that we know of the missing keys and want to be able to skip these missing keys when running checks. For these aforementioned scenarios, by using the `--ignore` or `-i` option you can specify which keys to ignore, additionally also being able to define ignoring all keys inside a defined path, i.e. `some.keys.path.*`.
+
+To ignore regular keys:
+
+```bash
+yarn i18n:check --locales translations/folderExamples -s en-US -i some.key.to.ignore other.key.to.ignore
+```
+
+To ignore all keys within a provided path:
+
+```bash
+yarn i18n:check --locales translations/folderExamples -s en-US -i "some.path.to.keys.*"
+```
+
+A mix of regular keys and paths:
+
+```bash
+yarn i18n:check --locales translations/folderExamples -s en-US -i "some.path.to.keys.*" some.key.to.ignore other.key.to.ignore
+```
+
 ### --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.

package/dist/bin/index.js

@@ -24,6 +24,7 @@ commander_1.program
     .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('-i, --ignore <ignore...>', 'define the key(s) or group of keys (i.e. `some.namespace.*`) 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();
@@ -47,6 +48,7 @@ const main = async () => {
     const localePath = commander_1.program.getOptionValue('locales');
     const format = commander_1.program.getOptionValue('format');
     const exclude = commander_1.program.getOptionValue('exclude');
+    const ignore = commander_1.program.getOptionValue('ignore');
     const unusedSrcPath = commander_1.program.getOptionValue('unused');
     const componentFunctions = commander_1.program.getOptionValue('parserComponentFunctions');
     if (!srcPath) {
@@ -77,6 +79,7 @@ const main = async () => {
     const options = {
         checks: getCheckOptions(),
         format: format ?? undefined,
+        ignore,
     };
     const fileInfos = [];
     files.sort().forEach((file) => {

package/dist/bin/index.test.js

@@ -489,6 +489,38 @@ ${(0, errorReporters_1.formatTable)([
                 ],
             ])}
 
+`);
+        });
+        it('should skip ignored keys when checking for missing/invalid keys', async () => {
+            const stdout = await execAsync('node dist/bin/index.js -l translations/multipleFilesFolderExample translations/flattenExamples -s en-US -i "other.nested.*" test.drive.four');
+            const result = stdout.split('Done')[0];
+            expect(result).toEqual(`i18n translations checker
+Source: en-US
+
+Found missing keys!
+${(0, errorReporters_1.formatTable)([
+                [['file', 'key']],
+                [[multiFiles('de-DE/one.json'), 'message.text-format']],
+            ])}
+
+Found invalid keys!
+${(0, errorReporters_1.formatTable)([
+                [['info', 'result']],
+                [
+                    ['file', multiFiles('de-DE/one.json')],
+                    ['key', 'message.select'],
+                    [
+                        'msg',
+                        'Expected element of type "select" but received "argument", Unexpected date element, Unexpected date element...',
+                    ],
+                ],
+                [
+                    ['file', multiFiles('de-DE/three.json')],
+                    ['key', 'multipleVariables'],
+                    ['msg', 'Expected argument to contain "user" but received "name"'],
+                ],
+            ])}
+
 `);
         });
     });

package/dist/index.d.ts

@@ -3,6 +3,7 @@ import { Context } from './errorReporters';
 export type Options = {
     format?: 'icu' | 'i18next' | 'react-intl' | 'next-intl';
     checks?: Context[];
+    ignore?: string[];
 };
 export declare const checkInvalidTranslations: (source: Translation, targets: Record<string, Translation>, options?: Options) => InvalidTranslationsResult;
 export declare const checkMissingTranslations: (source: Translation, targets: Record<string, Translation>) => CheckResult;

package/dist/index.js

@@ -26,22 +26,23 @@ const checkTranslations = (source, targets, options = { format: 'icu', checks: [
     const { checks = ['invalidKeys', 'missingKeys'] } = options;
     const missingKeys = {};
     const invalidKeys = {};
-    const hasMissingKeys = checks.includes('missingKeys');
-    const hasInvalidKeys = checks.includes('invalidKeys');
+    const hasMissingKeysCheck = checks.includes('missingKeys');
+    const hasInvalidKeysCheck = checks.includes('invalidKeys');
     source.forEach(({ name, content }) => {
         const files = Object.fromEntries(targets
             .filter(({ reference }) => reference === name)
             .map(({ name, content }) => [name, content]));
-        if (hasMissingKeys) {
-            merge(missingKeys, (0, exports.checkMissingTranslations)(content, files));
+        if (hasMissingKeysCheck) {
+            const filteredContent = filterKeys(content, options.ignore ?? []);
+            merge(missingKeys, (0, exports.checkMissingTranslations)(filteredContent, files));
         }
-        if (hasInvalidKeys) {
+        if (hasInvalidKeysCheck) {
             merge(invalidKeys, (0, exports.checkInvalidTranslations)(content, files, options));
         }
     });
     return {
-        missingKeys: hasMissingKeys ? missingKeys : undefined,
-        invalidKeys: hasInvalidKeys ? invalidKeys : undefined,
+        missingKeys: hasMissingKeysCheck ? missingKeys : undefined,
+        invalidKeys: hasInvalidKeysCheck ? invalidKeys : undefined,
     };
 };
 exports.checkTranslations = checkTranslations;
@@ -102,7 +103,7 @@ const findUnusedI18NextTranslations = async (source, filesToParse, componentFunc
                 continue;
             }
             // find the file name
-            const [fileName] = (name.split(path_1.default.sep).pop() ?? "").split(".");
+            const [fileName] = (name.split(path_1.default.sep).pop() ?? '').split('.');
             if (!extractedResultSet.has(`${fileName}.${keyInSource}`) &&
                 !extractedResultSet.has(keyInSource)) {
                 found.push(keyInSource);
@@ -270,14 +271,14 @@ const getI18NextKeysInCode = async (filesToParse, componentFunctions = []) => {
         // The current implementation considers the key as used no matter the namespace.
         for (const entry of entries) {
             // check for namespace, i.e. `namespace:some.key`
-            const [namespace, ...keyParts] = entry.key.split(":");
+            const [namespace, ...keyParts] = entry.key.split(':');
             // If there is a namespace make sure to assign the namespace
             // and update the key name
             // Ensure that the assumed key is not the default value
             if (keyParts.length > 0 && entry.key !== entry.defaultValue) {
                 entry.namespace = namespace;
                 // rebuild the key without the namespace
-                entry.key = keyParts.join(":");
+                entry.key = keyParts.join(':');
             }
             if (entry.returnObjects) {
                 skippableKeys.push(entry.key);
@@ -293,6 +294,23 @@ const getI18NextKeysInCode = async (filesToParse, componentFunctions = []) => {
     });
     return { extractedResult, skippableKeys };
 };
+const filterKeys = (content, keysToIgnore = []) => {
+    if (keysToIgnore.length > 0) {
+        return Object.entries(content).reduce((acc, [key, value]) => {
+            if (keysToIgnore.find((ignoreKey) => {
+                if (ignoreKey.endsWith('*')) {
+                    return key.includes(ignoreKey.slice(0, ignoreKey.length - 1));
+                }
+                return ignoreKey === key;
+            })) {
+                return acc;
+            }
+            acc[key] = value;
+            return acc;
+        }, {});
+    }
+    return content;
+};
 function _flatten(object, prefix = null, result = {}) {
     for (const key in object) {
         const propName = prefix ? `${prefix}.${key}` : key;

package/package.json

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