.github/workflows/check-locales.yml (3)

15-15: Update the GitHub Actions checkout action to v4.

The checkout action version v3 is outdated. GitHub recommends using the latest version for improved security and features.

-        uses: actions/checkout@v3
+        uses: actions/checkout@v4

🧰 Tools

🪛 actionlint (1.7.4)

15-15: the runner of "actions/checkout@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

---

18-18: Update the GitHub Actions setup-node action to v4.

The setup-node action version v3 is outdated. GitHub recommends using the latest version for improved security and features.

-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4

🧰 Tools

🪛 actionlint (1.7.4)

18-18: the runner of "actions/setup-node@v3" action is too old to run on GitHub Actions. update the action's version to fix this issue

(action)

---

22-23: Consider implementing dependency caching.

Adding caching for Node.js dependencies can significantly speed up your workflow execution time.

      - name: Install Dependencies
+       id: cache
+       uses: actions/cache@v3
+       with:
+         path: '**/node_modules'
+         key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+         restore-keys: |
+           ${{ runner.os }}-node-
+       
+     - name: Install Dependencies (if needed)
+       if: steps.cache.outputs.cache-hit != 'true'
        run: npm install

scripts/checkLocales.js (2)

6-7: Consider making the directory paths configurable.

Hardcoding paths might make the script less flexible if the project structure changes in the future.

-const LOCALES_DIR = path.join(__dirname, '../public/locales'); 
-const PRIMARY_LOCALE = 'en';
+// Allow overriding via environment variables
+const LOCALES_DIR = process.env.LOCALES_DIR || path.join(__dirname, '../public/locales'); 
+const PRIMARY_LOCALE = process.env.PRIMARY_LOCALE || 'en';
+
+console.log(`Checking locales in: ${LOCALES_DIR}`);
+console.log(`Primary locale: ${PRIMARY_LOCALE}`);

---

47-48: Consider checking for extra keys in locale files.

Currently, the script only checks for missing keys, but doesn't verify if the locale files contain unnecessary extra keys that don't exist in the primary locale.

    const missingKeys = Object.keys(primaryData).filter(key => !(key in localeData));
+    const extraKeys = Object.keys(localeData).filter(key => !(key in primaryData));
+    
+    if (extraKeys.length > 0) {
+        console.warn(`Extra keys in ${folder}/${file} (not in primary locale): ${JSON.stringify(extraKeys, null, 2)}`);
+        // Optionally set hasErrors = true if you want to treat extra keys as errors
+    }

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

scripts/checkLocales.js (3)

1-2: Disable ESLint rules with caution.

These ESLint disables suppress important code quality checks. Consider addressing the underlying formatting issues instead of disabling the rules entirely. If disabling is necessary, add a comment explaining why.

---

49-50: Consider checking for nested objects in locale files.

The current implementation only checks for top-level keys. Many locale files use nested structures, which this implementation won't validate correctly.

const missingKeys = Object.keys(primaryData).filter(key => !(key in localeData));

+ // Helper function to recursively check nested objects
+ const checkNestedObjects = (primary, locale, parentKey = '') => {
+   let nestedMissingKeys = [];
+   
+   Object.keys(primary).forEach(key => {
+     const currentKey = parentKey ? `${parentKey}.${key}` : key;
+     
+     if (typeof primary[key] === 'object' && primary[key] !== null && 
+         typeof locale[key] === 'object' && locale[key] !== null) {
+       // Recursively check nested objects
+       nestedMissingKeys = [...nestedMissingKeys, 
+         ...checkNestedObjects(primary[key], locale[key], currentKey)];
+     } else if (!(key in locale)) {
+       nestedMissingKeys.push(currentKey);
+     }
+   });
+   
+   return nestedMissingKeys;
+ };
+
+ // Check for nested missing keys
+ const nestedMissingKeys = checkNestedObjects(primaryData, localeData);
+ if (nestedMissingKeys.length > 0) {
+   console.error(`Missing nested keys in ${folder}/${file}: ${JSON.stringify(nestedMissingKeys, null, 2)}`);
+   hasErrors = true;
+ }

---

1-82: Consider adding additional validation features.

The script currently only checks for missing keys but doesn't validate other important aspects:

1. Keys in target locales that don't exist in the primary locale (potentially outdated)
2. Value type mismatches between locales (e.g., string vs. object)
3. Placeholder consistency (e.g., {name} exists in one locale but not another)

Would you like me to provide implementation suggestions for these additional validations?

🧰 Tools

🪛 Biome (1.9.4)

[error] 59-59: Expected a semicolon or an implicit semicolon after a statement, but found none

An explicit or implicit semicolon is expected here...

...Which is required to end this statement

(parse)

---

[error] 59-60: Expected a statement but instead found '}'.

Expected a statement here.

(parse)

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro