Files
External-Item-Descriptions/.github/scripts/localizationChecker.py
T

184 lines
7.3 KiB
Python

import lupa.lua54 as lupa
from lupa.lua54 import LuaRuntime
from pathlib import Path
lua = LuaRuntime(unpack_returned_tuples=True)
import glob, os
SCRIPT_PATH = os.path.realpath(__file__)
SOURCE_MOD_DIRECTORY = os.path.dirname(SCRIPT_PATH)+"/../.."
ONLY_DO_LANGUAGE = ""
if "GITHUB_WORKSPACE" in os.environ:
SOURCE_MOD_DIRECTORY = os.environ["GITHUB_WORKSPACE"]
# Reset
Color_Off='\033[0m' # Text Reset
# Regular Colors
Black='\033[0;30m' # Black
Red='\033[0;31m' # Red
Green='\033[0;32m' # Green
Yellow='\033[0;33m' # Yellow
Blue='\033[0;34m' # Blue
Purple='\033[0;35m' # Purple
Cyan='\033[0;36m' # Cyan
White='\033[0;37m' # White
BWhite='\033[1;37m' # Bold White
ignoreNodesWithName = {"fonts"}
ignoreTypeMissmatchNodesWithName = {"ConditionalDescs", "BFFSSynergies"}
dlcs = ["ab+", "rep", "rep+"]
maxChecklimit = {"tarotClothBuffs": 2, "carBattery": 2, "BFFSSynergies": 2}
# count en_us entries for stats
def count_entries(t):
count = 0
for k in t:
count += 1
if lupa.lua_type(t[k]) == "table":
count += count_entries(t[k])
return count
def getMaxCheckLimit(parentName):
for entry in maxChecklimit:
if entry in parentName:
return maxChecklimit[entry]
return float('inf')
def addUpdatedTables(languageCode, dlc):
if dlc != "ab+":
# Add language table
lua.execute('EID.descriptions["'+languageCode+'"] = {}')
# Add all tables that are assumed to exist already in ab+
updatedTables = ["collectibles", "trinkets"]
if dlc == "rep":
updatedTables += ["cards", "pills", "carBattery", "BFFSSynergies", "CharacterInfo", "ConditionalDescs", "VoidNames", "custom"]
# korean uses some additional addititve tables
if languageCode == "ko_kr":
if dlc == "rep":
updatedTables += ["dice", "MCM"]
else:
updatedTables += ["bookOfVirtuesWisps"]
for table in updatedTables:
lua.execute('EID.descriptions["'+languageCode+'"].'+table+' = {}')
# find entries in table2 that are missing or different than in table 1
def compare_tables(table1, table2, prev_key):
errorCount = 0
checkLimit = getMaxCheckLimit(prev_key)
for k in table1:
checkLimit -= 1
if k in ignoreNodesWithName or checkLimit < 0:
# dont evaluate nodes that are listed in this table
continue
if k not in table2:
print(f"\tTable '{prev_key}' does not contain entry: {k}")
errorCount += 1
# table is missing. add all missing entries as error
if lupa.lua_type(table1[k]) == "table":
errorCount += count_entries(table1[k])
elif lupa.lua_type(table2[k]) != lupa.lua_type(table1[k]):
if lupa.lua_type(table1[k]) == "table" and len(table1[k]) == 1:
# ignore missmatch, if comparing table with 1 entry to a single string
continue
if lupa.lua_type(table2[k]) == "table" and len(table2[k]) == 1:
# ignore missmatch, if comparing table with 1 entry to a single string
continue
# Ignore if node is inside a table to ignore this type of error
ignoreError = False
for ignoreNode in ignoreTypeMissmatchNodesWithName:
if ignoreNode in prev_key:
ignoreError = True
break
if not ignoreError:
print(f"\tType mismatch in table '{prev_key}', key: {k}")
errorCount += 1
elif lupa.lua_type(table2[k]) == "table":
errorCount += compare_tables(table1[k], table2[k], str(prev_key)+"->"+str(k))
return errorCount
languageProgress = {}
en_us_entries = {}
for dlc in dlcs:
lua.execute('REPENTOGON = true; EID = {}; EID.descriptions = {}; function EID:updateDescriptionsViaTable(changeTable, tableToUpdate) for k,v in pairs(changeTable) do if v == "" then tableToUpdate[k] = nil else tableToUpdate[k] = v end end end')
g = lua.globals()
addUpdatedTables("en_us", dlc)
# Read English language files first
englishFile = glob.glob(SOURCE_MOD_DIRECTORY+"/**/"+dlc+"/en_us.lua", recursive=True)[0]
print("reading:", englishFile)
lua.execute(open(englishFile, "r", encoding="UTF-8").read())
en_us_entries[dlc] = count_entries(g.EID['descriptions']['en_us'])
print("en_us "+dlc+" entries:", en_us_entries[dlc])
langFiles = []
if ONLY_DO_LANGUAGE != "":
langFiles += glob.glob(SOURCE_MOD_DIRECTORY+"/**/"+dlc+"/"+ONLY_DO_LANGUAGE+".lua", recursive=True)
else:
langFiles += glob.glob(SOURCE_MOD_DIRECTORY+"/**/"+dlc+"/*.lua", recursive=True)
# Read other language files
for file in langFiles:
if "en_us" not in file and "transformations" not in file:
languageCode = os.path.basename(file).replace(".lua","")
print("reading:",file)
addUpdatedTables(languageCode, dlc)
lua.execute(open(file, "r", encoding="UTF-8").read())
if languageCode not in languageProgress:
languageProgress[languageCode] = {}
# Evaluate language for completeness
print(f"Evaluating language '{languageCode}'..")
errorCount = compare_tables(g.EID['descriptions']['en_us'], g.EID['descriptions'][languageCode], languageCode+"("+dlc+")")
percentage = (en_us_entries[dlc] - errorCount) / en_us_entries[dlc] * 100
languageProgress[languageCode][dlc] = [percentage, errorCount]
print(f"{Red}Errors found: {errorCount} / {en_us_entries[dlc]}{Color_Off}\n\n")
# Calculate total english entries
total_en_us_entries = 0
for entries in en_us_entries.values():
total_en_us_entries += entries
# Write git Workflow summary
gitWorkflowSummary = "### Translation progress\n| Language | Completion (AB+) |Completion (REP) |Completion (REP+) |Completion (Total) |\n|---|---|---|---|---|\n"
print(f"{Blue}Translation progress:{Color_Off}")
for lang in languageProgress.keys():
gitWorkflowSummary += f"| {lang} "
totalMissing = 0
for dlc in dlcs:
gitCompletionMessage = ""
if dlc in languageProgress[lang]:
percent = round(languageProgress[lang][dlc][0], 2)
missingEntries = languageProgress[lang][dlc][1]
totalMissing += missingEntries
print(f"\t{BWhite}{lang}({dlc}){Color_Off}\t{Blue}{percent}%{Color_Off}\t{Red}{missingEntries} missing{Color_Off}")
gitCompletionMessage = f"{percent}% ({missingEntries} left)" if missingEntries >3 else "100% 🎉"
else:
print(
f"\t{BWhite}{lang}({dlc}){Color_Off}\t\t{Red}DLC translation missing!{Color_Off}")
gitCompletionMessage = f"0% ({en_us_entries[dlc]} left)"
totalMissing += en_us_entries[dlc]
gitWorkflowSummary += f"| {gitCompletionMessage} "
totalPercent = round((total_en_us_entries - totalMissing) / total_en_us_entries * 100, 2)
gitWorkflowSummary += f"|{totalPercent}% ({totalMissing}) "
gitWorkflowSummary += "|\n"
print(gitWorkflowSummary)
if "GITHUB_STEP_SUMMARY" in os.environ:
print("\n\nwrite workflow summary to: ", os.environ["GITHUB_STEP_SUMMARY"])
Path(os.environ["GITHUB_STEP_SUMMARY"]).write_text(gitWorkflowSummary)