mapcomplete/scripts/generateTaginfoProjectFiles.ts

144 lines
5.8 KiB
TypeScript
Raw Normal View History

2021-04-19 18:17:26 +02:00
import {Utils} from "../Utils";
Utils.runningFromConsole = true;
import {AllKnownLayouts} from "../Customizations/AllKnownLayouts";
import LayoutConfig from "../Customizations/JSON/LayoutConfig";
import {TagsFilter} from "../Logic/Tags/TagsFilter";
import LanguagePicker from "../UI/LanguagePicker";
import Locale from "../UI/i18n/Locale";
import {Layer} from "leaflet";
import LayerConfig from "../Customizations/JSON/LayerConfig";
import {Translation} from "../UI/i18n/Translation";
import {readFileSync, writeFile, writeFileSync} from "fs";
const outputDirectory = "Docs/TagInfo"
2021-04-20 11:54:45 +02:00
function generateTagOverview(kv: { k: string, v: string }, description: string) {
const overview = {
// OSM tag key (required)
key: kv.k,
description: description
};
if (kv.v !== undefined) {
// OSM tag value (optional, if not supplied it means "all values")
overview["value"] = kv.v
}
return overview
}
2021-04-19 18:17:26 +02:00
function generateLayerUsage(layer: LayerConfig, layout: LayoutConfig): any [] {
const usedTags = layer.source.osmTags.asChange({})
const result = []
for (const kv of usedTags) {
2021-04-20 11:54:45 +02:00
const description = "The MapComplete theme " + layout.title.txt + " has a layer " + layer.name.txt + " showing features with this tag"
result.push(generateTagOverview(kv, description))
}
for (const tr of layer.tagRenderings) {
const q = tr.question?.txt;
const key = tr.freeform?.key;
if (key != undefined) {
2021-04-21 18:51:12 +02:00
let descr = `Layer '${layer.name.txt}'`;
2021-04-20 11:54:45 +02:00
if (q == undefined) {
descr += " shows values with";
} else {
descr += " shows and asks freeform values for"
}
2021-04-21 18:51:12 +02:00
descr += ` key '${key}' (in the MapComplete.osm.be theme '${layout.title.txt}')`
2021-04-20 11:54:45 +02:00
result.push(generateTagOverview({k: key, v: undefined}, descr))
}
const mappings = tr.mappings ?? []
for (const mapping of mappings) {
2021-04-21 18:51:12 +02:00
let descr = "Layer '" + layer.name.txt + "'";
2021-04-20 11:54:45 +02:00
descr += " shows " + mapping.if.asHumanString(false, false, {}) + " with a fixed text, namely '" + mapping.then.txt + "'";
if (q != undefined
&& mapping.hideInAnswer != true // != true will also match if a
) {
2021-04-21 18:51:12 +02:00
descr += " and allows to pick this as a default answer"
2021-04-20 11:54:45 +02:00
}
2021-04-21 18:51:12 +02:00
descr += ` (in the MapComplete.osm.be theme '${layout.title.txt}')`
2021-04-20 11:54:45 +02:00
for (const kv of mapping.if.asChange({})) {
let d = descr;
if (q!=undefined && kv.v == "") {
d = `${descr} Picking this answer will delete the key ${kv.k}.`
}
result.push(generateTagOverview(kv, d))
}
2021-04-19 18:17:26 +02:00
}
}
return result;
}
/**
* Generates the JSON-object representing the theme for inclusion on taginfo
* @param layout
*/
function generateTagInfoEntry(layout: LayoutConfig): any {
const usedTags = []
for (const layer of layout.layers) {
usedTags.push(...generateLayerUsage(layer, layout))
}
const t = new Date();
const generationTime = t.getUTCFullYear() + Utils.TwoDigits(t.getUTCMonth()) + Utils.TwoDigits(t.getUTCDate()) + "T" + Utils.TwoDigits(t.getUTCHours()) + Utils.TwoDigits(t.getUTCMinutes()) + Utils.TwoDigits(t.getSeconds()) + "Z"
let icon = layout.icon;
if (icon.startsWith("./")) {
icon = icon.substring(2)
}
const themeInfo = {
// data format version, currently always 1, will get updated if there are incompatible changes to the format (required)
"data_format": 1,
// "data_url": "...", # this should be the URL under which this project file can be accessed (optional)
// timestamp when project file was updated (optional, will use HTTP header date if not available)
// Not marked as not to pollute the github history
//"data_updated": generationTime,
2021-04-19 18:17:26 +02:00
"project": {
"name": "MapComplete " + layout.title.txt, // name of the project (required)
"description": layout.shortDescription.txt, // short description of the project (required)
"project_url": "https://mapcomplete.osm.be/" + layout.id, // home page of the project with general information (required)
"doc_url": "https://github.com/pietervdvn/MapComplete/tree/master/assets/themes/", // documentation of the project and especially the tags used (optional)
"icon_url": "https://mapcomplete.osm.be/" + layout.icon, // project logo, should work in 16x16 pixels on white and light gray backgrounds (optional)
"contact_name": "Pieter Vander Vennet, " + layout.maintainer, // contact name, needed for taginfo maintainer (required)
"contact_email": "pietervdvn@posteo.net" // contact email, needed for taginfo maintainer (required)
},
tags: usedTags
}
const filename = "mapcomplete_" + layout.id
console.log("Writing info about " + layout.id)
writeFileSync(`${outputDirectory}/${filename}.json`, JSON.stringify(themeInfo, null, " "))
return filename
}
console.log("Creating taginfo project files")
Locale.language.setData("en")
Translation.forcedLanguage = "en"
const files = []
for (const layout of AllKnownLayouts.layoutsList) {
if (layout.hideFromOverview) {
continue;
}
files.push(generateTagInfoEntry(layout));
}
const tagInfoList = "../taginfo-projects/project_list.txt"
let projectList = readFileSync(tagInfoList, "UTF8")
.split("\n")
.filter(entry => entry.indexOf("mapcomplete_") < 0)
.concat(files.map(f => `${f} https://raw.githubusercontent.com/pietervdvn/MapComplete/master/Docs/TagInfo/${f}.json`))
.sort()
.filter(entry => entry != "")
2021-04-20 11:54:45 +02:00
console.log("Writing taginfo project filelist");
writeFileSync(tagInfoList, projectList.join("\n") + "\n");