add translation checker

Author: felixevers

.github/workflows/ci.yaml

@@ -14,6 +14,7 @@ jobs:
             - uses: actions/checkout@v4
             - uses: actions/setup-node@v4
             - uses: bahmutov/npm-install@v1
+            - run: npm run check-translations
             - run: npm run build-keycloak-theme
 
     check_if_version_upgraded:

package.json

@@ -11,6 +11,7 @@
     "dev": "vite",
     "storybook": "storybook dev -p 6006",
     "build-intl": "npx --package=@helpwave/internationalization build-intl --force -i ./locales -o ./src/i18n/translations.ts -n helpwaveIdTranslation",
+    "check-translations": "node scripts/check-translation-keys.mjs",
     "build": "npm run build-intl && tsc && vite build",
     "build-keycloak-theme": "npm run build && keycloakify build",
     "build-storybook": "storybook build",

scripts/check-translation-keys.mjs

@@ -0,0 +1,102 @@
+import fs from 'fs'
+import path from 'path'
+import { fileURLToPath } from 'url'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+const projectRoot = path.resolve(__dirname, '..')
+const localesDir = path.join(projectRoot, 'locales')
+const srcDir = path.join(projectRoot, 'src')
+
+const T_CALL_RE = /\bt\s*\(\s*['"]([^'"]+)['"]/g
+
+function loadArbKeys(filePath) {
+    const raw = fs.readFileSync(filePath, 'utf8')
+    const json = JSON.parse(raw)
+    return new Set(
+        Object.keys(json).filter(
+            (k) => !k.startsWith('@') && k !== '@@locale'
+        )
+    )
+}
+
+function allArbFiles() {
+    const names = fs.readdirSync(localesDir)
+    return names
+        .filter((n) => n.endsWith('.arb') && !n.includes('/'))
+        .map((n) => path.join(localesDir, n))
+}
+
+function collectKeysFromSource(dir, keys = new Set()) {
+    if (!fs.existsSync(dir) || !fs.statSync(dir).isDirectory()) {
+        return keys
+    }
+    const entries = fs.readdirSync(dir, { withFileTypes: true })
+    for (const e of entries) {
+        const full = path.join(dir, e.name)
+        if (e.name === 'node_modules' || e.name === 'translations.ts') continue
+        if (e.isDirectory()) {
+            collectKeysFromSource(full, keys)
+            continue
+        }
+        if (!/\.(tsx?|jsx?|mjs|cjs)$/.test(e.name)) continue
+        const content = fs.readFileSync(full, 'utf8')
+        let m
+        T_CALL_RE.lastIndex = 0
+        while ((m = T_CALL_RE.exec(content)) !== null) {
+            keys.add(m[1])
+        }
+    }
+    return keys
+}
+
+function main() {
+    const usedKeys = collectKeysFromSource(srcDir)
+
+    const arbPaths = allArbFiles()
+    if (arbPaths.length === 0) {
+        console.error('No ARB files found in', localesDir)
+        process.exit(1)
+    }
+
+    const localeKeys = new Map()
+    for (const p of arbPaths) {
+        const locale = path.basename(p, '.arb')
+        localeKeys.set(locale, loadArbKeys(p))
+    }
+
+    const allLocales = [...localeKeys.keys()]
+    const missing = []
+    for (const key of usedKeys) {
+        for (const locale of allLocales) {
+            if (!localeKeys.get(locale).has(key)) {
+                missing.push({ key, locale })
+            }
+        }
+    }
+
+    if (missing.length > 0) {
+        console.error('Missing translation keys (used in code but not in ARB):\n')
+        const byKey = new Map()
+        for (const { key, locale } of missing) {
+            if (!byKey.has(key)) byKey.set(key, [])
+            byKey.get(key).push(locale)
+        }
+        for (const [key, locales] of byKey) {
+            console.error(`  [${key}] missing in: ${locales.join(', ')}`)
+        }
+        process.exit(1)
+    }
+
+    const arbKeySet = localeKeys.get(allLocales[0])
+    const unused = [...arbKeySet].filter((k) => !usedKeys.has(k))
+    if (unused.length > 0) {
+        console.warn('Unused keys in ARB (present in locale but not found in src):')
+        for (const k of unused.sort()) {
+            console.warn(`  ${k}`)
+        }
+    }
+
+    console.log('All translation keys used in code exist in every locale.')
+}
+
+main()