Merge master

scripts/generateLayerOverview.ts

@@ -25,9 +25,9 @@ const layerFiles = ScriptUtils.readDirRecSync("./assets/layers")
     .map(path => {
         try {
             const parsed = JSON.parse(readFileSync(path, "UTF8"));
-            return parsed
+            return {parsed: parsed, path: path}
         } catch (e) {
-            console.error("Could not parse file ", path, "due to ", e)
+            console.error("Could not parse file ", "./assets/layers/" + path, "due to ", e)
         }
     })
 const themeFiles: any[] = ScriptUtils.readDirRecSync("./assets/themes")
@@ -37,7 +37,7 @@ const themeFiles: any[] = ScriptUtils.readDirRecSync("./assets/themes")
         return JSON.parse(readFileSync(path, "UTF8"));
     })
 writeFileSync("./assets/generated/known_layers_and_themes.json", JSON.stringify({
-    "layers": layerFiles,
+    "layers": layerFiles.map(l => l.parsed),
     "themes": themeFiles
 }))
 
@@ -51,7 +51,7 @@ for (const i in licenses) {
 }
 const knownPaths = new Set<string>(licensePaths)
 
-function validateLayer(layerJson: LayerConfigJson, context?: string): string[] {
+function validateLayer(layerJson: LayerConfigJson, path: 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)")
@@ -63,7 +63,12 @@ function validateLayer(layerJson: LayerConfigJson, context?: string): string[] {
         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)
-          }
+        }
+        const expected: string = `assets/layers/${layer.id}/${layer.id}.json`
+        if (path != undefined && path.indexOf(expected) < 0) {
+            errorCount.push("Layer is in an incorrect place. The path is " + path + ", but expected " + expected)
+        }
+
         for (const image of images) {
             if (!knownPaths.has(image)) {
                 const ctx = context === undefined ? "" : ` in a layer defined in the theme ${context}`
@@ -72,6 +77,7 @@ function validateLayer(layerJson: LayerConfigJson, context?: string): string[] {
         }
 
     } catch (e) {
+        console.error(e)
         return [`Layer ${layerJson.id}` ?? JSON.stringify(layerJson).substring(0, 50) + " is invalid: " + e]
     }
     return errorCount
@@ -80,8 +86,8 @@ function validateLayer(layerJson: LayerConfigJson, context?: string): string[] {
 let layerErrorCount = []
 const knownLayerIds = new Set<string>();
 for (const layerFile of layerFiles) {
-    knownLayerIds.add(layerFile.id)
-    layerErrorCount.push(...validateLayer(layerFile))
+    knownLayerIds.add(layerFile.parsed.id)
+    layerErrorCount.push(...validateLayer(layerFile.parsed, layerFile.path))
 }
 
 let themeErrorCount = []
@@ -90,7 +96,7 @@ for (const themeFile of themeFiles) {
     for (const layer of themeFile.layers) {
         if (typeof layer === "string") {
             if (!knownLayerIds.has(layer)) {
-                themeErrorCount.push("Unknown layer id: " + layer)
+                themeErrorCount.push(`Unknown layer id: ${layer} in theme ${themeFile.id}`)
             }
         } else {
             if (layer.builtin !== undefined) {
@@ -99,7 +105,7 @@ for (const themeFile of themeFiles) {
                 }
             } else {
                 // layer.builtin contains layer overrides - we can skip those
-                layerErrorCount.push(...validateLayer(layer, themeFile.id))
+                layerErrorCount.push(...validateLayer(layer, undefined, themeFile.id))
             }
         }
     }

scripts/generateTaginfoProjectFiles.ts

@@ -0,0 +1,142 @@
+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"
+
+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
+}
+
+function generateLayerUsage(layer: LayerConfig, layout: LayoutConfig): any [] {
+    const usedTags = layer.source.osmTags.asChange({})
+    const result = []
+    for (const kv of usedTags) {
+        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) {
+            let descr = "Layer '" + layer.name.txt + "' (in the MapComplete.osm.be theme '" + layout.title.txt + "')";
+            if (q == undefined) {
+                descr += " shows values with";
+            } else {
+                descr += " shows and asks freeform values for"
+            }
+            descr += " key '" + key + "'"
+            result.push(generateTagOverview({k: key, v: undefined}, descr))
+        }
+
+        const mappings = tr.mappings ?? []
+        for (const mapping of mappings) {
+
+            let descr = "Layer '" + layer.name.txt + "' (in the MapComplete.osm.be theme '" + layout.title.txt + "')";
+            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 
+            ) {
+                descr += " and allows to pick this as a default answer."
+            }
+            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))
+            }
+
+        }
+    }
+    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)
+        "data_updated": generationTime,
+        "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 != "")
+
+console.log("Writing taginfo project filelist");
+writeFileSync(tagInfoList, projectList.join("\n") + "\n");
+