ci/translations: Add a linter to check for invalid characters, fix current issues (#2774)

scripts/ci/lint-characters.py

@@ -0,0 +1,109 @@
+import glob
+import json
+import re
+
+# TODO - add a way to make this auto replace bad characters with `?`
+
+# fmt: off
+JAK1_ALLOWED_CHARACTERS = [
+    "a", "b", "c", "d", "e", "f", "g", "h", "i", "j", "k", "l", "m", "n", "o", "p", "q", "r", "s", "t", "u", "v", "w", "x", "y", "z",
+    "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z",
+    "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
+    "'", "!", "(", ")", "+", "-", ",", ".", "/", ":", "=", "<", ">", "*", "%", "?", "\"",
+    "`", "ˇ", "¨", "º", "¡", "¿", "Æ", "Ç", "ß", "™", "、", " ", "Å", "Ø",
+    "Ñ", "Ã", "Õ", "Á", "É", "Í", "Ó", "Ú", "Ő", "Ű", "Â", "Ê", "Î", "Ô", "Û", "À", "È", "Ì", "Ò", "Ù", "Ä", "Ë", "Ï", "Ö", "ö", "Ü",
+    "海", "界", "学", "ワ", "ヲ", "ン", "岩", "旧", "空", "ヮ", "撃", "賢", "湖", "口", "行", "合", "士", "寺", "山", "者", "所", "書", "小", "沼", "上", "城", "場", "出", "闇", "遺", "黄", "屋", "下", "家", "火", "花", "レ", "Œ", "ロ", "青", "・", "゛", "゜", "ー", "『", "』", "宝", "石", "赤", "跡", "川", "戦", "村", "隊", "台", "長", "鳥", "艇", "洞", "道", "発", "飛", "噴", "池", "中", "塔", "島", "部", "砲", "産", "眷", "力", "緑", "岸", "像", "谷", "心", "森", "水", "船", "世",
+    "ぁ", "あ", "ぃ", "い", "ぅ", "う", "ぇ", "え", "ぉ", "お", "か", "き", "く", "け", "こ", "さ", "し", "す", "せ", "そ", "た", "ち", "っ", "つ", "て", "と", "な", "に", "ぬ", "ね", "の", "は", "ひ", "ふ", "へ", "ほ", "ま", "み", "む", "め", "も", "ゃ", "や", "ゅ", "ゆ", "ょ", "よ", "ら", "り", "る", "れ", "ろ", "ゎ", "わ", "を", "ん",
+    "が", "ぎ", "ぐ", "げ", "ご", "ざ", "じ", "ず", "ぜ", "ぞ", "だ", "ぢ", "づ", "で", "ど", "ば", "び", "ぶ", "べ", "ぼ",
+    "ぱ", "ぴ", "ぷ", "ぺ", "ぽ",
+    "ァ", "ア", "ィ", "イ", "ゥ", "ウ", "ェ", "エ", "ォ", "オ", "カ", "キ", "ク", "ケ", "コ", "サ", "シ", "ス", "セ", "ソ", "タ", "チ", "ッ", "ツ", "テ", "ト", "ナ", "ニ", "ヌ", "ネ", "ノ", "ハ", "ヒ", "フ", "ヘ", "ホ", "マ", "ミ", "ム", "メ", "モ", "ャ", "ヤ", "ュ", "ユ", "ョ", "ヨ", "ラ", "リ", "ル",
+    "ヴ", "ガ", "ギ", "グ", "ゲ", "ゴ", "ザ", "ジ", "ズ", "ゼ", "ゾ", "ダ", "ヂ", "ヅ", "デ", "ド", "バ", "ビ", "ブ", "ベ", "ボ",
+    "パ", "ピ", "プ", "ペ", "ポ",
+    "~"
+]
+
+JAK1_ALLOWED_CODES = [
+    "<TIL>",
+    "<PAD_X>", "<PAD_TRIANGLE>", "<PAD_CIRCLE>", "<PAD_SQUARE>"
+]
+# fmt: on
+
+invalid_characters_found = False
+
+
+def is_allowed_code(pos, text):
+    # Find any occurences of allowed codes in the string
+    # if the position overlaps with these occurrences, it's allowed
+    for code in JAK1_ALLOWED_CODES:
+        for match in re.finditer(code, text):
+            if pos >= match.start() and pos <= match.end():
+                return match.end()
+    return -1
+
+
+def char_allowed(char):
+    return char in JAK1_ALLOWED_CHARACTERS
+
+
+def lint_jak1_characters(text):
+    invalid_characters_found = False
+    pos = 0
+    while pos < len(text):
+        character = text[pos]
+        if not char_allowed(character):
+            # Check to see if it's an allowed code
+            code_end_pos = is_allowed_code(pos, text)
+            if code_end_pos == -1:
+                print(
+                    "Character '{}' not allowed - Found in {}".format(character, text)
+                )
+                invalid_characters_found = True
+                pos = pos + 1
+            else:
+                # advance to the end of the code and continue checking
+                pos = code_end_pos
+        else:
+            pos = pos + 1
+    return invalid_characters_found
+
+
+# Iterate through the translations making sure there are no characters that are not allowed
+text_files = glob.glob("./game/assets/jak1/text/*.json")
+
+for text_file in text_files:
+    print("Checking {}...".format(text_file))
+    with open(text_file, encoding="utf-8") as f:
+        file_data = json.load(f)
+    for id, text in file_data.items():
+        invalid_chars_exist = lint_jak1_characters(text)
+        if invalid_chars_exist:
+            invalid_characters_found = True
+
+subtitle_files = glob.glob("./game/assets/jak1/subtitle/*lines*.json")
+
+for subtitle_file in subtitle_files:
+    print("Checking {}...".format(subtitle_file))
+    with open(subtitle_file, encoding="utf-8") as f:
+        file_data = json.load(f)
+    # Check Speakers
+    for id, text in file_data["speakers"].items():
+        invalid_chars_exist = lint_jak1_characters(text)
+        if invalid_chars_exist:
+            invalid_characters_found = True
+    # Check Lines
+    for id, lines in file_data["cutscenes"].items():
+        for line in lines:
+            invalid_chars_exist = lint_jak1_characters(line)
+            if invalid_chars_exist:
+                invalid_characters_found = True
+    for id, lines in file_data["hints"].items():
+        for line in lines:
+            invalid_chars_exist = lint_jak1_characters(line)
+            if invalid_chars_exist:
+                invalid_characters_found = True
+
+if invalid_characters_found:
+    print("Invalid characters were found, see above")
+    exit(1)
+else:
+    print("No invalid characters found!")