From 37734445e7235d1000d87e0c56851fbe7c8ee583 Mon Sep 17 00:00:00 2001
From: WarmUpTill
Date: Sat, 5 Mar 2022 20:38:22 +0100
Subject: [PATCH] CI: Add automated check for invalid locale files
Also clean up issues found in the existing locale files
---
.github/workflows/locale-check.yml | 14 +++++
CI/checkLocale.py | 93 ++++++++++++++++++++++++++++++
data/locale/de-DE.ini | 1 -
data/locale/en-US.ini | 1 -
data/locale/ru-RU.ini | 12 ----
data/locale/tr-TR.ini | 5 --
data/locale/zh-CN.ini | 14 +----
7 files changed, 108 insertions(+), 32 deletions(-)
create mode 100644 .github/workflows/locale-check.yml
create mode 100644 CI/checkLocale.py
diff --git a/.github/workflows/locale-check.yml b/.github/workflows/locale-check.yml
new file mode 100644
index 00000000..1fec72a8
--- /dev/null
+++ b/.github/workflows/locale-check.yml
@@ -0,0 +1,14 @@
+name: Check locale
+
+on: [push, pull_request]
+
+jobs:
+ ubuntu64:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+
+ - name: Check locale files
+ run: |
+ python3 ./CI/checkLocale.py -p data/locale/
diff --git a/CI/checkLocale.py b/CI/checkLocale.py
new file mode 100644
index 00000000..e6792157
--- /dev/null
+++ b/CI/checkLocale.py
@@ -0,0 +1,93 @@
+#!/usr/bin/env python3
+
+import os
+import sys
+import argparse
+
+defaultLocaleFile = "en-US.ini"
+
+
+class localeEntry:
+ locale = ""
+ placeholders = []
+
+ def __init__(self, locale, widgets) -> None:
+ self.locale = locale
+ self.placeholders = widgets
+
+
+def getNonDefaultLocales(dir):
+ files = []
+ for filename in os.listdir(dir):
+ f = os.path.join(dir, filename)
+ if os.path.isfile(f) and not f.endswith(defaultLocaleFile):
+ files.append(f)
+ return files
+
+
+def getAllLocaleEntriesWithWidgetPlaceholders(file):
+ localeEntries = []
+ with open(file, 'r', encoding='UTF-8') as f:
+ for line in f.readlines():
+ widgetPlaceholders = []
+ for word in line.split("{{"):
+ if not "}}" in word:
+ continue
+ word = "{{" + word[:word.rfind("}}")] + "}}"
+ widgetPlaceholders.append(word)
+ localeEntries.append(localeEntry(
+ line.split("=")[0], widgetPlaceholders))
+ return localeEntries
+
+
+def getLocaleEntryFrom(entry, list):
+ for element in list:
+ if element.locale == entry.locale:
+ return element
+ return None
+
+
+def checkWidgetPlacehodlers(file, expectedPlaceholders):
+ localeEntries = getAllLocaleEntriesWithWidgetPlaceholders(file)
+ result = True
+ for localeEntry in localeEntries:
+ expectedEntry = getLocaleEntryFrom(localeEntry, expectedPlaceholders)
+ if expectedEntry is None:
+ print(
+ "WARNING: Locale entry \"{}\" from \"{}\" not found in \"{}\"".format(localeEntry.locale, file, defaultLocaleFile))
+ continue
+ for p in localeEntry.placeholders:
+ if p not in expectedEntry.placeholders:
+ print("WARNING: Locale entry \"{}\" from \"{}\" does contain \"{}\" while \"{}\" does not".format(
+ localeEntry.locale, file, p, defaultLocaleFile))
+ for p in expectedEntry.placeholders:
+ if p not in localeEntry.placeholders:
+ result = False
+ print("ERROR: Locale entry \"{}\" from \"{}\" does not contain \"{}\"".format(
+ localeEntry.locale, file, p))
+ return result
+
+
+def main():
+ parser = argparse.ArgumentParser(
+ description='Checks for inconsistencies regarding widget placeholders in the different locale files.')
+ parser.add_argument(
+ '-p', '--path', help='Path to locale folder', required=True)
+ args = parser.parse_args()
+
+ placeholders = getAllLocaleEntriesWithWidgetPlaceholders(
+ os.path.join(args.path, defaultLocaleFile))
+ nonDefaultLocales = getNonDefaultLocales(args.path)
+
+ result = True
+ for f in nonDefaultLocales:
+ if checkWidgetPlacehodlers(f, placeholders) == False:
+ result = False
+ if result == False:
+ sys.exit(1)
+ print("SUCCESS: No issues found!")
+ sys.exit(0)
+
+
+if __name__ == "__main__":
+ main()
diff --git a/data/locale/de-DE.ini b/data/locale/de-DE.ini
index 699041e5..27c93444 100644
--- a/data/locale/de-DE.ini
+++ b/data/locale/de-DE.ini
@@ -223,7 +223,6 @@ AdvSceneSwitcher.videoTab.help="Dieser Tab ermöglicht es
; Network Tab
AdvSceneSwitcher.networkTab.title="Netzwerk"
AdvSceneSwitcher.networkTab.warning="Die Verwendung des Servers außerhalb eines lokalen Netzwerks kann dazu führen, dass die aktive Szene von dritten Personen ausgelesen werden kann."
-AdvSceneSwitcher.networkTab.Disabledwarning="Diese Funktionalität musste unter macOS leider aufgrund von Bibliotheksinkompatibilitäten mit dem obs-websocket plugin deaktiviert werden."
AdvSceneSwitcher.networkTab.server="Server starten (Sendet Szenenwechselnachrichten zu allen verbundenen Clients)"
AdvSceneSwitcher.networkTab.server.port="Port"
AdvSceneSwitcher.networkTab.server.lockToIPv4="Nur IPv4 verwenden (deaktiviert IPv6)"
diff --git a/data/locale/en-US.ini b/data/locale/en-US.ini
index d609f9c2..6af59ece 100644
--- a/data/locale/en-US.ini
+++ b/data/locale/en-US.ini
@@ -627,7 +627,6 @@ AdvSceneSwitcher.videoTab.help="