Crossing refactoring

.github/workflows/lint.yml

@@ -7,12 +7,12 @@ jobs:
     steps:
       - uses: actions/checkout@v3
       - run: |
-          notJSONs=`find data/ -type f -not -iname "*.json"`
-          for f in $notJSONs
+          disallowedFiles=`find data/ -type f -not -iname "*.json" -not -iname "*.md"`
+          for f in $disallowedFiles
           do
-            echo "::error file=$f::File $f is not a .json file."
+            echo "::error file=$f::File $f is not a .json or .md file."
           done
-          if [ ! -z "$notJSONs" ]; then exit 1; fi
+          if [ ! -z "$disallowedFiles" ]; then exit 1; fi
 
   prettier:
     name: Check for code formatting mistakes
@@ -23,7 +23,6 @@ jobs:
         with:
           node-version-file: '.nvmrc'
       - run: npm clean-install
-      - run: 'for f in `find data/ -type f -not -iname "*.json"`; do echo "::error File $f is not a .json file."; done'
       - run: npm run lint
 
   codespell:
@@ -37,4 +36,3 @@ jobs:
           skip: ./.git,./dist,./data/deprecated.json
           ignore_words_list: "auxilary,casette,cemetary,chancel,discus,extentions,faiway,generat,goverment,guerilla,guyser,kindergarden,ore,pavillion,sculpter,storys,linz,te"
           only_warn: 1
-

data/fields/crossing/markings-BG.json

@@ -2,6 +2,7 @@
     "key": "crossing:markings",
     "type": "combo",
     "label": "{crossing/markings}",
+    "autoSuggestions": false,
     "stringsCrossReference": "{crossing/markings}",
     "iconsCrossReference": "{crossing/markings}",
     "options": [
@@ -15,6 +16,5 @@
         "include": [
             "BG"
         ]
-    },
-    "autoSuggestions": false
+    }
 }

data/fields/crossing/markings-DE-AT-CH.json

@@ -2,6 +2,9 @@
     "key": "crossing:markings",
     "type": "combo",
     "label": "{crossing/markings}",
+    "autoSuggestions": false,
+    "stringsCrossReference": "{crossing/markings}",
+    "iconsCrossReference": "{crossing/markings}",
     "options": [
         "zebra",
         "yes",
@@ -10,9 +13,6 @@
         "dashes",
         "surface"
     ],
-    "autoSuggestions": false,
-    "iconsCrossReference": "{crossing/markings}",
-    "stringsCrossReference": "{crossing/markings}",
     "locationSet": {
         "include": [
             "DE",

data/fields/crossing/markings-PL.json

@@ -2,16 +2,16 @@
     "key": "crossing:markings",
     "type": "combo",
     "label": "{crossing/markings}",
+    "autoSuggestions": false,
+    "stringsCrossReference": "{crossing/markings}",
+    "iconsCrossReference": "{crossing/markings}",
     "options": [
         "zebra",
         "dots",
         "surface",
         "yes",
         "no"
     ],
-    "autoSuggestions": false,
-    "iconsCrossReference": "{crossing/markings}",
-    "stringsCrossReference": "{crossing/markings}",
     "locationSet": {
         "include": [
             "PL"

data/fields/crossing/markings_yes-BG.json

@@ -2,9 +2,10 @@
     "key": "crossing:markings",
     "type": "combo",
     "label": "{crossing/markings}",
+    "autoSuggestions": false,
+    "default": "yes",
     "stringsCrossReference": "{crossing/markings}",
     "iconsCrossReference": "{crossing/markings}",
-    "default": "yes",
     "options": [
         "zebra",
         "no",
@@ -16,6 +17,5 @@
         "include": [
             "BG"
         ]
-    },
-    "autoSuggestions": false
+    }
 }

data/fields/crossing/markings_yes-DE-AT-CH.json

@@ -2,6 +2,10 @@
     "key": "crossing:markings",
     "type": "combo",
     "label": "{crossing/markings}",
+    "autoSuggestions": false,
+    "default": "yes",
+    "stringsCrossReference": "{crossing/markings}",
+    "iconsCrossReference": "{crossing/markings}",
     "options": [
         "zebra",
         "yes",
@@ -10,15 +14,11 @@
         "dashes",
         "surface"
     ],
-    "autoSuggestions": false,
-    "iconsCrossReference": "{crossing/markings}",
-    "stringsCrossReference": "{crossing/markings}",
     "locationSet": {
         "include": [
             "DE",
             "AT",
             "CH"
         ]
-    },
-    "default": "yes"
+    }
 }

