Skip to content

Commit

Permalink
Merge pull request #375 from CactusPuppy/tidying-up
Browse files Browse the repository at this point in the history 
tidying up
  • Loading branch information
@CactusPuppy
CactusPuppy authored Aug 5, 2024
2 parents e21b5fa + f245654 commit 8e32543
Show file tree
Hide file tree
Showing 6 changed files with 4,517 additions and 1,377 deletions.
293 changes: 165 additions & 128 deletions generate-the-other-languages-doc.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,21 @@ const assert = require("assert");
const fs = require("fs");
const { parseArgs } = require("util");

require('dotenv').config();
require("dotenv").config();

var docFolder = "./src/data/";
var docFiles = ["actions.ts", "constants.ts", "keywords.ts", "stringKw.ts", "values.ts"];

var datatoolPath = process.env.DATATOOL_PATH ?? "%USERPROFILE%\\toolchain-release\\DataTool.exe";
var overwatchPath = process.env.OVERWATCH_PATH ?? "C:\\Program Files (x86)\\Overwatch";
var docFiles = [
"actions.ts",
"constants.ts",
"keywords.ts",
"stringKw.ts",
"values.ts",
];

var datatoolPath =
process.env.DATATOOL_PATH ?? "%USERPROFILE%\\toolchain-release\\DataTool.exe";
var overwatchPath =
process.env.OVERWATCH_PATH ?? "C:\\Program Files (x86)\\Overwatch";
var outputFolder = "strings";
var guids;
var guidToLocaleMap = new Map();
Expand All @@ -18,171 +26,200 @@ var removeParentheses = true;
var fuzzyMatch = false;

const args = parseArgs({
options: {
"regenerateStringsFile": {
type: "boolean",
default: false
}
}
options: {
regenerateStringsFile: {
type: "boolean",
default: false,
},
},
});

async function generateStringsFile() {
const { execSync } = require('child_process');

let command = '"'+datatoolPath+'" "'+overwatchPath+'" dump-all-locale-strings --out='+outputFolder+'/strings.json';
console.log("Extracting all locale strings with DataTool...");
execSync(command, (err, stdout, stderr) => {
if (err) {
console.log("DataTool failed with error:", err);
return;
}
});
const { execSync } = require("child_process");

let command =
'"' +
datatoolPath +
'" "' +
overwatchPath +
'" dump-all-locale-strings --out=' +
outputFolder +
"/strings.json";
console.log("Extracting all locale strings with DataTool...");
execSync(command, (err, stdout, stderr) => {
if (err) {
console.log("DataTool failed with error:", err);
return;
}
});
}

