aidotse / aidotse/behovskartan

Implement a more robust way of writing parameters.yaml

Aperta
#88 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Jupyter Notebook
Stelle
0
Fork
0
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

We currently use string replacement in parameters-template.yaml (e.g. {{SCENARIO_PROPERTIES}}), which preserves comments but lacks structure and validation.

Recommended options:
Use yaml (eemeli/yaml) AST library ✅

Preserves comments and formatting

Allows programmatic injection of schema blocks

Supports attaching inline comments via commentBefore

Use Handlebars templates 🟡

Preserves surrounding comments

Good for injecting dynamic blocks

Less robust for nested YAML editing

Use a parallel .comments.md or .yaml.comments.json file 🟢

Separates logic and documentation

Useful if generating OpenAPI for both code and docs

✳️ Recommended: Switch to the yaml library for AST-based injection while preserving comments inline.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.