data/fields/crossing/markings_yes-PL.json

@@ -2,20 +2,20 @@
     "key": "crossing:markings",
     "type": "combo",
     "label": "{crossing/markings}",
+    "autoSuggestions": false,
+    "default": "yes",
+    "stringsCrossReference": "{crossing/markings}",
+    "iconsCrossReference": "{crossing/markings}",
     "options": [
         "zebra",
         "dots",
         "surface",
         "yes",
         "no"
     ],
-    "autoSuggestions": false,
-    "iconsCrossReference": "{crossing/markings}",
-    "stringsCrossReference": "{crossing/markings}",
     "locationSet": {
         "include": [
             "PL"
         ]
-    },
-    "default": "yes"
+    }
 }

data/fields/crossing/markings_yes.json

@@ -2,9 +2,9 @@
     "key": "crossing:markings",
     "type": "combo",
     "label": "{crossing/markings}",
+    "default": "yes",
     "stringsCrossReference": "{crossing/markings}",
     "iconsCrossReference": "{crossing/markings}",
-    "default": "yes",
     "locationSet": {
         "exclude": [
             "BG",

data/presets/@templates/README.md

@@ -0,0 +1,13 @@
+# About `@templates`
+
+Presets in `@templates` are a convention for a _virtual_ presets that are only used from inside other presets.
+
+The only property that really matter for these special presets are the `fields`.
+
+All other properties can be copied from existing template presets and ignored. They are default values that are meant to match all cases where they might be referenced.
+
+## How to use
+
+Inside another preset, reference the template – or any other preset - like `"{@templates/internet_access}"` in `fields` or  `moreFields`. This will "copy" all the listed fields from the file `data/presets/@templates/internet_access.json`.
+
+You can only "copy" (template) `fields` to (preset) `fields` and (template) `moreFields` to (preset) `moreFields`.

data/presets/@templates/crossing/bicycle_more.json

@@ -0,0 +1,23 @@
+{
+    "moreFields": [
+        "oneway",
+        "access",
+        "segregated"
+    ],
+    "geometry": [
+        "line"
+    ],
+    "tags": {
+        "@template": "crossing/bicycle_more"
+    },
+    "searchable": false,
+    "locationSet": {
+        "include": [
+            "999"
+        ],
+        "exclude": [
+            "999"
+        ]
+    },
+    "name": "{point}"
+}

data/presets/@templates/crossing/defaults.json

@@ -0,0 +1,23 @@
+{
+    "fields": [
+        "crossing/island",
+        "crossing_raised"
+    ],
+    "geometry": [
+        "point",
+        "line"
+    ],
+    "tags": {
+        "@template": "crossing/defaults"
+    },
+    "searchable": false,
+    "locationSet": {
+        "include": [
+            "999"
+        ],
+        "exclude": [
+            "999"
+        ]
+    },
+    "name": "{point}"
+}

data/presets/@templates/crossing/geometry_way_more.json

@@ -0,0 +1,22 @@
+{
+    "moreFields": [
+        "smoothness",
+        "lit"
+    ],
+    "geometry": [
+        "line"
+    ],
+    "tags": {
+        "@template": "crossing/geometry_way_more"
+    },
+    "searchable": false,
+    "locationSet": {
+        "include": [
+            "999"
+        ],
+        "exclude": [
+            "999"
+        ]
+    },
+    "name": "{point}"
+}

data/presets/@templates/crossing/markings.json

@@ -6,7 +6,8 @@
         "crossing/markings-PL"
     ],
     "geometry": [
-        "point"
+        "point",
+        "line"
     ],
     "tags": {
         "@template": "crossing/markings"

data/presets/@templates/crossing/markings_yes.json

@@ -6,7 +6,8 @@
         "crossing/markings_yes-PL"
     ],
     "geometry": [
-        "point"
+        "point",
+        "line"
     ],
     "tags": {
         "@template": "crossing/markings_yes"

data/presets/@templates/crossing/surfacequality.json

@@ -0,0 +1,22 @@
+{
+    "fields": [
+        "surface",
+        "smoothness"
+    ],
+    "geometry": [
+        "line"
+    ],
+    "tags": {
+        "@template": "crossing/surfacequality"
+    },
+    "searchable": false,
+    "locationSet": {
+        "include": [
+            "999"
+        ],
+        "exclude": [
+            "999"
+        ]
+    },
+    "name": "{point}"
+}

data/presets/@templates/crossing/traffic_signal.json

@@ -0,0 +1,24 @@
+{
+    "fields": [
+        "button_operated",
+        "traffic_signals/sound",
+        "traffic_signals/vibration"
+    ],
+    "geometry": [
+        "point",
+        "line"
+    ],
+    "tags": {
+        "@template": "crossing/traffic_signal"
+    },
+    "searchable": false,
+    "locationSet": {
+        "include": [
+            "999"
+        ],
+        "exclude": [
+            "999"
+        ]
+    },
+    "name": "{point}"
+}

data/presets/@templates/crossing/traffic_signal_more.json

@@ -0,0 +1,24 @@
+{
+    "moreFields": [
+        "traffic_signals/arrow",
+        "traffic_signals/countdown",
+        "traffic_signals/minimap"
+    ],
+    "geometry": [
+        "point",
+        "line"
+    ],
+    "tags": {
+        "@template": "crossing/traffic_signal_more"
+    },
+    "searchable": false,
+    "locationSet": {
+        "include": [
+            "999"
+        ],
+        "exclude": [
+            "999"
+        ]
+    },
+    "name": "{point}"
+}

data/presets/highway/crossing.json

@@ -1,15 +1,13 @@
 {
     "fields": [
         "crossing",
-        "tactile_paving",
-        "crossing/island",
         "{@templates/crossing/markings}",
-        "crossing_raised"
+        "{@templates/crossing/defaults}",
+        "tactile_paving"
     ],
     "moreFields": [
-        "flashing_lights",
         "kerb",
-        "oneway"
+        "flashing_lights"
     ],
     "geometry": [
         "vertex"

data/presets/highway/crossing/README.md

@@ -0,0 +1,25 @@
+# About the crossing presets
+
+## General
+
+These presets use fields `@templates` to make sure all have a similar structure.
+Some presets like `traffic_signals` have additional fields and use a different field order.
+Try to keep the file structure very similar so they can be easily compared.
+
+## nodes `highway=crossing + crossing=*`
+
+Crossing nodes are handled by `highway/crossing.json` and `highway/crossing/*.json` (as geometry type `vertex`).
+
+Crossing nodes and crossing ways have a big overlap.
+However, there are a few tags that should _only_ be expected on the crossing node. When crossing ways are present, this also means there are separate ways attached with additional nodes that may hold these additional tags.
+
+There are places in OSM that follow a different tagging style where only crossing ways are used (without the vertex nodes). Those regions might use other conventions on where to place each tag.
+
+## ways `highway=footway|cycleway|path + *=crossing + crossing=*`
+
+Crossing way presets are duplicated per highway class:
+- `/highway/footway/crossing.json`  + `/highway/footway/crossing/*.json`
+- `/highway/cycleway/crossing.json` + `/highway/cycleway/crossing/*.json`
+- `/highway/path/crossing.json`     + `/highway/path/crossing/*.json`
+
+The crossing presets for `/cycleway*` and `/path*` are considered to be relevant for bike traffic and have additional fields that target bike vs. foot traffic.