function getGuids() {
console.log("Generating GUID mappings...");
guids = JSON.parse(fs.readFileSync(outputFolder+"/strings.json"));

// Precompute some mappings to save time later at cost of space complexity
for (let guidGlob of Object.entries(guids)) {
let guid = guidGlob[0].split(".")[0];
guidToLocaleMap.set(guid, guidGlob[1]);

assert(Object.keys(guidGlob[1]).includes("enUS"), "enUS not found in guid "+guid);

let enUSKey = guidGlob[1]["enUS"];
console.log("Generating GUID mappings...");
guids = JSON.parse(fs.readFileSync(outputFolder + "/strings.json"));

// Precompute some mappings to save time later at cost of space complexity
for (let guidGlob of Object.entries(guids)) {
// New DataTool versions sometimes give empty objects or null for some GUIDs, skip them.
if (guidGlob[1] === null || objectIsEmpty(guidGlob[1])) continue;
let guid = guidGlob[0].split(".")[0];
guidToLocaleMap.set(guid, guidGlob[1]);

assert(
Object.keys(guidGlob[1]).includes("enUS"),
"enUS not found in guid " + guid,
);

let enUSKey = guidGlob[1]["enUS"];

if (enUSToGuidMap.has(enUSKey)) {
// console.debug("Duplicate enUS key found: "+enUSKey);
continue;
}

if (enUSToGuidMap.has(enUSKey)) {
// console.debug("Duplicate enUS key found: "+enUSKey);
continue;
}
enUSToGuidMap.set(guidGlob[1]["enUS"], guid);
enUSFuzzyToGuidMap.set(
guidGlob[1]["enUS"].replace(/[\.,;'\s()-]/g, "").toLowerCase(),
guid,
);
}
//console.log(guids["en-US"]);
}

enUSToGuidMap.set(guidGlob[1]["enUS"], guid);
enUSFuzzyToGuidMap.set(guidGlob[1]["enUS"].replace(/[\.,;'\s()-]/g, "").toLowerCase(), guid);
}
//console.log(guids["en-US"]);
function objectIsEmpty(obj) {
for (var key in obj) {
if (obj.hasOwnProperty(key)) return false;
}
return true;
}

function replaceJsonObjectsInFile(path) {
console.log("Processing "+path);
let content = ""+fs.readFileSync(path);
let result = "";
let currentJsonStr = "";
let isInJsonObject = false;
for (let line of content.split(/\r?\n/g)) {
if (line.trim() === "//end-json") {
isInJsonObject = false;
tmpObj = iterateOnObject(eval("("+currentJsonStr+")"));
result += JSON.stringify(tmpObj, null, 4)+"\n";
currentJsonStr = "";
}
if (!isInJsonObject) {
result += line+"\n";
} else {
currentJsonStr += line+"\n";
}
if (line.trim() === "//begin-json") {
isInJsonObject = true;
}
console.log("Processing " + path);
let content = "" + fs.readFileSync(path);
let result = "";
let currentJsonStr = "";
let isInJsonObject = false;
for (let line of content.split(/\r?\n/g)) {
if (line.trim() === "//end-json") {
isInJsonObject = false;
tmpObj = iterateOnObject(eval("(" + currentJsonStr + ")"));
result += JSON.stringify(tmpObj, null, 4) + "\n";
currentJsonStr = "";
}
if (!isInJsonObject) {
result += line + "\n";
} else {
currentJsonStr += line + "\n";
}
fs.writeFileSync(path, result.substring(0, result.length-1));
if (line.trim() === "//begin-json") {
isInJsonObject = true;
}
}
fs.writeFileSync(path, result.substring(0, result.length - 1));
}

function iterateOnObject(content) {
if (content.onlyInOw1) {
return content;
}
if ("guid" in content || "en-US" in content) {
content = addTranslations(content);
}
if (content.onlyInOw1) {
return content;
}
if ("guid" in content || "en-US" in content) {
content = addTranslations(content);
}

/*if ("description" in content && !("descriptionLocalized" in content)) {
/*if ("description" in content && !("descriptionLocalized" in content)) {
content["descriptionLocalized"] = {"en-US": content["description"]}
}*/

for (var key of Object.keys(content)) {
if (typeof content[key] === "object" && content[key] !== null) {
//Skip the comparison operators as they must not be translated.
if (key !== "__Operator__" && key !== "descriptionLocalized") {
if (key === "nameLocalized" || key === "descriptionLocalized") {
oldRemoveParentheses = removeParentheses;
removeParentheses = false;
fuzzyMatch = true;
} else {
fuzzyMatch = false;
}
content[key] = iterateOnObject(content[key]);
if (key === "nameLocalized" || key === "descriptionLocalized") {
removeParentheses = oldRemoveParentheses;
}
}
for (var key of Object.keys(content)) {
if (typeof content[key] === "object" && content[key] !== null) {
//Skip the comparison operators as they must not be translated.
if (key !== "__Operator__" && key !== "descriptionLocalized") {
if (key === "nameLocalized" || key === "descriptionLocalized") {
oldRemoveParentheses = removeParentheses;
removeParentheses = false;
fuzzyMatch = true;
} else {
fuzzyMatch = false;
}
content[key] = iterateOnObject(content[key]);
if (key === "nameLocalized" || key === "descriptionLocalized") {
removeParentheses = oldRemoveParentheses;
}
}
}
}

return content;
return content;
}

function addTranslations(content) {
if (!("guid" in content) || content.guid === "<unknown guid>") {
assert (Object.keys(content).includes("en-US"), "GUID-less content does not have an en-US key: "+JSON.stringify(content));

if (fuzzyMatch) {
content.guid = enUSFuzzyToGuidMap.get(content["en-US"].replace(/[\.,;'\s()-]/g, "").toLowerCase());
} else {
content.guid = enUSToGuidMap.get(content["en-US"]);
}
if (!("guid" in content) || content.guid === "<unknown guid>") {
assert(
Object.keys(content).includes("en-US"),
"GUID-less content does not have an en-US key: " +
JSON.stringify(content),
);

if (fuzzyMatch) {
content.guid = enUSFuzzyToGuidMap.get(
content["en-US"].replace(/[\.,;'\s()-]/g, "").toLowerCase(),
);
} else {
content.guid = enUSToGuidMap.get(content["en-US"]);
}
}

if (content.guid === undefined) {
console.warn("GUID not found for content: "+JSON.stringify(content));
return content;
}
if (content.guid === undefined) {
console.warn("GUID not found for content: " + JSON.stringify(content));
return content;
}

let guidGlob = guidToLocaleMap.get(content.guid);
for (let localeEntry of Object.entries(guidGlob)) {
localeEntry[1] = localeEntry[1].replace(/%%/g, "%");
if (removeParentheses) localeEntry[1] = localeEntry[1].replace(/[,\(\)\/]/g,"");
content[dataToolLocaleToOverPyLocale(localeEntry[0])] = localeEntry[1];
}
let guidGlob = guidToLocaleMap.get(content.guid);
for (let localeEntry of Object.entries(guidGlob)) {
localeEntry[1] = localeEntry[1].replace(/%%/g, "%");
if (removeParentheses)
localeEntry[1] = localeEntry[1].replace(/[,\(\)\/]/g, "");
content[dataToolLocaleToOverPyLocale(localeEntry[0])] = localeEntry[1];
}

return content;
return content;
}

function normalizeName(content) {
content = content.replace(/(?<=[a-z])(?=[A-Z0-9])/g, " ");
content = content.replace("-", " - ");
content = content.replace(":", ": ");
content = content.replace(/\s+/g, " ");
var words = content.split(" ");
words = words.map(x => x[0].toUpperCase()+x.substring(1).toLowerCase()).join(" ");
console.log(words);
content = words;
return content;
content = content.replace(/(?<=[a-z])(?=[A-Z0-9])/g, " ");
content = content.replace("-", " - ");
content = content.replace(":", ": ");
content = content.replace(/\s+/g, " ");
var words = content.split(" ");
words = words
.map((x) => x[0].toUpperCase() + x.substring(1).toLowerCase())
.join(" ");
console.log(words);
content = words;
return content;
}



if (args.values.regenerateStringsFile) generateStringsFile();
getGuids();
replaceJsonObjectsInFile(docFolder+"actions.ts");
replaceJsonObjectsInFile(docFolder+"values.ts");
replaceJsonObjectsInFile(docFolder+"constants.ts");
replaceJsonObjectsInFile(docFolder+"heroes.ts");
replaceJsonObjectsInFile(docFolder+"maps.ts");
replaceJsonObjectsInFile(docFolder+"gamemodes.ts");
replaceJsonObjectsInFile(docFolder+"customGameSettings.ts");
replaceJsonObjectsInFile(docFolder + "actions.ts");
replaceJsonObjectsInFile(docFolder + "values.ts");
replaceJsonObjectsInFile(docFolder + "constants.ts");
replaceJsonObjectsInFile(docFolder + "heroes.ts");
replaceJsonObjectsInFile(docFolder + "maps.ts");
replaceJsonObjectsInFile(docFolder + "gamemodes.ts");
replaceJsonObjectsInFile(docFolder + "customGameSettings.ts");
removeParentheses = false;
replaceJsonObjectsInFile(docFolder+"ui.ts");
replaceJsonObjectsInFile(docFolder+"argnames.ts");
replaceJsonObjectsInFile(docFolder+"localizedStrings.ts");
replaceJsonObjectsInFile(docFolder+"other.ts");
replaceJsonObjectsInFile(docFolder + "ui.ts");
replaceJsonObjectsInFile(docFolder + "argnames.ts");
replaceJsonObjectsInFile(docFolder + "localizedStrings.ts");
replaceJsonObjectsInFile(docFolder + "other.ts");

/**
* Converts a locale from the DataTool format to the OverPy format.
* @param {string} locale The locale to convert (e.g. "enUS")
* @returns {string} The converted locale (e.g. "en-US")
*/
function dataToolLocaleToOverPyLocale(locale) {
let result = locale.match(/([a-z]+)([A-Z]+)/);
return result[1]+"-"+result[2];
let result = locale.match(/([a-z]+)([A-Z]+)/);
return result[1] + "-" + result[2];
}
6 changes: 3 additions & 3 deletions src/data/constants.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -845,12 +845,12 @@ export const constantValues: Record<string, { description?: string } & Record<st
"th-TH": "ขาว",
"tr-TR": "Beyaz",
"zh-CN": "白色",
"de-DE": "White",
"es-ES": "White",
"de-DE": "Weiß",
"es-ES": "Blanco",
"it-IT": "White",
"ko-KR": "White",
"pl-PL": "White",
"ru-RU": "White",
"ru-RU": "Белый",
"zh-TW": "White"
},
"AQUA": {
Expand Down
2 changes: 1 addition & 1 deletion src/data/customGameSettings.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6310,7 +6310,7 @@ export const customGameSettingsSchema: CustomGameSettingSchema =
"ru-RU": "Дальность «Хватки жизни» и «Целебного цветка»",
"th-TH": "ระยะของไลฟ์กริปและบุปผาแห่งการเยียวยา",
"tr-TR": "Can Halatı ve Şifa Çiçekleri Menzili",
"zh-CN": "生命之握和愈疗灵花范围",
"zh-CN": "生命之握和愈疗灵花射程",
"zh-TW": "賦生之握和治療綻放範圍"
},
"weaponsEnabled": {
Expand Down
2 changes: 1 addition & 1 deletion src/data/maps.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1959,7 +1959,7 @@ export const mapKw: Record<string, import("../types").Map> =
"pl-PL": "Runasapi",
"pt-BR": "Runasapi",
"ru-RU": "Рунасапи",
"th-TH": "รูนาซาพี",
"th-TH": "รูนาซาปี",
"tr-TR": "<en>Runasapi<en>",
"zh-CN": "鲁纳塞彼",
"zh-TW": "盧納薩庇"
Expand Down
2 changes: 1 addition & 1 deletion src/data/values.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1891,7 +1891,7 @@ export var valueFuncKw: {
"pt-BR": "Munição Máxima",
"th-TH": "กระสุนสูงสุด",
"tr-TR": "Maks. Cephane",
"zh-CN": "最大弹药量",
"zh-CN": "最大弹药",
"de-DE": "Max Ammo",
"es-ES": "Max Ammo",
"it-IT": "Max Ammo",
Expand Down
Loading

0 comments on commit 8e32543

Please sign in to comment.