Skip to main content

Module show

Module show 

Source
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§

BundledSpec
One bundled spec entry (id + source path + raw markdown).
ChangeDelta
One delta entry extracted from a change delta spec.
ChangeShowJson
JSON-serializable view of a change (proposal + deltas).
DeltaSpecFile
One loaded delta spec file.
Requirement
A single requirement statement and its scenarios.
Scenario
One raw scenario block from a spec or delta.
SpecMetadata
Additional info included in serialized spec output.
SpecShowJson
JSON-serializable view of a spec markdown file.
SpecsBundleJson
JSON-serializable view of all main specs bundled together.

Functions§

bundle_main_specs_markdown
Bundle all main specs under .ito/specs/*/spec.md into a single markdown stream.
bundle_main_specs_show_json
Bundle all main specs under .ito/specs/*/spec.md into a JSON-friendly structure.
load_delta_spec_file
Load a delta spec.md and 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.md file.
read_spec_markdown
Read the markdown for a spec id from .ito/specs/<id>/spec.md.