@kununu/phraseapp-cli 4.0.0-beta.2 → 4.0.0-beta.4

package/README_CHECK_TRANSLATIONS.md

@@ -0,0 +1,55 @@
+# phraseapp-cli
+>
+> phraseapp-cli for <https://phraseapp.com/>
+
+## Installation
+
+### Add `@kununu/phraseapp-cli` to your project
+
+```bash
+npm install @kununu/phraseapp-cli --save
+```
+
+### Add `check-translations` to your project
+
+Add to ```package.json```
+
+```json
+ "check-translations": "SOURCE_DIR=src node ./node_modules/@kununu/phraseapp-cli/check-translations.js",
+```
+
+## Configuration file
+
+You have to add to the ```.phraseapp.json``` file a new var dynamicKeys
+
+**For example**:
+
+```json
+{
+  "project_id": "YOUR_PROJECT_ID",
+  "path": "YOUR_TRANSLATIONS_PATH",
+  "locales": [
+    {
+      "locale_id": "de_DE",
+      "tags": [
+        "TAG1",
+        "TAG2",
+        "TAG3"
+      ]
+    },
+    {
+      "locale_id": "de_AT",
+      "tags": [
+        (...)
+      ],
+      "fallback_locale_id": "de_DE"
+    },
+    (...)
+  ],
+  "dynamicKeys": []
+}
+```
+
+## License
+
+Apache-2.0 © [kununu](https://kununu.com)

package/check-translations.js

@@ -1,7 +1,14 @@
-const { readFileSync, writeFileSync, unlinkSync, existsSync, mkdirSync } = require('fs');
-const {sync} = require('glob');
+const {
+  existsSync,
+  mkdirSync,
+  readFileSync,
+  unlinkSync,
+  writeFileSync,
+} = require('fs');
+
 const {parse} = require('@babel/parser');
 const traverse = require('@babel/traverse');
+const {sync} = require('glob');
 
 const FOLDER_REPORT_CHECK_TRANSLATIONS = `${process.cwd()}/report-check-translations`;
 const UNUSED_KEYS_FILE = `${FOLDER_REPORT_CHECK_TRANSLATIONS}/not_used_keys.json`;
@@ -9,104 +16,143 @@ const MISSING_KEYS_FILE = `${FOLDER_REPORT_CHECK_TRANSLATIONS}/missing_keys.json
 const POSSIBLE_DYNAMIC_KEYS_FILE = `${FOLDER_REPORT_CHECK_TRANSLATIONS}/possible_dynamic_keys.json`;
 
 function extractTranslationKeys() {
-    const files = sync(`${process.cwd()}/${process.env.SOURCE_DIR}/**/**/*.{js,jsx,ts,tsx}`);
-    const keys = new Set();
-    const possibleDynamicKeys = {};
-
-    files.forEach(file => {
-        const content = readFileSync(file, 'utf8');
-        try {
-            const ast = parse(content, { sourceType: 'module', plugins: ['jsx', 'typescript'] });
-            traverse.default(ast, {
-                JSXOpeningElement({ node }) {
-                    if (node.name.name === 'FormattedMessage') {
-                        const idAttr = node.attributes.find(attr => attr.name.name === 'id');
-                        if (idAttr && idAttr.value && idAttr.value.type === 'StringLiteral') {
-                            keys.add(idAttr.value.value);
-                        } else {
-                            possibleDynamicKeys[file] = possibleDynamicKeys[file] || [];
-                        }
-                    }
-                },
-                CallExpression({ node }) {
-                    if (node.callee && node.callee.property && ['formatMessage'].includes(node.callee.property.name)) {
-                        const firstArg = node.arguments[0];
-                        if (firstArg && firstArg.type === 'ObjectExpression') {
-                            const idProperty = firstArg.properties.find(prop => prop.key.name === 'id');
-                            if (idProperty && idProperty.value.type === 'StringLiteral') {
-                                keys.add(idProperty.value.value);
-                            } else {
-                                possibleDynamicKeys[file] = possibleDynamicKeys[file] || [];
-                            }
-                        }
-                    }
-                }
-            });
-        } catch (error) {
-            console.error(`Error processing ${file}:`, error);
-        }
-    });
+  const files = sync(
+    `${process.cwd()}/${process.env.SOURCE_DIR}/**/**/*.{js,jsx,ts,tsx}`,
+  );
+  const keys = new Set();
+  const possibleDynamicKeys = {};
+
+  files.forEach(file => {
+    const content = readFileSync(file, 'utf8');
+
+    try {
+      const ast = parse(content, {
+        plugins: ['jsx', 'typescript'],
+        sourceType: 'module',
+      });
 
-    if (Object.keys(possibleDynamicKeys).length > 0) {
-        console.log(`${Object.keys(possibleDynamicKeys).length} files contain possible dynamic keys were saved in ${POSSIBLE_DYNAMIC_KEYS_FILE}`);
-        writeFileSync(POSSIBLE_DYNAMIC_KEYS_FILE, JSON.stringify(possibleDynamicKeys, null, 2));
-    } else if (existsSync(POSSIBLE_DYNAMIC_KEYS_FILE)) {
-        unlinkSync(POSSIBLE_DYNAMIC_KEYS_FILE);
-        console.log(`${POSSIBLE_DYNAMIC_KEYS_FILE} was deleted as there are no possible dynamic keys.`);
+      traverse.default(ast, {
+        CallExpression({node}) {
+          if (
+            node.callee &&
+            node.callee.property &&
+            ['formatMessage'].includes(node.callee.property.name)
+          ) {
+            const firstArg = node.arguments[0];
+
+            if (firstArg && firstArg.type === 'ObjectExpression') {
+              const idProperty = firstArg.properties.find(
+                prop => prop.key.name === 'id',
+              );
+
+              if (idProperty && idProperty.value.type === 'StringLiteral') {
+                keys.add(idProperty.value.value);
+              } else {
+                possibleDynamicKeys[file] = possibleDynamicKeys[file] || [];
+              }
+            }
+          }
+        },
+        JSXOpeningElement({node}) {
+          if (node.name.name === 'FormattedMessage') {
+            const idAttr = node.attributes.find(
+              attr => attr.name.name === 'id',
+            );
+
+            if (
+              idAttr &&
+              idAttr.value &&
+              idAttr.value.type === 'StringLiteral'
+            ) {
+              keys.add(idAttr.value.value);
+            } else {
+              possibleDynamicKeys[file] = possibleDynamicKeys[file] || [];
+            }
+          }
+        },
+      });
+    } catch (error) {
+      console.error(`Error processing ${file}:`, error);
     }
+  });
 
-    return keys;
+  if (Object.keys(possibleDynamicKeys).length > 0) {
+    console.log(
+      `${Object.keys(possibleDynamicKeys).length} files contain possible dynamic keys were saved in ${POSSIBLE_DYNAMIC_KEYS_FILE}`,
+    );
+    writeFileSync(
+      POSSIBLE_DYNAMIC_KEYS_FILE,
+      JSON.stringify(possibleDynamicKeys, null, 2),
+    );
+  } else if (existsSync(POSSIBLE_DYNAMIC_KEYS_FILE)) {
+    unlinkSync(POSSIBLE_DYNAMIC_KEYS_FILE);
+    console.log(
+      `${POSSIBLE_DYNAMIC_KEYS_FILE} was deleted as there are no possible dynamic keys.`,
+    );
+  }
+
+  return keys;
 }
 
 function compareKeys() {
-    // create folder for report
-    if (!existsSync(FOLDER_REPORT_CHECK_TRANSLATIONS)) {
-        mkdirSync(FOLDER_REPORT_CHECK_TRANSLATIONS, { recursive: true });
+  // create report folder if it doesn't exist to save all the reports
+  if (!existsSync(FOLDER_REPORT_CHECK_TRANSLATIONS)) {
+    mkdirSync(FOLDER_REPORT_CHECK_TRANSLATIONS, {recursive: true});
+  }
+  const configPath = `${process.cwd()}/.phraseapp.json`;
+  const appKeys = extractTranslationKeys();
+
+  try {
+    const phrase = JSON.parse(readFileSync(configPath));
+    const translations = JSON.parse(
+      readFileSync(`${phrase.path}/de_AT.json`, 'utf8'),
+    );
+    const dynamicKeys = phrase.dynamicKeys || [];
+
+    const allValidKeys = new Set(Object.keys(translations));
+
+    let missingKeys = [...appKeys].filter(key => !allValidKeys.has(key));
+
+    missingKeys = missingKeys.filter(key => key != null && key !== undefined);
+
+    // Check if there are keys in dynamicKeys that are missing from allValidKeys.
+    dynamicKeys.forEach(key => {
+      if (!allValidKeys.has(key)) {
+        missingKeys.push(key);
+      } else {
+        allValidKeys.delete(key);
+      }
+    });
+
+    const referenceKeys = new Set([...appKeys, ...dynamicKeys]);
+    const unusedKeys = [...allValidKeys].filter(key => !referenceKeys.has(key));
+
+    if (missingKeys.length > 0) {
+      writeFileSync(MISSING_KEYS_FILE, JSON.stringify(missingKeys, null, 2));
+      console.log(
+        `${missingKeys.length} missing keys were saved in ${MISSING_KEYS_FILE}`,
+      );
+    } else if (existsSync(MISSING_KEYS_FILE)) {
+      unlinkSync(MISSING_KEYS_FILE);
+      console.log(
+        `${MISSING_KEYS_FILE} was deleted as there are no missing keys.`,
+      );
     }
-    const configPath = `${process.cwd()}/.phraseapp.json`;
-    const appKeys = extractTranslationKeys();
 
-    try {
-        const phrase = JSON.parse(readFileSync(configPath));
-        const translations = JSON.parse(readFileSync(`${phrase.path}/de_AT.json`, 'utf8'));
-        const dynamicKeys = phrase.dynamicKeys || [];
-
-        const allValidKeys = new Set(Object.keys(translations));
-        
-        let missingKeys = [...appKeys].filter(key => !allValidKeys.has(key));
-        missingKeys = missingKeys.filter(key => key != null && key !== undefined);
-
-        // Check if there are keys in dynamicKeys that are missing from allValidKeys.
-        dynamicKeys.forEach(key => {
-            if (!allValidKeys.has(key)) {
-                missingKeys.push(key);
-            } else {
-                allValidKeys.delete(key);
-            }
-        });
-
-        // 
-        const referenceKeys = new Set([...appKeys, ...dynamicKeys]);
-        const unusedKeys = [...allValidKeys].filter(key => !referenceKeys.has(key));
-        
-        if (missingKeys.length > 0) {
-            writeFileSync(MISSING_KEYS_FILE, JSON.stringify(missingKeys, null, 2));
-            console.log(`${missingKeys.length} missing keys were saved in ${MISSING_KEYS_FILE}`);
-        } else if (existsSync(MISSING_KEYS_FILE)) {
-            unlinkSync(MISSING_KEYS_FILE);
-            console.log(`${MISSING_KEYS_FILE} was deleted as there are no missing keys.`);
-        }
-
-        if (unusedKeys.length > 0) {
-            writeFileSync(UNUSED_KEYS_FILE, JSON.stringify(unusedKeys, null, 2));
-            console.log(`${unusedKeys.length} unused keys were saved in ${UNUSED_KEYS_FILE}`);
-        } else if (existsSync(UNUSED_KEYS_FILE)) {
-            unlinkSync(UNUSED_KEYS_FILE);
-            console.log(`${UNUSED_KEYS_FILE} was deleted as there are no missing keys.`);
-        }
-    } catch (error) {
-        console.error(error);
+    if (unusedKeys.length > 0) {
+      writeFileSync(UNUSED_KEYS_FILE, JSON.stringify(unusedKeys, null, 2));
+      console.log(
+        `${unusedKeys.length} unused keys were saved in ${UNUSED_KEYS_FILE}`,
+      );
+    } else if (existsSync(UNUSED_KEYS_FILE)) {
+      unlinkSync(UNUSED_KEYS_FILE);
+      console.log(
+        `${UNUSED_KEYS_FILE} was deleted as there are no missing keys.`,
+      );
     }
+  } catch (error) {
+    console.error(error);
+  }
 }
 
-compareKeys();
+compareKeys();

package/package.json

@@ -1,19 +1,18 @@
 {
   "name": "@kununu/phraseapp-cli",
-  "version": "4.0.0-beta.2",
+  "version": "4.0.0-beta.4",
   "description": "",
   "main": "index.js",
   "author": "kununu",
   "license": "MIT",
   "scripts": {
-    "lint": "eslint . --ext jsx --ext js --ext tsx --ext ts --ignore-path .eslintignore --max-warnings 10"
+    "lint": "eslint . --ext jsx --ext js --ext tsx --ext ts --ignore-path .eslintignore --max-warnings 10 --fix"
   },
   "dependencies": {
+    "@babel/parser": "^7.26.10",
+    "@babel/traverse": "^7.26.10",
     "colors": "1.4.0",
     "dotenv": "16.4.5",
-    "@babel/parser": "^7.26.9",
-    "@babel/traverse": "^7.26.9",
-    "fs": "^0.0.1-security",
     "glob": "^11.0.1"
   },
   "devDependencies": {