Osmwithspace/MapComplete
1
0
Fork 0
forked from MapComplete/MapComplete
Code Pull requests Activity

Docs: improve typing and comments

Browse source
This commit is contained in:
Pieter Vander Vennet 2025-08-17 02:09:14 +02:00
parent 06da7a0cf4
commit eb072ff5a6
1 changed files with 4 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

15
scripts/generateLayerOverview.ts
View file

@ -37,15 +37,8 @@ import { Translatable } from "../src/Models/ThemeConfig/Json/Translatable"
import { ValidateThemeAndLayers } from "../src/Models/ThemeConfig/Conversion/ValidateThemeAndLayers" import { ValidateThemeAndLayers } from "../src/Models/ThemeConfig/Conversion/ValidateThemeAndLayers"
import { ExtractImages } from "../src/Models/ThemeConfig/Conversion/FixImages" import { ExtractImages } from "../src/Models/ThemeConfig/Conversion/FixImages"
import { TagRenderingConfigJson } from "../src/Models/ThemeConfig/Json/TagRenderingConfigJson" import { TagRenderingConfigJson } from "../src/Models/ThemeConfig/Json/TagRenderingConfigJson"
import {
LayerConfigDependencyGraph,
LevelInfo,
} from "../src/Models/ThemeConfig/LayerConfigDependencyGraph"
import { Lists } from "../src/Utils/Lists" import { Lists } from "../src/Utils/Lists"
import { import { LayerConfigDependencyGraph, LevelInfo } from "../src/Models/ThemeConfig/LayerConfigDependencyGraph"
LayerConfigDependencyGraph,
LevelInfo,
} from "../src/Models/ThemeConfig/LayerConfigDependencyGraph"
import { AddContextToTranslations } from "../src/Models/ThemeConfig/Conversion/AddContextToTranslations" import { AddContextToTranslations } from "../src/Models/ThemeConfig/Conversion/AddContextToTranslations"
// This scripts scans 'src/assets/layers/*.json' for layer definition files and 'src/assets/themes/*.json' for theme definition files. // This scripts scans 'src/assets/layers/*.json' for layer definition files and 'src/assets/themes/*.json' for theme definition files.
@ -121,7 +114,7 @@ class AddIconSummary extends DesugaringStep<{ raw: LayerConfigJson; parsed: Laye
static singleton = new AddIconSummary() static singleton = new AddIconSummary()
constructor() { constructor() {
super("AddIconSummary", "Adds an icon summary for quick reference") super("AddIconSummary", "Adds an icon summary ('_layerIcon') for quick reference. This previews how the layer should be shown in e.g. the filter menu")
} }
convert(json: { raw: LayerConfigJson; parsed: LayerConfig }) { convert(json: { raw: LayerConfigJson; parsed: LayerConfig }) {
@ -706,8 +699,8 @@ class LayerOverviewUtils extends Script {
) )
const path = "assets/layers/questions/questions.json" const path = "assets/layers/questions/questions.json"
const sharedQuestionsRaw = this.parseLayer(doesImageExist, prepareLayer, path).raw const sharedQuestionsRaw: LayerConfigJson = this.parseLayer(doesImageExist, prepareLayer, path).raw
const sharedQuestions = new AddContextToTranslations("").convertStrict( const sharedQuestions: LayerConfigJson = new AddContextToTranslations<LayerConfigJson>("").convertStrict(
sharedQuestionsRaw, sharedQuestionsRaw,
ConversionContext.construct(["layers:questions"], []) ConversionContext.construct(["layers:questions"], [])
) )