Skip to main content

Module templates

Module templates 

Source
Expand description

Schema templates execution and planning. Schema/template helpers for change artifacts.

This module reads a change directory and a schema definition (schema.yaml) and produces JSON-friendly status and instruction payloads.

These types are designed for use by the CLI and by any web/API layer that wants to present “what should I do next?” without duplicating the filesystem logic.

Structs§

AgentInstructionResponse
Instruction payload for agent-oriented endpoints.
ApplyInstructionsResponse
Instruction payload for applying a change.
ApplyYaml
Apply-stage configuration from a schema.
ArtifactStatus
Status for one schema artifact for a given change directory.
ArtifactYaml
One artifact definition from a schema.
ChangeStatus
High-level status for a change against a resolved schema.
DependencyInfo
One dependency entry shown alongside artifact instructions.
ExportSchemasResult
Summary of exported schema files.
InstructionsResponse
Instruction payload for building a single artifact.
PeerReviewContext
Complete context payload for rendering peer-review instructions.
ProgressInfo
Progress totals derived from parsed tasks.
ResolvedSchema
A fully-resolved schema (yaml + directory + source).
ReviewAffectedSpecInfo
Affected spec entry derived from change deltas.
ReviewArtifactInfo
Artifact presence information for review instruction rendering.
ReviewTaskSummaryInfo
Aggregate task progress summary for change review.
ReviewTestingPolicy
Testing policy values injected into review instruction output.
ReviewValidationIssueInfo
Serializable validation issue payload for review templates.
SchemaListEntry
One entry in the schema listing returned by list_schemas_detail.
SchemaListResponse
Detailed schema listing suitable for agent consumption.
SchemaYaml
Schema file model (schema.yaml).
TaskDiagnostic
Diagnostic message associated with a task file.
TaskItem
One task parsed from a tracking file (e.g. tasks.md).
TemplateInfo
Information about an artifact template resolved from a schema.
ValidationArtifactYaml
Validation rules for one schema artifact.
ValidationDefaultsYaml
Default validation rules.
ValidationTrackingYaml
Validation rules for a tracking file.
ValidationYaml
Schema validation configuration (validation.yaml).

Enums§

SchemaSource
Where a schema was resolved from.
ValidationLevelYaml
Severity level used by schema-driven validation.
ValidationTrackingSourceYaml
Source used to locate the tracking file.
ValidatorId
Known validator identifiers.
WorkflowError
Errors returned by workflow helpers.

Functions§

compute_apply_instructions
Compute apply-stage instructions and progress for a change.
compute_change_status
Compute the workflow status for every artifact in a change.
compute_review_context
Build the context payload used by agent/review.md.j2.
default_schema_name
Default schema name used when a change does not specify one.
export_embedded_schemas
Export all embedded schema files into a target directory.
list_available_changes
List change directory names under the .ito/changes directory.
list_available_schemas
Lists available schema names discovered from the project, user, embedded, and package schema locations.
list_schemas_detail
List all available schemas with full metadata for agent/UI consumption.
load_composed_user_guidance
Compose scoped and shared user guidance into one guidance string.
load_schema_validation
Load schema validation configuration when present.
load_user_guidance
Load shared user guidance text.
load_user_guidance_for_artifact
Load artifact-scoped user guidance text from .ito/user-prompts/<artifact-id>.md.
read_change_schema
Determines the schema name configured for a change by reading its metadata.
resolve_instructions
Produce user-facing instructions and metadata for performing a single artifact in a change.
resolve_schema
Resolves a schema name into a ResolvedSchema.
resolve_templates
Resolve template paths for every artifact in a schema.
validate_change_name_input
Validates a user-provided change name to ensure it is safe to use as a filesystem path segment.

Type Aliases§

TemplatesError
Backward-compatible alias for callers using the renamed error type.