fission-ai__openspec/openspec/changes/add-instruction-loader/specs/instruction-loader/spec.md at proposal/slice-3-instruction-loader

mirror of https://github.com/Fission-AI/OpenSpec.git synced 2026-09-14 20:16:53 +08:00

Files

T

Tabish Bidiwale 702c163048 proposal: add instruction loader and schema restructure (Slice 3)

Adds two change proposals for implementing Slice 3 of the artifact POC:

1. restructure-schema-directories
   - Move schemas from embedded TS objects to self-contained directories
   - Each schema becomes a directory with schema.yaml + templates/
   - Enables co-located templates for user extensibility
   - 2-level resolution: user override → package built-in

2. add-instruction-loader (depends on #1)
   - Load templates from schema directories
   - Enrich templates with change context (dependencies, next steps)
   - Format change status for CLI output
   - New instruction-loader capability

These proposals complete Slice 3 from docs/artifact_poc.md.

2025-12-26 23:13:13 +11:00

2.6 KiB

Raw Permalink Blame History

ADDED Requirements

Requirement: Template Loading

The system SHALL load templates from schema directories.

Scenario: Template loaded from schema directory

WHEN loadTemplate(schemaName, templatePath) is called
THEN the system loads the template from schemas/<schemaName>/templates/<templatePath>

Scenario: Template not found

WHEN a template file does not exist in the schema's templates directory
THEN the system throws an error with the template path

Requirement: Change Context Loading

The system SHALL load change context combining graph and completion state.

Scenario: Load context for existing change

WHEN loadChangeContext(projectRoot, changeName) is called for an existing change
THEN the system returns a context with graph, completed set, schema name, and change info

Scenario: Load context with custom schema

WHEN loadChangeContext(projectRoot, changeName, schemaName) is called
THEN the system uses the specified schema instead of default

Scenario: Load context for missing change

WHEN loadChangeContext is called for a non-existent change directory
THEN the system returns context with empty completed set

Requirement: Instruction Enrichment

The system SHALL enrich templates with change-specific context.

Scenario: Header with change info

WHEN instructions are generated for an artifact
THEN the output includes change name, artifact ID, schema name, and output path

Scenario: Dependency status shown

WHEN an artifact has dependencies
THEN the output shows each dependency with completion status (done/missing)

Scenario: Next steps shown

WHEN instructions are generated
THEN the output includes which artifacts become available after this one

Scenario: Root artifact dependencies

WHEN an artifact has no dependencies
THEN the dependency section indicates this is a root artifact

Requirement: Status Formatting

The system SHALL format change status as readable output.

Scenario: Format complete change

WHEN all artifacts are completed
THEN status shows all artifacts as "done"

Scenario: Format partial change

WHEN some artifacts are completed
THEN status shows completed as "done", ready as "ready", blocked as "blocked"

Scenario: Show blocked dependencies

WHEN an artifact is blocked
THEN status shows which dependencies are missing

Scenario: Show output paths

WHEN status is formatted
THEN each artifact shows its output path pattern

2.6 KiB Raw Permalink Blame History