Skip to main content

Module format

Module format 

Source
Expand description

The spec-format seam: everything the runtime knows about a spec format comes from an Adapter — where the intent lives, what a planning skill may write, what the model is told, how a task is ticked. The judge (verification, evidence, commits) is the same for every format.

Spec Kit is the reference format; OpenSpec runs too. Kiro is detected, so a project in it gets a clear answer instead of “not a project”.

Modules§

openspec
OpenSpec: a change in openspec/changes/<id>/ is the unit of work, its spec deltas’ scenarios are the acceptance examples, its tasks.md is a chain. Parsing and preflight are the speccoder-openspec crate’s; this adapter is the only runtime code that knows OpenSpec.
speckit
GitHub Spec Kit, the reference format: .specify/ and specs/NNN-name/ with spec.md, plan.md and tasks.md. Parsing is the speccoder-speckit crate’s; this adapter is the only runtime code that knows Spec Kit’s paths and words.

Structs§

Assess
The format’s words in the convergence assessment.
BugRefusal
Why a bug cannot be recorded or read here.
BugStep
How a format’s own bug step is run: the hosted skill, its arguments and what it may write.
CommitPrecondition
What a worktree needs committed: a worktree contains only commits.
Extension
An installed extension of the format, as its inventory lists it.
FormatInit
What a new project asks of the format’s own init (spec 101).
InitStep
One command of the format’s own init, as a new project’s plan runs it.
Inventory
The format’s installed extensions.
Messages
What a person is told; texts name the format’s own files and commands.
Opened
The project’s format, resolved and opened.
OracleRequirement
A requirement a review writes tests for: the format’s requirement (US1) with the scenario ids its tests cite (US1-1).
PlanStructure
A unit’s plan structure: phases and stories. Formats without that structure have none.
PlannedTask
One task as the plan checks read it.
Planning
Hosted planning skills.
ReadBug
The triad as a format’s own bug file holds it.
Recorded
Where a quick change was recorded.
RecordedBug
A bug the adapter recorded in a standing unit.
Refused
Why no project was opened.
Rules
Which paths are the format’s intent, and what a hosted planning skill may touch.
Wording
Model-facing fragments; the prompts around them are the same for every format.
Workspace
A project root that all reads are confined to.

Enums§

InventorySource
Which source the inventory was read from.
PhaseKind
What kind of phase a task sits in, as the format’s structure says.

Traits§

Adapter
One spec format the runtime can run.
Detect
What every known format implements: finding its marker.

Functions§

adapter
The adapter of kind, if this build runs it.
adapters
Every adapter this build runs, in detection order.
at
The adapter of a project already opened at root (a worktree’s project, a snapshot’s root): resolved the way open resolved it, the reference format where nothing decides.
bug_refusal_unsupported
Why a project in a format this build detects but does not run has no place for a bug (BUG-NO-UNIT), if it is one.
code_spans
The code spans of a text (between single backticks).
no_found_env
No variables found.
of
The adapter of an inspected project.
open
Opens the project containing start in the requested, configured or detected format.
open_with
open with an explicit choice instead of the process-wide request.
parse_config
[spec] format from a speccoder.toml’s text.
reference
The reference format, the default where no project decides.
request
--format / SPECCODER_FORMAT: chosen once, by the binary, before any command runs.

Type Aliases§

CommandRule
A format’s ruling on a command (argv, whether a planning skill asks): Some(Ok) allowed, Some(Err(why)) refused, None no opinion.
FoundEnv
Rules::found_env: the variables, given a lookup of the command’s environment.