ci: add GitHub Actions workflow for backend i18n checking

.github/workflows/backend-i18n-check.yml

@@ -0,0 +1,38 @@
+name: Backend I18n Check
+
+on:
+  push:
+    branches:
+      - '**' # on all branches
+
+jobs:
+  run-checker:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Step 1: check repo code
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      # Step 2: set python environment
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9' # set python version
+
+      # Step 3: execute python script
+      - name: Run backend_i18n_checker.py
+        id: run_checker
+        run: |
+          cd check && python backend_i18n_checker.py > ../output.log
+
+      # Step 4: verify output is "No Problem"
+      - name: Verify Output
+        run: |
+          FIRST_LINE=$(head -n 1 output.log)
+          LAST_LINE=$(tail -n 1 output.log)
+          if [[ "$LAST_LINE" != "No Problem" ]]; then
+            echo "❌ $FIRST_LINE"
+            exit 1
+          fi
+        shell: bash

check/backend_i18n_checker.py

@@ -0,0 +1,122 @@
+import os
+import re
+import json
+
+# i18n JSON
+TRANSLATION_FILE_PATH = "../backend/terminal/src/main/resources/locales/en_US.json"
+
+# search dir
+SEARCH_DIR = "../backend/terminal/src"
+# ignore dirs
+IGNORE_DIRS = ['test']
+
+# To store all extracted keys for comparison later
+extracted_keys = set()
+
+def load_translations(file_path):
+    """
+    Load the i18n JSON file and return a collection of keys.
+    :param file_path: i18n JSON file path
+    :return: collection containing all i18n keys
+    """
+    try:
+        with open(file_path, "r", encoding="utf-8") as f:
+            translations = json.load(f)
+            jsonKeySets = set(translations.keys())
+            # Reset file pointer
+            f.seek(0)
+            # Count the number of lines
+            line_count = sum(1 for _ in f)
+            if len(jsonKeySets) != line_count - 2:
+                print(f"Error: Duplicate keys at {file_path}.")
+                exit(1)
+        return jsonKeySets
+    except FileNotFoundError:
+        print(f"Error: Translation file not found at {file_path}.")
+        exit(1)
+    except json.JSONDecodeError as e:
+        print(f"Error: Invalid JSON format in translation file. {e}")
+        exit(1)
+
+def get_all_files(directory, extensions, ignore_dirs=[]):
+    """
+    Retrieve all files in the specified directory and its subdirectories that match the extension, and support ignoring the specified folder.
+    :param directory: Root directory to search for
+    :param extensions: List of file extensions that need to be filtered
+    :param ignore_dirs: List of folder names to ignore
+    :return: List of file paths that need to be checked
+    """
+    matched_files = []
+    for root, dirs, files in os.walk(directory):  # loop the directory
+        # Filter folders to ignore
+        dirs[:] = [d for d in dirs if d not in ignore_dirs]
+        for file in files:
+            if any(file.endswith(ext) for ext in extensions):
+                matched_files.append(os.path.join(root, file))
+    return matched_files
+
+def process_file_line_by_line(file_path, translation_keys):
+    """
+    Process files by line, check for unpacked Chinese and keys that do not exist in the i18n JSON file.
+    :param file_path: file path
+    :param translation_keys: Key set in i18n JSON file
+    """
+    issues = []
+
+    # Match any content within double or single quotes
+    quoted_pattern = re.compile(r"['\"]([^'\"]*?)['\"]")
+    # Match Chinese
+    chinese_pattern = re.compile(r"[\u4e00-\u9fff]")
+    # Match comments
+    comment_pattern = re.compile(r"(//.*?$|/\*.*?\*/|<!--.*?-->)", re.DOTALL | re.MULTILINE)
+
+    with open(file_path, "r", encoding="utf-8") as f:
+        for line_num, line in enumerate(f, start=1):
+            # Remove comments
+            line_no_comments = re.sub(comment_pattern, "", line)
+
+            # Get all content in quotes
+            quoted_matches = quoted_pattern.findall(line_no_comments)
+
+            # Filter quoted containing Chinese characters
+            filtered_matches = [match for match in quoted_matches if chinese_pattern.search(match)]
+
+            # Verify if packed contents exist in i18n JSON file
+            for key in filtered_matches:
+                extracted_keys.add(key)  # Collect the key
+                if key not in translation_keys:
+                    issues.append(f"{file_path}:{line_num} Not in i18n JSON: {key}")
+
+    return issues
+
+def process_files():
+    """
+    Process files in the current directory and subdirectories, check for Chinese characters that have not been wrapped and keys that do not exist in the i18n JSON file.
+    """
+    extensions = [".java"]
+    files = get_all_files(SEARCH_DIR, extensions, IGNORE_DIRS)
+
+    # Load i18n JSON file
+    translation_keys = load_translations(TRANSLATION_FILE_PATH)
+
+    all_issues = []
+
+    for file in files:
+        issues = process_file_line_by_line(file, translation_keys)
+        all_issues.extend(issues)
+
+    if len(extracted_keys) < len(translation_keys):
+        all_issues.append(
+            f"Key mismatch: {len(extracted_keys)} keys found in files, "
+            f"but {len(translation_keys)} keys exist in the i18n JSON file.")
+
+    if all_issues:
+        print("Issues Found: " + str(len(all_issues)))
+        for issue in all_issues:
+            print(issue)
+        exit(1)  # Exit with error code for CI/CD pipeline
+    else:
+        print("No Problem")  # Clear output for GitHub Actions success
+
+if __name__ == "__main__":
+    process_files()