Add translation completeness lint (apache#51166)

Author: guan404ming

airflow-core/src/airflow/ui/eslint.config.js

@@ -21,6 +21,7 @@
  * @import { FlatConfig } from "@typescript-eslint/utils/ts-eslint";
  */
 import { coreRules } from "./rules/core.js";
+import { i18nRules } from "./rules/i18n.js";
 import { i18nextRules } from "./rules/i18next.js";
 import { perfectionistRules } from "./rules/perfectionist.js";
 import { prettierRules } from "./rules/prettier.js";
@@ -46,4 +47,5 @@ export default /** @type {const} @satisfies {ReadonlyArray<FlatConfig.Config>} *
   stylisticRules,
   unicornRules,
   i18nextRules,
+  i18nRules,
 ]);

airflow-core/src/airflow/ui/rules/i18n.js

@@ -0,0 +1,167 @@
+/*!
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
+
+/* eslint-disable @typescript-eslint/no-unsafe-assignment */
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+export const i18nNamespace = "i18n";
+
+/**
+ * Extract all nested keys from translation object
+ * @param {Record<string, any>} obj
+ * @param {string} [prefix]
+ * @returns {string[]}
+ */
+const getKeys = (obj, prefix = "") => {
+  if (Array.isArray(obj)) {
+    return [];
+  }
+
+  return Object.keys(obj).flatMap((key) => {
+    const newPrefix = prefix ? `${prefix}.${key}` : key;
+    const value = obj[key];
+
+    if (typeof value === "object" && value !== null && !Array.isArray(value)) {
+      return [newPrefix, ...getKeys(value, newPrefix)];
+    }
+
+    return [newPrefix];
+  });
+};
+
+// Path to locales directory
+const localesDir = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "../src/i18n/locales");
+
+// Default language (English) as reference
+const defaultLanguage = "en";
+const defaultLanguageKeys = /** @type {Record<string, string[]>} */ ({});
+const defaultLanguageDir = path.join(localesDir, defaultLanguage);
+
+// Load translation keys from default language files
+fs.readdirSync(defaultLanguageDir)
+  .filter((file) => file.endsWith(".json"))
+  .forEach((jsonFile) => {
+    const ns = path.basename(jsonFile, ".json");
+    const filePath = path.join(defaultLanguageDir, jsonFile);
+    const fileContent = fs.readFileSync(filePath, "utf8");
+    const parsedJson = JSON.parse(fileContent);
+
+    if (typeof parsedJson === "object" && parsedJson !== null && !Array.isArray(parsedJson)) {
+      defaultLanguageKeys[ns] = getKeys(parsedJson);
+    }
+  });
+
+export const i18nPlugin = {
+  files: ["**/i18n/locales/**/*.json"],
+  rules: {
+    "check-translation-completeness": {
+      /** @param {import('@typescript-eslint/utils').TSESLint.RuleContext<'missingKeys' | 'fileError', []>} context */
+      create(context) {
+        return {
+          /** @param {import('@typescript-eslint/utils').TSESTree.Program} node */
+          Program(node) {
+            // Get language code and namespace from file path
+            const currentFilePath = context.filename;
+            const langCode = path.dirname(path.relative(localesDir, currentFilePath));
+            const namespace = path.basename(currentFilePath, ".json");
+
+            if (langCode === defaultLanguage) {
+              return;
+            }
+
+            // Get keys from current file
+            const referenceKeys = defaultLanguageKeys[namespace];
+            let langKeys;
+
+            try {
+              const parsedLangJson = JSON.parse(context.sourceCode.text);
+
+              if (
+                typeof parsedLangJson === "object" &&
+                parsedLangJson !== null &&
+                !Array.isArray(parsedLangJson)
+              ) {
+                langKeys = getKeys(parsedLangJson);
+              } else {
+                context.report({
+                  data: { error: "Invalid JSON object.", filePath: currentFilePath },
+                  messageId: "fileError",
+                  node,
+                });
+
+                return;
+              }
+            } catch (error) {
+              const message = error instanceof Error ? error.message : String(error);
+
+              context.report({
+                data: { error: message, filePath: currentFilePath },
+                messageId: "fileError",
+                node,
+              });
+
+              return;
+            }
+
+            // Check for missing translations
+            const langKeysSet = new Set(langKeys);
+            const missingKeys = referenceKeys.filter((key) => !langKeysSet.has(key));
+
+            if (missingKeys.length > 0) {
+              context.report({
+                data: { keys: missingKeys.join(", "), lang: langCode, namespace },
+                messageId: "missingKeys",
+                node,
+              });
+            }
+          },
+        };
+      },
+      meta: {
+        docs: {
+          category: "Best Practices",
+          description: "Ensures non-default lang files have all keys from default.",
+          recommended: "warn",
+        },
+        messages: {
+          fileError: "Failed to read/parse {{filePath}}. Error: {{error}}",
+          missingKeys: "Lang '{{lang}}' (namespace: {{namespace}}) missing keys: {{keys}}",
+        },
+        type: "problem",
+      },
+    },
+  },
+};
+
+/** @type {import("@typescript-eslint/utils/ts-eslint").FlatConfig.Config} */
+export const i18nRules = {
+  files: ["**/i18n/locales/**/*.json"],
+  plugins: {
+    [i18nNamespace]: i18nPlugin,
+  },
+  rules: {
+    "@typescript-eslint/no-unused-expressions": "off",
+    [`${i18nNamespace}/check-translation-completeness`]: "warn",
+    "no-unused-expressions": "off",
+  },
+};

