Problem
bregctl init writes registry.yaml and tests/journeys.yaml as JSON documents, byte for byte,
with a .yaml extension. Hand-authored projects in the same fixture set (the facility fixture's
registry.yaml, Casework's casework.yaml, module files) are real YAML, so the inconsistency is
in the generator rather than in what the loader accepts.
Cost
registry.yaml is the first file an adopter opens after bregctl init, and the file they are
expected to edit by hand.
- No comments. JSON has no comment syntax, so a new project cannot record why a field is set
the way it is, in the one file most likely to need that.
- Editor tooling misreads it. Tools key off the extension and offer YAML behaviour over JSON
content.
- It teaches the dialect. Everyone starting from the template inherits JSON style, so real
projects drift away from the documented YAML examples.
Request
Have init emit actual YAML, ideally with comments on the fields a new project is expected to
change.
Found against origin/main at ec0573f3d, binaries 0.32.0-dev.
Problem
bregctl initwritesregistry.yamlandtests/journeys.yamlas JSON documents, byte for byte,with a
.yamlextension. Hand-authored projects in the same fixture set (the facility fixture'sregistry.yaml, Casework'scasework.yaml, module files) are real YAML, so the inconsistency isin the generator rather than in what the loader accepts.
Cost
registry.yamlis the first file an adopter opens afterbregctl init, and the file they areexpected to edit by hand.
the way it is, in the one file most likely to need that.
content.
projects drift away from the documented YAML examples.
Request
Have
initemit actual YAML, ideally with comments on the fields a new project is expected tochange.
Found against
origin/mainatec0573f3d, binaries0.32.0-dev.