@lingual/i18n-check 0.8.8 → 0.8.10

package/dist/bin/index.js

@@ -185,8 +185,8 @@ const main = async () => {
         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) ||
-            (unusedKeyResult && Object.keys(unusedKeyResult).length > 0) ||
-            (undefinedKeyResult && Object.keys(undefinedKeyResult).length > 0)) {
+            (unusedKeyResult && hasKeys(unusedKeyResult)) ||
+            (undefinedKeyResult && hasKeys(undefinedKeyResult))) {
             (0, node_process_1.exit)(1);
         }
         else {

package/dist/index.js

@@ -61,14 +61,18 @@ const checkUnusedKeys = async (translationFiles, filesToParse, options = {
     if (!options.checks || !options.checks.includes('unused')) {
         return undefined;
     }
+    const filteredTranslationFiles = translationFiles.map(({ content, ...rest }) => ({
+        ...rest,
+        content: filterKeys(content, options.ignore),
+    }));
     if (options.format === 'react-intl') {
-        return findUnusedReactIntlTranslations(translationFiles, filesToParse);
+        return findUnusedReactIntlTranslations(filteredTranslationFiles, filesToParse);
     }
     else if (options.format === 'i18next') {
-        return findUnusedI18NextTranslations(translationFiles, filesToParse, componentFunctions);
+        return findUnusedI18NextTranslations(filteredTranslationFiles, filesToParse, componentFunctions);
     }
     else if (options.format === 'next-intl') {
-        return findUnusedNextIntlTranslations(translationFiles, filesToParse);
+        return findUnusedNextIntlTranslations(filteredTranslationFiles, filesToParse);
     }
 };
 exports.checkUnusedKeys = checkUnusedKeys;
@@ -162,17 +166,19 @@ const checkUndefinedKeys = async (source, filesToParse, options = {
         return undefined;
     }
     if (options.format === 'react-intl') {
-        return findUndefinedReactIntlKeys(source, filesToParse);
+        return findUndefinedReactIntlKeys(source, filesToParse, options);
     }
     else if (options.format === 'i18next') {
-        return findUndefinedI18NextKeys(source, filesToParse, componentFunctions);
+        return findUndefinedI18NextKeys(source, filesToParse, options, componentFunctions);
     }
     else if (options.format === 'next-intl') {
-        return findUndefinedNextIntlKeys(source, filesToParse);
+        return findUndefinedNextIntlKeys(source, filesToParse, options);
     }
 };
 exports.checkUndefinedKeys = checkUndefinedKeys;
-const findUndefinedReactIntlKeys = async (translationFiles, filesToParse) => {
+const findUndefinedReactIntlKeys = async (translationFiles, filesToParse, options = {
+    ignore: [],
+}) => {
     const sourceKeys = new Set(translationFiles.flatMap(({ content }) => {
         return Object.keys(content);
     }));
@@ -181,7 +187,7 @@ const findUndefinedReactIntlKeys = async (translationFiles, filesToParse) => {
     });
     const undefinedKeys = {};
     Object.entries(JSON.parse(extractedResult)).forEach(([key, meta]) => {
-        if (!sourceKeys.has(key)) {
+        if (!sourceKeys.has(key) && !isIgnoredKey(options.ignore ?? [], key)) {
             const data = meta;
             if (!('file' in data) || typeof data.file !== 'string') {
                 return;
@@ -195,7 +201,9 @@ const findUndefinedReactIntlKeys = async (translationFiles, filesToParse) => {
     });
     return undefinedKeys;
 };
-const findUndefinedI18NextKeys = async (source, filesToParse, componentFunctions = []) => {
+const findUndefinedI18NextKeys = async (source, filesToParse, options = {
+    ignore: [],
+}, componentFunctions = []) => {
     const { extractedResult, skippableKeys } = await getI18NextKeysInCode(filesToParse, componentFunctions);
     const sourceKeys = new Set(source.flatMap(({ content }) => {
         return Object.keys(content);
@@ -205,7 +213,9 @@ const findUndefinedI18NextKeys = async (source, filesToParse, componentFunctions
         const isSkippable = skippableKeys.find((skippableKey) => {
             return key.includes(skippableKey);
         });
-        if (isSkippable === undefined && !sourceKeys.has(key)) {
+        if (isSkippable === undefined &&
+            !sourceKeys.has(key) &&
+            !isIgnoredKey(options.ignore ?? [], key)) {
             if (!undefinedKeys[file]) {
                 undefinedKeys[file] = [];
             }
@@ -214,14 +224,18 @@ const findUndefinedI18NextKeys = async (source, filesToParse, componentFunctions
     });
     return undefinedKeys;
 };
-const findUndefinedNextIntlKeys = async (translationFiles, filesToParse) => {
+const findUndefinedNextIntlKeys = async (translationFiles, filesToParse, options = {
+    ignore: [],
+}) => {
     const sourceKeys = new Set(translationFiles.flatMap(({ content }) => {
         return Object.keys(content);
     }));
     const extractedResult = (0, nextIntlSrcParser_1.extract)(filesToParse);
     const undefinedKeys = {};
     extractedResult.forEach(({ key, meta }) => {
-        if (!meta.dynamic && !sourceKeys.has(key)) {
+        if (!meta.dynamic &&
+            !sourceKeys.has(key) &&
+            !isIgnoredKey(options.ignore ?? [], key)) {
             const file = meta.file;
             if (!undefinedKeys[file]) {
                 undefinedKeys[file] = [];
@@ -297,12 +311,7 @@ const getI18NextKeysInCode = async (filesToParse, componentFunctions = []) => {
 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;
-            })) {
+            if (isIgnoredKey(keysToIgnore, key)) {
                 return acc;
             }
             acc[key] = value;
@@ -311,6 +320,14 @@ const filterKeys = (content, keysToIgnore = []) => {
     }
     return content;
 };
+const isIgnoredKey = (keysToIgnore, key) => {
+    return (keysToIgnore.find((ignoreKey) => {
+        if (ignoreKey.endsWith('*')) {
+            return key.includes(ignoreKey.slice(0, ignoreKey.length - 1));
+        }
+        return ignoreKey === key;
+    }) !== undefined);
+};
 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.8",
+  "version": "0.8.10",
   "description": "i18n translation messages check",
   "license": "MIT",
   "main": "dist/index.js",