airflow-core/src/airflow/ui/src/i18n/locales/de/common.json

@@ -1,92 +1,92 @@
 {
+  "admin": {
+    "Config": "Konfiguration",
+    "Connections": "Verbindungen",
+    "Plugins": "Plug-ins",
+    "Pools": "Pools",
+    "Providers": "Providers",
+    "Variables": "Variablen"
+  },
+  "assetEvent_one": "Ereignis zu Datensets (Asset)",
+  "assetEvent_other": "Ereignisse zu Datensets (Asset)",
+  "browse": {
+    "auditLog": "Prüf-Log",
+    "xcoms": "Task Kommunikation (XComs)"
+  },
+  "dagRun_one": "Dag Lauf",
+  "dagRun_other": "Dag Läufe",
   "defaultToGraphView": "Graph-Ansicht als Standard",
   "defaultToGridView": "Gitter-Ansicht als Standard",
+  "docs": {
+    "documentation": "Dokumentation",
+    "githubRepo": "GitHub Ablage",
+    "restApiReference": "REST API Referenz"
+  },
   "logout": "Abmelden",
   "logoutConfirmation": "Sie sind dabei sich von dem System abzumelden.",
-  "switchToDarkMode": "Zum Dunkelmodus wechseln",
-  "switchToLightMode": "Zum Hellmodus wechseln",
-  "timezone": "Zeitzone",
-  "user": "Benutzer",
-  "selectLanguage": "Sprache wählen",
+  "modal": {
+    "cancel": "Abbrechen",
+    "confirm": "Bestätigen"
+  },
   "nav": {
-    "home": "Start",
+    "admin": "Verwaltung",
     "assets": "Datensets (Assets)",
     "browse": "Browsen",
-    "admin": "Verwaltung",
-    "security": "Sicherheit",
     "docs": "Doku",
-    "plugins": "Plug-ins"
-  },
-  "browse": {
-    "auditLog": "Prüf-Log",
-    "xcoms": "Task Kommunikation (XComs)"
+    "home": "Start",
+    "plugins": "Plug-ins",
+    "security": "Sicherheit"
   },
-  "admin": {
-    "Variables": "Variablen",
-    "Pools": "Pools",
-    "Providers": "Providers",
-    "Plugins": "Plug-ins",
-    "Connections": "Verbindungen",
-    "Config": "Konfiguration"
+  "pools": {
+    "deferred": "Delegiert",
+    "open": "Frei",
+    "pools_one": "Pool",
+    "pools_other": "Pools",
+    "queued": "Wartend",
+    "running": "Laufend",
+    "scheduled": "Geplant"
   },
   "security": {
-    "users": "Benutzer",
-    "roles": "Rollen",
     "actions": "Aktionen",
+    "permissions": "Berechtigungen",
     "resources": "Ressourcen",
-    "permissions": "Berechtigungen"
-  },
-  "timeRange": {
-    "duration": "Laufzeit",
-    "lastHour": "Letzte Stunde",
-    "last12Hours": "Letzte 12 Stunden",
-    "last24Hours": "Letzte 24 Stunden",
-    "pastWeek": "Letzte Woche"
-  },
-  "docs": {
-    "documentation": "Dokumentation",
-    "githubRepo": "GitHub Ablage",
-    "restApiReference": "REST API Referenz"
+    "roles": "Rollen",
+    "users": "Benutzer"
   },
+  "selectLanguage": "Sprache wählen",
   "states": {
-    "queued": "Wartend",
-    "running": "Laufend",
-    "success": "Erfolgreich",
+    "deferred": "Delegiert",
     "failed": "Fehlgeschlagen",
-    "skipped": "Übersprungen",
+    "no_status": "Kein Status",
+    "queued": "Wartend",
     "removed": "Entfernt",
-    "scheduled": "Geplant",
     "restarting": "Im Neustart",
-    "up_for_retry": "Wartet auf neuen Versuch",
+    "running": "Laufend",
+    "scheduled": "Geplant",
+    "skipped": "Übersprungen",
+    "success": "Erfolgreich",
     "up_for_reschedule": "Wartet auf Neuplanung",
-    "upstream_failed": "Vorgelagerte fehlgeschlagen",
-    "deferred": "Delegiert",
-    "no_status": "Kein Status"
+    "up_for_retry": "Wartet auf neuen Versuch",
+    "upstream_failed": "Vorgelagerte fehlgeschlagen"
   },
-  "dagRun_one": "Dag Lauf",
-  "dagRun_other": "Dag Läufe",
+  "switchToDarkMode": "Zum Dunkelmodus wechseln",
+  "switchToLightMode": "Zum Hellmodus wechseln",
   "taskInstance_one": "Task Instanz",
   "taskInstance_other": "Task Instanzen",
-  "assetEvent_one": "Ereignis zu Datensets (Asset)",
-  "assetEvent_other": "Ereignisse zu Datensets (Asset)",
-  "triggered": "Angestoßen",
-  "pools": {
-    "open": "Frei",
-    "running": "Laufend",
-    "queued": "Wartend",
-    "scheduled": "Geplant",
-    "deferred": "Delegiert",
-    "pools_one": "Pool",
-    "pools_other": "Pools"
-  },
-  "modal": {
-    "cancel": "Abbrechen",
-    "confirm": "Bestätigen"
+  "timeRange": {
+    "duration": "Laufzeit",
+    "last12Hours": "Letzte 12 Stunden",
+    "last24Hours": "Letzte 24 Stunden",
+    "lastHour": "Letzte Stunde",
+    "pastWeek": "Letzte Woche"
   },
+  "timezone": "Zeitzone",
   "timezoneModal": {
-    "title": "Auswahl der Zeitzone",
-    "placeholder": "Wählen Sie eine Zeitzone",
     "current-timezone": "Aktuelle Zeit in",
+    "placeholder": "Wählen Sie eine Zeitzone",
+    "title": "Auswahl der Zeitzone",
     "utc": "UTC (Koordinierte Weltzeit)"
-  }
+  },
+  "triggered": "Angestoßen",
+  "user": "Benutzer"
 }

airflow-core/src/airflow/ui/src/i18n/locales/de/dashboard.json

@@ -1,38 +1,38 @@
 {
-  "welcome": "Willkommen",
-  "stats": {
-    "stats": "Statistiken",
-    "failedDags": "Fehlgeschlagene Dags",
-    "runningDags": "Laufende Dags",
-    "activeDags": "Aktive Dags",
-    "queuedDags": "Dags in Warteschlange"
-  },
+  "group": "Gruppe",
   "health": {
+    "dagProcessor": "Dag Prozessor",
     "health": "System-Gesundheit",
+    "healthy": "Gut",
+    "lastHeartbeat": "Letztes Lebenszeichen",
     "metaDatabase": "Meta-Datenbank",
     "scheduler": "Planer",
-    "triggerer": "Triggerer",
-    "dagProcessor": "Dag Prozessor",
     "status": "Status",
-    "lastHeartbeat": "Letztes Lebenszeichen",
-    "healthy": "Gut",
+    "triggerer": "Triggerer",
     "unhealthy": "Nicht in Ordnung"
   },
+  "history": "Historie",
   "importErrors": {
-    "searchByFile": "Nach Datei suchen",
     "dagImportError_one": "Fehler beim Laden des Dags",
     "dagImportError_other": "Fehler beim Laden der Dags",
+    "searchByFile": "Nach Datei suchen",
     "timestamp": "Zeitstempel"
   },
-  "poolSlots": "Pool Belegung",
   "managePools": "Pools verwalten",
-  "history": "Historie",
+  "noAssetEvents": "Keine Ereignisse zu Datensets vorliegend.",
+  "poolSlots": "Pool Belegung",
   "sortBy": {
     "newestFirst": "Neueste zuerst",
     "oldestFirst": "Älteste zuerst"
   },
   "source": "Quellcode",
-  "group": "Gruppe",
+  "stats": {
+    "activeDags": "Aktive Dags",
+    "failedDags": "Fehlgeschlagene Dags",
+    "queuedDags": "Dags in Warteschlange",
+    "runningDags": "Laufende Dags",
+    "stats": "Statistiken"
+  },
   "uri": "Uri",
-  "noAssetEvents": "Keine Ereignisse zu Datensets vorliegend."
+  "welcome": "Willkommen"
 }