ID:WORK-020Status:done
Add Entity Registration to @refrakt-md/plan
Priority:mediumComplexity:unknownSource:ADR-001,SPEC-002,SPEC-008
Add Entity Registration to
Criteria completion
Relationships
Implements 3
Related 6
ID:WORK-021Status:done
Update Plan Documents to Use Xref Syntax
Priority:high
ID:WORK-022Status:done
Build backlog Rune
Priority:mediumComplexity:complex
ID:WORK-023Status:done
Build decision-log Rune
Priority:lowComplexity:moderate
ID:WORK-025Status:done
Milestone Auto-Backlog and Checklist Progress
Priority:lowComplexity:moderate
ID:WORK-035Status:done
plan serve and plan build Commands
Priority:mediumComplexity:complex
ID:WORK-049Status:done
Dependency visualization for plan site
Priority:lowComplexity:complex
Branches 3
History 4
e900a90Created (done)f262d7bContent editedbcb01d8- ☑ Plan package exports `pipelineHooks` with a `register()` hook
- ☑ The hook registers entities for all five rune types: `spec`, `work`, `bug`, `decision`, `milestone`
- ☑ Each entity includes: `id`, `title` (from heading), `url` (page URL), `status`, and type-specific fields
- ☑ Tests cover registration and resolution of all five entity types
6424098Created (pending)
Summary
The @refrakt-md/plan package defines five rune types (spec, work, bug, decision, milestone), each with an id attribute — but the package has no pipelineHooks. This means plan entities are invisible to the xref resolution pipeline.
Add a register() hook to the plan package that scans transformed pages for plan runes and registers them in the EntityRegistry. Once registered, any page can use {% xref "SPEC-008" /%} or {% xref "WORK-015" /%} to link to plan documents.
Acceptance Criteria
- Plan package exports
pipelineHookswith aregister()hook - The hook registers entities for all five rune types:
spec,work,bug,decision,milestone - Each entity includes:
id,title(from heading),url(page URL),status, and type-specific fields {% xref "SPEC-008" /%}resolves to a link when plan content is in the pipeline{% xref "WORK-015" /%}resolves with typework- Type hints work:
{% xref "ADR-001" type="decision" /%}narrows the search - Tests cover registration and resolution of all five entity types
Approach
Follow the pattern in corePipelineHooks.register (packages/runes/src/config.ts). Walk each page's renderable tree, find nodes with typeof matching plan schema types (Spec, Work, Bug, Decision, Milestone), extract the id property meta tag, and call registry.register() with the appropriate entity type and data fields.