Expand description
Display and inspection commands. Convert Ito markdown artifacts into JSON-friendly structures.
This module is used by “show”-style commands and APIs. It reads spec and change markdown files from disk and produces lightweight structs that can be serialized to JSON.
Structs§
- Bundled
Spec - One bundled spec entry (id + source path + raw markdown).
- Change
Delta - One delta entry extracted from a change delta spec.
- Change
Show Json - JSON-serializable view of a change (proposal + deltas).
- Delta
Spec File - One loaded delta spec file.
- Requirement
- A single requirement statement and its scenarios.
- Scenario
- One raw scenario block from a spec or delta.
- Spec
Metadata - Additional info included in serialized spec output.
- Spec
Show Json - JSON-serializable view of a spec markdown file.
- Specs
Bundle Json - JSON-serializable view of all main specs bundled together.
Functions§
- bundle_
main_ specs_ markdown - Bundle all main specs under
.ito/specs/*/spec.mdinto a single markdown stream. - bundle_
main_ specs_ show_ json - Bundle all main specs under
.ito/specs/*/spec.mdinto a JSON-friendly structure. - load_
delta_ spec_ file - Load a delta
spec.mdand infer the spec id from its parent directory. - parse_
change_ show_ json - Parse a change id plus its delta spec files into a JSON-friendly structure.
- parse_
spec_ show_ json - Parse spec markdown into a serializable structure.
- read_
change_ delta_ spec_ files - Return all delta spec files for a change from the repository.
- read_
change_ proposal_ markdown - Read the proposal markdown for a change id.
- read_
module_ markdown - Read the raw markdown for a module’s
module.mdfile. - read_
spec_ markdown - Read the markdown for a spec id from
.ito/specs/<id>/spec.md.