forked from MapComplete/MapComplete
Add some more missing translations, small tweaks to scripts
This commit is contained in:
parent
9fc8a7136f
commit
b2213751c3
4 changed files with 188 additions and 145 deletions
|
|
@ -1,24 +1,22 @@
|
|||
import ScriptUtils from "./ScriptUtils";
|
||||
import {Utils} from "../Utils";
|
||||
import {lstatSync, readdirSync, readFileSync, writeFileSync} from "fs";
|
||||
import {readFileSync, writeFileSync} from "fs";
|
||||
|
||||
Utils.runningFromConsole = true
|
||||
import LayerConfig from "../Customizations/JSON/LayerConfig";
|
||||
import {error} from "util";
|
||||
import * as licenses from "../assets/generated/license_info.json"
|
||||
import SmallLicense from "../Models/smallLicense";
|
||||
import LayoutConfig from "../Customizations/JSON/LayoutConfig";
|
||||
import {LayerConfigJson} from "../Customizations/JSON/LayerConfigJson";
|
||||
import {Layer} from "leaflet";
|
||||
import {Translation} from "../UI/i18n/Translation";
|
||||
// This scripts scans 'assets/layers/*.json' for layer definition files and 'assets/themes/*.json' for theme definition files.
|
||||
// It spits out an overview of those to be used to load them
|
||||
|
||||
interface LayersAndThemes {
|
||||
themes: any[] , layers: {parsed: any, path: string}[]
|
||||
}
|
||||
|
||||
// First, remove the old file. It might be buggy!
|
||||
writeFileSync("./assets/generated/known_layers_and_themes.json", JSON.stringify({
|
||||
"layers": [],
|
||||
"themes": []
|
||||
}))
|
||||
function loadThemesAndLayers():LayersAndThemes{
|
||||
|
||||
const layerFiles = ScriptUtils.readDirRecSync("./assets/layers")
|
||||
.filter(path => path.indexOf(".json") > 0)
|
||||
.filter(path => path.indexOf("license_info.json") < 0)
|
||||
|
|
@ -36,22 +34,22 @@ const themeFiles: any[] = ScriptUtils.readDirRecSync("./assets/themes")
|
|||
.map(path => {
|
||||
return JSON.parse(readFileSync(path, "UTF8"));
|
||||
})
|
||||
writeFileSync("./assets/generated/known_layers_and_themes.json", JSON.stringify({
|
||||
"layers": layerFiles.map(l => l.parsed),
|
||||
"themes": themeFiles
|
||||
}))
|
||||
|
||||
|
||||
console.log("Discovered", layerFiles.length, "layers and", themeFiles.length, "themes\n")
|
||||
console.log(" ---------- VALIDATING ---------")
|
||||
// ------------- VALIDATION --------------
|
||||
const licensePaths = []
|
||||
for (const i in licenses) {
|
||||
licensePaths.push(licenses[i].path)
|
||||
return {
|
||||
layers: layerFiles,
|
||||
themes: themeFiles
|
||||
}
|
||||
}
|
||||
const knownPaths = new Set<string>(licensePaths)
|
||||
|
||||
function validateLayer(layerJson: LayerConfigJson, path: string, context?: string): string[] {
|
||||
function writeFiles(lt: LayersAndThemes){
|
||||
writeFileSync("./assets/generated/known_layers_and_themes.json", JSON.stringify({
|
||||
"layers": lt.layers.map(l => l.parsed),
|
||||
"themes": lt.themes
|
||||
}))
|
||||
}
|
||||
|
||||
function validateLayer(layerJson: LayerConfigJson, path: string, knownPaths: Set<string>, context?: string): string[] {
|
||||
let errorCount = [];
|
||||
if (layerJson["overpassTags"] !== undefined) {
|
||||
errorCount.push("Layer " + layerJson.id + "still uses the old 'overpassTags'-format. Please use \"source\": {\"osmTags\": <tags>}' instead of \"overpassTags\": <tags> (note: this isn't your fault, the custom theme generator still spits out the old format)")
|
||||
|
|
@ -61,8 +59,7 @@ function validateLayer(layerJson: LayerConfigJson, path: string, context?: strin
|
|||
const images = Array.from(layer.ExtractImages())
|
||||
const remoteImages = images.filter(img => img.indexOf("http") == 0)
|
||||
for (const remoteImage of remoteImages) {
|
||||
errorCount.push("Found a remote image: " + remoteImage + " in layer " + layer.id + ", please download it.")
|
||||
const path = remoteImage.substring(remoteImage.lastIndexOf("/") + 1)
|
||||
errorCount.push("Found a remote image: " + remoteImage + " in layer " + layer.id + ", please download it. You can use the fixTheme script to automate this")
|
||||
}
|
||||
const expected: string = `assets/layers/${layer.id}/${layer.id}.json`
|
||||
if (path != undefined && path.indexOf(expected) < 0) {
|
||||
|
|
@ -83,60 +80,151 @@ function validateLayer(layerJson: LayerConfigJson, path: string, context?: strin
|
|||
return errorCount
|
||||
}
|
||||
|
||||
let layerErrorCount = []
|
||||
const knownLayerIds = new Set<string>();
|
||||
for (const layerFile of layerFiles) {
|
||||
knownLayerIds.add(layerFile.parsed.id)
|
||||
layerErrorCount.push(...validateLayer(layerFile.parsed, layerFile.path))
|
||||
function validateTranslationCompletenessOfObject(object: any, expectedLanguages: string[], context: string) {
|
||||
const missingTranlations = []
|
||||
const translations: {tr: Translation, context: string}[] = [];
|
||||
const queue: {object: any, context: string}[] = [{object: object, context: context}]
|
||||
|
||||
while (queue.length > 0) {
|
||||
const item = queue.pop();
|
||||
const o = item.object
|
||||
for (const key in o) {
|
||||
const v = o[key];
|
||||
if (v === undefined) {
|
||||
continue;
|
||||
}
|
||||
if (v instanceof Translation || v?.translations !== undefined) {
|
||||
translations.push({tr: v, context: item.context});
|
||||
} else if (
|
||||
["string", "function", "boolean", "number"].indexOf(typeof (v)) < 0) {
|
||||
queue.push({object: v, context: item.context + "." + key})
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const missing = {}
|
||||
const present = {}
|
||||
for (const ln of expectedLanguages) {
|
||||
missing[ln] = 0;
|
||||
present[ln] = 0;
|
||||
for (const translation of translations) {
|
||||
if (translation.tr.translations["*"] !== undefined) {
|
||||
continue;
|
||||
}
|
||||
const txt = translation.tr.translations[ln];
|
||||
const isMissing = txt === undefined || txt === "" || txt.toLowerCase().indexOf("todo") >= 0;
|
||||
if (isMissing) {
|
||||
missingTranlations.push(`${translation.context},${ln},${translation.tr.txt}`)
|
||||
missing[ln]++
|
||||
} else {
|
||||
present[ln]++;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
let message = `Translation completeness for ${context}`
|
||||
let isComplete = true;
|
||||
for (const ln of expectedLanguages) {
|
||||
const amiss = missing[ln];
|
||||
const ok = present[ln];
|
||||
const total = amiss + ok;
|
||||
message += ` ${ln}: ${ok}/${total}`
|
||||
if (ok !== total) {
|
||||
isComplete = false;
|
||||
}
|
||||
}
|
||||
if (!isComplete) {
|
||||
console.log(message)
|
||||
}
|
||||
return missingTranlations
|
||||
|
||||
}
|
||||
|
||||
let themeErrorCount = []
|
||||
for (const themeFile of themeFiles) {
|
||||
function main(args: string[]) {
|
||||
|
||||
const lt = loadThemesAndLayers();
|
||||
const layerFiles = lt.layers;
|
||||
const themeFiles = lt.themes;
|
||||
|
||||
console.log(" ---------- VALIDATING ---------")
|
||||
const licensePaths = []
|
||||
for (const i in licenses) {
|
||||
licensePaths.push(licenses[i].path)
|
||||
}
|
||||
const knownPaths = new Set<string>(licensePaths)
|
||||
|
||||
let layerErrorCount = []
|
||||
const knownLayerIds = new Map<string, LayerConfig>();
|
||||
for (const layerFile of layerFiles) {
|
||||
|
||||
layerErrorCount.push(...validateLayer(layerFile.parsed, layerFile.path, knownPaths))
|
||||
knownLayerIds.set(layerFile.parsed.id, new LayerConfig(layerFile.parsed))
|
||||
}
|
||||
|
||||
let themeErrorCount = []
|
||||
let missingTranslations = []
|
||||
for (const themeFile of themeFiles) {
|
||||
if (typeof themeFile.language === "string") {
|
||||
themeErrorCount.push("The theme " + themeFile.id + " has a string as language. Please use a list of strings")
|
||||
}
|
||||
for (const layer of themeFile.layers) {
|
||||
if (typeof layer === "string") {
|
||||
if (!knownLayerIds.has(layer)) {
|
||||
themeErrorCount.push(`Unknown layer id: ${layer} in theme ${themeFile.id}`)
|
||||
} else {
|
||||
const layerConfig = knownLayerIds.get(layer);
|
||||
missingTranslations.push(...validateTranslationCompletenessOfObject(layerConfig, themeFile.language, "Layer " + layer))
|
||||
|
||||
for (const layer of themeFile.layers) {
|
||||
if (typeof layer === "string") {
|
||||
if (!knownLayerIds.has(layer)) {
|
||||
themeErrorCount.push(`Unknown layer id: ${layer} in theme ${themeFile.id}`)
|
||||
}
|
||||
} else {
|
||||
if (layer.builtin !== undefined) {
|
||||
if (!knownLayerIds.has(layer.builtin)) {
|
||||
themeErrorCount.push("Unknown layer id: " + layer.builtin + "(which uses inheritance)")
|
||||
}
|
||||
} else {
|
||||
// layer.builtin contains layer overrides - we can skip those
|
||||
layerErrorCount.push(...validateLayer(layer, undefined, themeFile.id))
|
||||
if (layer.builtin !== undefined) {
|
||||
if (!knownLayerIds.has(layer.builtin)) {
|
||||
themeErrorCount.push("Unknown layer id: " + layer.builtin + "(which uses inheritance)")
|
||||
}
|
||||
} else {
|
||||
// layer.builtin contains layer overrides - we can skip those
|
||||
layerErrorCount.push(...validateLayer(layer, undefined, knownPaths, themeFile.id))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
themeFile.layers = themeFile.layers
|
||||
.filter(l => typeof l != "string") // We remove all the builtin layer references as they don't work with ts-node for some weird reason
|
||||
.filter(l => l.builtin === undefined)
|
||||
themeFile.layers = themeFile.layers
|
||||
.filter(l => typeof l != "string") // We remove all the builtin layer references as they don't work with ts-node for some weird reason
|
||||
.filter(l => l.builtin === undefined)
|
||||
|
||||
try {
|
||||
const theme = new LayoutConfig(themeFile, true, "test")
|
||||
if (theme.id !== theme.id.toLowerCase()) {
|
||||
themeErrorCount.push("Theme ids should be in lowercase, but it is " + theme.id)
|
||||
missingTranslations.push(...validateTranslationCompletenessOfObject(themeFile, themeFile.language, "Theme " + themeFile.id))
|
||||
|
||||
try {
|
||||
const theme = new LayoutConfig(themeFile, true, "test")
|
||||
if (theme.id !== theme.id.toLowerCase()) {
|
||||
themeErrorCount.push("Theme ids should be in lowercase, but it is " + theme.id)
|
||||
}
|
||||
} catch (e) {
|
||||
themeErrorCount.push("Could not parse theme " + themeFile["id"] + "due to", e)
|
||||
}
|
||||
}
|
||||
|
||||
if(missingTranslations.length > 0){
|
||||
writeFileSync("missing_translations.txt", missingTranslations.join("\n"))
|
||||
}
|
||||
|
||||
if (layerErrorCount.length + themeErrorCount.length == 0) {
|
||||
console.log("All good!")
|
||||
writeFiles(lt);
|
||||
} else {
|
||||
const errors = layerErrorCount.concat(themeErrorCount).join("\n")
|
||||
console.log(errors)
|
||||
const msg = (`Found ${layerErrorCount.length} errors in the layers; ${themeErrorCount.length} errors in the themes`)
|
||||
console.log(msg)
|
||||
if (process.argv.indexOf("--report") >= 0) {
|
||||
console.log("Writing report!")
|
||||
writeFileSync("layer_report.txt", errors)
|
||||
}
|
||||
|
||||
if (process.argv.indexOf("--no-fail") < 0) {
|
||||
throw msg;
|
||||
}
|
||||
} catch (e) {
|
||||
themeErrorCount.push("Could not parse theme " + themeFile["id"] + "due to", e)
|
||||
}
|
||||
}
|
||||
|
||||
if (layerErrorCount.length + themeErrorCount.length == 0) {
|
||||
console.log("All good!")
|
||||
} else {
|
||||
const errors = layerErrorCount.concat(themeErrorCount).join("\n")
|
||||
console.log(errors)
|
||||
const msg = (`Found ${layerErrorCount.length} errors in the layers; ${themeErrorCount.length} errors in the themes`)
|
||||
console.log(msg)
|
||||
if (process.argv.indexOf("--report") >= 0) {
|
||||
console.log("Writing report!")
|
||||
writeFileSync("layer_report.txt", errors)
|
||||
}
|
||||
|
||||
if (process.argv.indexOf("--no-fail") < 0) {
|
||||
throw msg;
|
||||
}
|
||||
}
|
||||
main(process.argv)
|
||||
Loading…
Add table
Add a link
Reference in a new issue