mapcomplete/scripts/generateTranslations.ts

345 lines
12 KiB
TypeScript
Raw Normal View History

2020-11-17 02:22:48 +01:00
import * as fs from "fs";
import {readFileSync, writeFileSync} from "fs";
2020-11-17 02:22:48 +01:00
import {Utils} from "../Utils";
2021-05-19 16:15:12 +02:00
import ScriptUtils from "./ScriptUtils";
2021-05-19 20:47:41 +02:00
const knownLanguages = ["en", "nl", "de", "fr", "es", "gl", "ca"];
2021-05-19 16:15:12 +02:00
class TranslationPart {
contents: Map<string, TranslationPart | string> = new Map<string, TranslationPart | string>()
2021-05-19 20:47:41 +02:00
add(language: string, obj: any) {
2021-05-19 16:15:12 +02:00
for (const key in obj) {
const v = obj[key]
2021-05-19 20:47:41 +02:00
if (!this.contents.has(key)) {
2021-05-19 16:15:12 +02:00
this.contents.set(key, new TranslationPart())
}
const subpart = this.contents.get(key) as TranslationPart
2021-05-19 20:47:41 +02:00
if (typeof v === "string") {
2021-05-19 16:15:12 +02:00
subpart.contents.set(language, v)
2021-05-19 20:47:41 +02:00
} else {
2021-05-19 16:15:12 +02:00
subpart.add(language, v)
}
}
}
2021-05-19 20:47:41 +02:00
addTranslationObject(translations: any, context?: string) {
for (const translationsKey in translations) {
if (!translations.hasOwnProperty(translationsKey)) {
continue;
}
const v = translations[translationsKey]
if (typeof (v) != "string") {
console.error("Non-string object in translation: ", translations[translationsKey])
throw "Error in an object depicting a translation: a non-string object was found. (" + context + ")\n You probably put some other section accidentally in the translation"
}
this.contents.set(translationsKey, v)
}
}
2021-05-20 00:10:38 +02:00
recursiveAdd(object: any, context: string) {
2021-05-19 20:47:41 +02:00
const isProbablyTranslationObject = knownLanguages.map(l => object.hasOwnProperty(l)).filter(x => x).length > 0;
if (isProbablyTranslationObject) {
this.addTranslationObject(object, context)
2021-05-19 20:47:41 +02:00
return;
}
for (const key in object) {
if (!object.hasOwnProperty(key)) {
continue;
}
const v = object[key]
if (v == null) {
console.warn("Got a null value for key ", key)
continue
}
if (typeof v !== "object") {
continue;
}
if (!this.contents.get(key)) {
this.contents.set(key, new TranslationPart())
}
(this.contents.get(key) as TranslationPart).recursiveAdd(v, context + "." + key);
2021-05-19 20:47:41 +02:00
}
}
knownLanguages(): string[] {
const languages = []
for (let key of Array.from(this.contents.keys())) {
2021-05-19 16:15:12 +02:00
const value = this.contents.get(key);
2021-05-19 20:47:41 +02:00
if (typeof value === "string") {
2021-05-20 00:10:38 +02:00
if (key === "#") {
continue;
}
2021-05-19 20:47:41 +02:00
languages.push(key)
} else {
languages.push(...(value as TranslationPart).knownLanguages())
}
}
return Utils.Dedup(languages);
}
toJson(neededLanguage?: string): string {
const parts = []
let keys = Array.from(this.contents.keys())
keys = keys.sort()
for (let key of keys) {
2021-05-19 20:47:41 +02:00
let value = this.contents.get(key);
if (typeof value === "string") {
value = value.replace(/"/g, "\\\"")
2021-05-19 23:40:55 +02:00
.replace(/\n/g, "\\n")
if (neededLanguage === undefined) {
2021-05-19 20:47:41 +02:00
parts.push(`\"${key}\": \"${value}\"`)
} else if (key === neededLanguage) {
return `"${value}"`
2021-05-19 20:47:41 +02:00
}
2021-05-19 20:47:41 +02:00
} else {
const sub = (value as TranslationPart).toJson(neededLanguage)
if (sub !== "") {
parts.push(`\"${key}\": ${sub}`);
}
2021-05-19 16:15:12 +02:00
}
}
2021-05-19 20:47:41 +02:00
if (parts.length === 0) {
return "";
}
return `{${parts.join(",")}}`;
2021-05-19 16:15:12 +02:00
}
}
2020-11-17 02:22:48 +01:00
function isTranslation(tr: any): boolean {
for (const key in tr) {
if (typeof tr[key] !== "string") {
return false;
}
}
return true;
}
function transformTranslation(obj: any, depth = 1) {
if (isTranslation(obj)) {
return `new Translation( ${JSON.stringify(obj)} )`
}
let values = ""
for (const key in obj) {
2021-05-19 20:47:41 +02:00
if (key === "#") {
continue;
}
2021-05-19 20:47:41 +02:00
if (key.match("^[a-zA-Z0-9_]*$") === null) {
throw "Invalid character in key: " + key
}
2020-11-17 02:22:48 +01:00
values += (Utils.Times((_) => " ", depth)) + key + ": " + transformTranslation(obj[key], depth + 1) + ",\n"
}
return `{${values}}`;
}
function genTranslations() {
2021-05-19 16:15:12 +02:00
const translations = JSON.parse(fs.readFileSync("./assets/generated/translations.json", "utf-8"))
2020-11-17 02:22:48 +01:00
const transformed = transformTranslation(translations);
let module = `import {Translation} from "../../UI/i18n/Translation"\n\nexport default class CompiledTranslations {\n\n`;
2020-11-17 02:22:48 +01:00
module += " public static t = " + transformed;
module += "}"
fs.writeFileSync("./assets/generated/CompiledTranslations.ts", module);
2020-11-17 02:22:48 +01:00
}
2021-05-19 16:15:12 +02:00
// Read 'lang/*.json', writes to 'assets/generated/translations.json'
2021-05-19 20:47:41 +02:00
function compileTranslationsFromWeblate() {
2021-05-20 12:27:33 +02:00
const translations = ScriptUtils.readDirRecSync("./langs", 1)
2021-05-19 16:15:12 +02:00
.filter(path => path.indexOf(".json") > 0)
const allTranslations = new TranslationPart()
for (const translationFile of translations) {
const contents = JSON.parse(readFileSync(translationFile, "utf-8"));
let language = translationFile.substring(translationFile.lastIndexOf("/") + 1)
2021-05-19 20:47:41 +02:00
language = language.substring(0, language.length - 5)
2021-05-19 16:15:12 +02:00
allTranslations.add(language, contents)
}
2021-05-19 20:47:41 +02:00
writeFileSync("./assets/generated/translations.json", JSON.stringify(JSON.parse(allTranslations.toJson()), null, " "))
2021-05-19 16:15:12 +02:00
}
2021-05-31 12:51:29 +02:00
// Get all the strings out of the layers; writes them onto the weblate paths
2021-05-19 23:40:55 +02:00
function generateTranslationsObjectFrom(objects: { path: string, parsed: { id: string } }[], target: string) {
2021-05-19 20:47:41 +02:00
const tr = new TranslationPart();
for (const layerFile of objects) {
2021-05-19 23:40:55 +02:00
const config: { id: string } = layerFile.parsed;
const layerTr = new TranslationPart();
if (config === undefined) {
throw "Got something not parsed! Path is " + layerFile.path
}
layerTr.recursiveAdd(config, layerFile.path)
2021-05-19 20:47:41 +02:00
tr.contents.set(config.id, layerTr)
}
const langs = tr.knownLanguages();
for (const lang of langs) {
2021-06-24 01:56:10 +02:00
if (lang === "#" || lang === "*") {
// Lets not export our comments or non-translated stuff
2021-05-19 23:40:55 +02:00
continue;
}
2021-05-19 20:47:41 +02:00
let json = tr.toJson(lang)
try {
2021-05-19 20:47:41 +02:00
json = JSON.stringify(JSON.parse(json), null, " ");
} catch (e) {
2021-05-19 20:47:41 +02:00
console.error(e)
}
writeFileSync(`langs/${target}/${lang}.json`, json)
2021-05-19 20:47:41 +02:00
}
}
function MergeTranslation(source: any, target: any, language: string, context: string = "") {
for (const key in source) {
if (!source.hasOwnProperty(key)) {
continue
}
const sourceV = source[key];
const targetV = target[key]
if (typeof sourceV === "string") {
if (targetV === undefined) {
if (typeof target === "string") {
throw "Trying to merge a translation into a fixed string at " + context + " for key " + key;
}
target[key] = source[key];
continue;
}
if (targetV[language] === sourceV) {
// Already the same
continue;
}
2021-05-19 23:40:55 +02:00
if (typeof targetV === "string") {
2021-09-04 18:59:51 +02:00
throw `At context ${context}: Could not add a translation in language ${language}. The target object has a string at the given path, whereas the translation contains an object.\n String at target: ${targetV}\n Object at translation source: ${JSON.stringify(sourceV)}`
}
targetV[language] = sourceV;
2021-05-20 00:10:38 +02:00
let was = ""
if (targetV[language] !== undefined && targetV[language] !== sourceV) {
was = " (overwritten " + targetV[language] + ")"
2021-05-20 00:10:38 +02:00
}
console.log(" + ", context + "." + language, "-->", sourceV, was)
continue
}
if (typeof sourceV === "object") {
if (targetV === undefined) {
target[language] = sourceV;
} else {
MergeTranslation(sourceV, targetV, language, context + "." + key);
}
continue;
}
throw "Case fallthrough"
}
return target;
}
2021-05-20 00:10:38 +02:00
function mergeLayerTranslation(layerConfig: { id: string }, path: string, translationFiles: Map<string, any>) {
const id = layerConfig.id;
translationFiles.forEach((translations, lang) => {
const translationsForLayer = translations[id]
MergeTranslation(translationsForLayer, layerConfig, lang, path + ":" + id)
})
2021-05-20 00:10:38 +02:00
}
2021-05-20 00:10:38 +02:00
function loadTranslationFilesFrom(target: string): Map<string, any> {
const translationFilePaths = ScriptUtils.readDirRecSync("./langs/" + target)
.filter(path => path.endsWith(".json"))
const translationFiles = new Map<string, any>();
for (const translationFilePath of translationFilePaths) {
let language = translationFilePath.substr(translationFilePath.lastIndexOf("/") + 1)
language = language.substr(0, language.length - 5)
2021-09-22 16:26:34 +02:00
try{
translationFiles.set(language, JSON.parse(readFileSync(translationFilePath, "utf8")))
}catch(e){
console.error("Invalid JSON file or file does not exist", translationFilePath)
throw e;
}
}
2021-05-20 00:10:38 +02:00
return translationFiles;
}
/**
2021-05-31 12:51:29 +02:00
* Load the translations from the weblate files back into the layers
2021-05-20 00:10:38 +02:00
*/
function mergeLayerTranslations() {
const layerFiles = ScriptUtils.getLayerFiles();
for (const layerFile of layerFiles) {
2021-05-20 00:10:38 +02:00
mergeLayerTranslation(layerFile.parsed, layerFile.path, loadTranslationFilesFrom("layers"))
writeFileSync(layerFile.path, JSON.stringify(layerFile.parsed, null, " "))
}
}
2021-05-19 23:40:55 +02:00
2021-05-20 00:10:38 +02:00
function mergeThemeTranslations() {
const themeFiles = ScriptUtils.getThemeFiles();
for (const themeFile of themeFiles) {
const config = themeFile.parsed;
mergeLayerTranslation(config, themeFile.path, loadTranslationFilesFrom("themes"))
const oldLanguages = config.language;
const allTranslations = new TranslationPart();
allTranslations.recursiveAdd(config, themeFile.path)
2021-05-20 00:10:38 +02:00
const newLanguages = allTranslations.knownLanguages()
const languageDiff = newLanguages.filter(l => oldLanguages.indexOf(l) < 0).join(", ")
if (languageDiff !== "") {
config.language = newLanguages;
console.log(" :hooray: Got a new language for theme", config.id, ":", languageDiff)
}
writeFileSync(themeFile.path, JSON.stringify(config, null, " "))
}
}
2021-05-31 12:58:49 +02:00
const themeOverwritesWeblate = process.argv[2] === "--ignore-weblate"
const questionsPath = "assets/tagRenderings/questions.json"
const questionsParsed = JSON.parse(readFileSync(questionsPath, 'utf8'))
if (!themeOverwritesWeblate) {
2021-05-31 12:51:29 +02:00
mergeLayerTranslations();
mergeThemeTranslations();
mergeLayerTranslation(questionsParsed, questionsPath, loadTranslationFilesFrom("shared-questions"))
writeFileSync(questionsPath, JSON.stringify(questionsParsed, null, " "))
} else {
2021-05-31 12:58:49 +02:00
console.log("Ignore weblate")
2021-05-31 12:51:29 +02:00
}
generateTranslationsObjectFrom(ScriptUtils.getLayerFiles(), "layers")
generateTranslationsObjectFrom(ScriptUtils.getThemeFiles(), "themes")
2021-05-19 22:40:25 +02:00
generateTranslationsObjectFrom([{path: questionsPath, parsed: questionsParsed}], "shared-questions")
if (!themeOverwritesWeblate) {
2021-05-31 12:51:29 +02:00
// Generates the core translations
compileTranslationsFromWeblate();
}
2020-11-17 02:22:48 +01:00
genTranslations()