note
This rune is part of @refrakt-md/plan. Install with npm install @refrakt-md/plan and add "@refrakt-md/plan" to the plugins array in your refrakt.config.json.
Plan Progress
A completion overview built from the plan registry: one block per entity type — a heading, a progress bar showing how far that type has reached its done-state, and a row of per-status badges. It's thin sugar over the generic aggregate rune, so the counting happens at build time against live registry data — no manual tallies.
Each type gets its own bar on purpose: a single mixed bar would conflate different done-states (a work item is done, a bug is fixed, a spec is accepted), which tells you nothing useful.
Default — the actionable set
A bare {% plan-progress /%} covers what you act on day to day: work items and bugs.
{% plan-progress /%}<section data-rune="plan-progress">
<div data-name="group" data-type="work">
<h3 data-name="heading" data-type="work">Work</h3>
<section data-rune="aggregate">
<meta data-field="aggregate-type" content="work">
<meta data-field="aggregate-filter" content="">
<meta data-field="aggregate-value" content="status:done">
<meta data-field="aggregate-group" content="status">
<meta data-field="aggregate-sort" content="">
<meta data-field="aggregate-limit" content="">
<meta data-field="aggregate-empty" content="">
<meta data-field="__aggregate-sentinel" content="true">
<meta data-field="aggregate-body" content="{% progress value=$item.value max=$item.count %}Done{% /progress %}
---
{% badge type="status" sentiment=$item.sentiment %}{% $item.count %} {% humanize($item.key) %}{% /badge %}
---
No items yet.
">
</section>
</div>
<div data-name="group" data-type="bug">
<h3 data-name="heading" data-type="bug">Bugs</h3>
<section data-rune="aggregate">
<meta data-field="aggregate-type" content="bug">
<meta data-field="aggregate-filter" content="">
<meta data-field="aggregate-value" content="status:fixed">
<meta data-field="aggregate-group" content="status">
<meta data-field="aggregate-sort" content="">
<meta data-field="aggregate-limit" content="">
<meta data-field="aggregate-empty" content="">
<meta data-field="__aggregate-sentinel" content="true">
<meta data-field="aggregate-body" content="{% progress value=$item.value max=$item.count %}Fixed{% /progress %}
---
{% badge type="status" sentiment=$item.sentiment %}{% $item.count %} {% humanize($item.key) %}{% /badge %}
---
No items yet.
">
</section>
</div>
</section>Work
Done368/429
1 Blocked
4 In Progress
4 Review
30 Ready
17 Pending
5 Draft
368 Done
Bugs
Fixed3/8
1 In Progress
2 Confirmed
2 Reported
3 Fixed
<section class="rf-plan-progress" data-rune="plan-progress" data-density="full">
<div data-name="group" data-type="work" class="rf-plan-progress__group">
<h3 data-name="heading" data-type="work" class="rf-plan-progress__heading">Work</h3>
<section class="rf-aggregate" data-aggregate="breakdown" data-rune="aggregate" data-density="full">
<div data-name="preamble" class="rf-aggregate__preamble rf-aggregate__preamble">
<p>
<div class="rf-progress" role="progressbar" aria-valuemin="0" aria-valuenow="368" aria-valuemax="429" aria-label="Done" style="--rf-progress: 86%" data-rune="progress" data-density="full">
<span data-name="label" class="rf-progress__label">Done</span>
<span data-name="value" class="rf-progress__value">368/429</span>
<span data-name="track" class="rf-progress__track">
<span data-name="fill" class="rf-progress__fill"></span>
</span>
</div>
</p>
</div>
<div data-name="items" class="rf-aggregate__items rf-aggregate__items">
<div class="rf-aggregate__group" data-group="blocked" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="negative" data-meta-type="status" data-rune="badge" data-density="full">
1
Blocked
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="in-progress" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="neutral" data-meta-type="status" data-rune="badge" data-density="full">
4
In Progress
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="review" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="caution" data-meta-type="status" data-rune="badge" data-density="full">
4
Review
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="ready" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="neutral" data-meta-type="status" data-rune="badge" data-density="full">
30
Ready
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="pending" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="" data-meta-type="status" data-rune="badge" data-density="full">
17
Pending
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="draft" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="neutral" data-meta-type="status" data-rune="badge" data-density="full">
5
Draft
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="done" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="positive" data-meta-type="status" data-rune="badge" data-density="full">
368
Done
</span>
</p>
</div>
</div>
</section>
</div>
<div data-name="group" data-type="bug" class="rf-plan-progress__group">
<h3 data-name="heading" data-type="bug" class="rf-plan-progress__heading">Bugs</h3>
<section class="rf-aggregate" data-aggregate="breakdown" data-rune="aggregate" data-density="full">
<div data-name="preamble" class="rf-aggregate__preamble rf-aggregate__preamble">
<p>
<div class="rf-progress" role="progressbar" aria-valuemin="0" aria-valuenow="3" aria-valuemax="8" aria-label="Fixed" style="--rf-progress: 38%" data-rune="progress" data-density="full">
<span data-name="label" class="rf-progress__label">Fixed</span>
<span data-name="value" class="rf-progress__value">3/8</span>
<span data-name="track" class="rf-progress__track">
<span data-name="fill" class="rf-progress__fill"></span>
</span>
</div>
</p>
</div>
<div data-name="items" class="rf-aggregate__items rf-aggregate__items">
<div class="rf-aggregate__group" data-group="in-progress" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="neutral" data-meta-type="status" data-rune="badge" data-density="full">
1
In Progress
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="confirmed" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="caution" data-meta-type="status" data-rune="badge" data-density="full">
2
Confirmed
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="reported" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="neutral" data-meta-type="status" data-rune="badge" data-density="full">
2
Reported
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="fixed" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="positive" data-meta-type="status" data-rune="badge" data-density="full">
3
Fixed
</span>
</p>
</div>
</div>
</section>
</div>
</section>Every type
Widen to the full plan set with show="all" — or list exactly the types you want via type=:
{% plan-progress show="all" /%}<section data-rune="plan-progress">
<div data-name="group" data-type="work">
<h3 data-name="heading" data-type="work">Work</h3>
<section data-rune="aggregate">
<meta data-field="aggregate-type" content="work">
<meta data-field="aggregate-filter" content="">
<meta data-field="aggregate-value" content="status:done">
<meta data-field="aggregate-group" content="status">
<meta data-field="aggregate-sort" content="">
<meta data-field="aggregate-limit" content="">
<meta data-field="aggregate-empty" content="">
<meta data-field="__aggregate-sentinel" content="true">
<meta data-field="aggregate-body" content="{% progress value=$item.value max=$item.count %}Done{% /progress %}
---
{% badge type="status" sentiment=$item.sentiment %}{% $item.count %} {% humanize($item.key) %}{% /badge %}
---
No items yet.
">
</section>
</div>
<div data-name="group" data-type="bug">
<h3 data-name="heading" data-type="bug">Bugs</h3>
<section data-rune="aggregate">
<meta data-field="aggregate-type" content="bug">
<meta data-field="aggregate-filter" content="">
<meta data-field="aggregate-value" content="status:fixed">
<meta data-field="aggregate-group" content="status">
<meta data-field="aggregate-sort" content="">
<meta data-field="aggregate-limit" content="">
<meta data-field="aggregate-empty" content="">
<meta data-field="__aggregate-sentinel" content="true">
<meta data-field="aggregate-body" content="{% progress value=$item.value max=$item.count %}Fixed{% /progress %}
---
{% badge type="status" sentiment=$item.sentiment %}{% $item.count %} {% humanize($item.key) %}{% /badge %}
---
No items yet.
">
</section>
</div>
<div data-name="group" data-type="spec">
<h3 data-name="heading" data-type="spec">Specs</h3>
<section data-rune="aggregate">
<meta data-field="aggregate-type" content="spec">
<meta data-field="aggregate-filter" content="">
<meta data-field="aggregate-value" content="status:accepted">
<meta data-field="aggregate-group" content="status">
<meta data-field="aggregate-sort" content="">
<meta data-field="aggregate-limit" content="">
<meta data-field="aggregate-empty" content="">
<meta data-field="__aggregate-sentinel" content="true">
<meta data-field="aggregate-body" content="{% progress value=$item.value max=$item.count %}Accepted{% /progress %}
---
{% badge type="status" sentiment=$item.sentiment %}{% $item.count %} {% humanize($item.key) %}{% /badge %}
---
No items yet.
">
</section>
</div>
<div data-name="group" data-type="decision">
<h3 data-name="heading" data-type="decision">Decisions</h3>
<section data-rune="aggregate">
<meta data-field="aggregate-type" content="decision">
<meta data-field="aggregate-filter" content="">
<meta data-field="aggregate-value" content="status:accepted">
<meta data-field="aggregate-group" content="status">
<meta data-field="aggregate-sort" content="">
<meta data-field="aggregate-limit" content="">
<meta data-field="aggregate-empty" content="">
<meta data-field="__aggregate-sentinel" content="true">
<meta data-field="aggregate-body" content="{% progress value=$item.value max=$item.count %}Accepted{% /progress %}
---
{% badge type="status" sentiment=$item.sentiment %}{% $item.count %} {% humanize($item.key) %}{% /badge %}
---
No items yet.
">
</section>
</div>
<div data-name="group" data-type="milestone">
<h3 data-name="heading" data-type="milestone">Milestones</h3>
<section data-rune="aggregate">
<meta data-field="aggregate-type" content="milestone">
<meta data-field="aggregate-filter" content="">
<meta data-field="aggregate-value" content="status:complete">
<meta data-field="aggregate-group" content="status">
<meta data-field="aggregate-sort" content="">
<meta data-field="aggregate-limit" content="">
<meta data-field="aggregate-empty" content="">
<meta data-field="__aggregate-sentinel" content="true">
<meta data-field="aggregate-body" content="{% progress value=$item.value max=$item.count %}Complete{% /progress %}
---
{% badge type="status" sentiment=$item.sentiment %}{% $item.count %} {% humanize($item.key) %}{% /badge %}
---
No items yet.
">
</section>
</div>
</section>Work
Done368/429
1 Blocked
4 In Progress
4 Review
30 Ready
17 Pending
5 Draft
368 Done
Bugs
Fixed3/8
1 In Progress
2 Confirmed
2 Reported
3 Fixed
Specs
Accepted27/102
68 Draft
4 Review
27 Accepted
1 Superseded
2 Placeholder
Decisions
Accepted14/22
8 Proposed
14 Accepted
Milestones
Complete13/24
6 Planning
5 Active
13 Complete
<section class="rf-plan-progress" data-rune="plan-progress" data-density="full">
<div data-name="group" data-type="work" class="rf-plan-progress__group">
<h3 data-name="heading" data-type="work" class="rf-plan-progress__heading">Work</h3>
<section class="rf-aggregate" data-aggregate="breakdown" data-rune="aggregate" data-density="full">
<div data-name="preamble" class="rf-aggregate__preamble rf-aggregate__preamble">
<p>
<div class="rf-progress" role="progressbar" aria-valuemin="0" aria-valuenow="368" aria-valuemax="429" aria-label="Done" style="--rf-progress: 86%" data-rune="progress" data-density="full">
<span data-name="label" class="rf-progress__label">Done</span>
<span data-name="value" class="rf-progress__value">368/429</span>
<span data-name="track" class="rf-progress__track">
<span data-name="fill" class="rf-progress__fill"></span>
</span>
</div>
</p>
</div>
<div data-name="items" class="rf-aggregate__items rf-aggregate__items">
<div class="rf-aggregate__group" data-group="blocked" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="negative" data-meta-type="status" data-rune="badge" data-density="full">
1
Blocked
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="in-progress" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="neutral" data-meta-type="status" data-rune="badge" data-density="full">
4
In Progress
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="review" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="caution" data-meta-type="status" data-rune="badge" data-density="full">
4
Review
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="ready" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="neutral" data-meta-type="status" data-rune="badge" data-density="full">
30
Ready
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="pending" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="" data-meta-type="status" data-rune="badge" data-density="full">
17
Pending
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="draft" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="neutral" data-meta-type="status" data-rune="badge" data-density="full">
5
Draft
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="done" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="positive" data-meta-type="status" data-rune="badge" data-density="full">
368
Done
</span>
</p>
</div>
</div>
</section>
</div>
<div data-name="group" data-type="bug" class="rf-plan-progress__group">
<h3 data-name="heading" data-type="bug" class="rf-plan-progress__heading">Bugs</h3>
<section class="rf-aggregate" data-aggregate="breakdown" data-rune="aggregate" data-density="full">
<div data-name="preamble" class="rf-aggregate__preamble rf-aggregate__preamble">
<p>
<div class="rf-progress" role="progressbar" aria-valuemin="0" aria-valuenow="3" aria-valuemax="8" aria-label="Fixed" style="--rf-progress: 38%" data-rune="progress" data-density="full">
<span data-name="label" class="rf-progress__label">Fixed</span>
<span data-name="value" class="rf-progress__value">3/8</span>
<span data-name="track" class="rf-progress__track">
<span data-name="fill" class="rf-progress__fill"></span>
</span>
</div>
</p>
</div>
<div data-name="items" class="rf-aggregate__items rf-aggregate__items">
<div class="rf-aggregate__group" data-group="in-progress" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="neutral" data-meta-type="status" data-rune="badge" data-density="full">
1
In Progress
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="confirmed" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="caution" data-meta-type="status" data-rune="badge" data-density="full">
2
Confirmed
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="reported" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="neutral" data-meta-type="status" data-rune="badge" data-density="full">
2
Reported
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="fixed" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="positive" data-meta-type="status" data-rune="badge" data-density="full">
3
Fixed
</span>
</p>
</div>
</div>
</section>
</div>
<div data-name="group" data-type="spec" class="rf-plan-progress__group">
<h3 data-name="heading" data-type="spec" class="rf-plan-progress__heading">Specs</h3>
<section class="rf-aggregate" data-aggregate="breakdown" data-rune="aggregate" data-density="full">
<div data-name="preamble" class="rf-aggregate__preamble rf-aggregate__preamble">
<p>
<div class="rf-progress" role="progressbar" aria-valuemin="0" aria-valuenow="27" aria-valuemax="102" aria-label="Accepted" style="--rf-progress: 26%" data-rune="progress" data-density="full">
<span data-name="label" class="rf-progress__label">Accepted</span>
<span data-name="value" class="rf-progress__value">27/102</span>
<span data-name="track" class="rf-progress__track">
<span data-name="fill" class="rf-progress__fill"></span>
</span>
</div>
</p>
</div>
<div data-name="items" class="rf-aggregate__items rf-aggregate__items">
<div class="rf-aggregate__group" data-group="draft" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="neutral" data-meta-type="status" data-rune="badge" data-density="full">
68
Draft
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="review" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="caution" data-meta-type="status" data-rune="badge" data-density="full">
4
Review
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="accepted" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="positive" data-meta-type="status" data-rune="badge" data-density="full">
27
Accepted
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="superseded" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="caution" data-meta-type="status" data-rune="badge" data-density="full">
1
Superseded
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="placeholder" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="" data-meta-type="status" data-rune="badge" data-density="full">
2
Placeholder
</span>
</p>
</div>
</div>
</section>
</div>
<div data-name="group" data-type="decision" class="rf-plan-progress__group">
<h3 data-name="heading" data-type="decision" class="rf-plan-progress__heading">Decisions</h3>
<section class="rf-aggregate" data-aggregate="breakdown" data-rune="aggregate" data-density="full">
<div data-name="preamble" class="rf-aggregate__preamble rf-aggregate__preamble">
<p>
<div class="rf-progress" role="progressbar" aria-valuemin="0" aria-valuenow="14" aria-valuemax="22" aria-label="Accepted" style="--rf-progress: 64%" data-rune="progress" data-density="full">
<span data-name="label" class="rf-progress__label">Accepted</span>
<span data-name="value" class="rf-progress__value">14/22</span>
<span data-name="track" class="rf-progress__track">
<span data-name="fill" class="rf-progress__fill"></span>
</span>
</div>
</p>
</div>
<div data-name="items" class="rf-aggregate__items rf-aggregate__items">
<div class="rf-aggregate__group" data-group="proposed" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="neutral" data-meta-type="status" data-rune="badge" data-density="full">
8
Proposed
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="accepted" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="positive" data-meta-type="status" data-rune="badge" data-density="full">
14
Accepted
</span>
</p>
</div>
</div>
</section>
</div>
<div data-name="group" data-type="milestone" class="rf-plan-progress__group">
<h3 data-name="heading" data-type="milestone" class="rf-plan-progress__heading">Milestones</h3>
<section class="rf-aggregate" data-aggregate="breakdown" data-rune="aggregate" data-density="full">
<div data-name="preamble" class="rf-aggregate__preamble rf-aggregate__preamble">
<p>
<div class="rf-progress" role="progressbar" aria-valuemin="0" aria-valuenow="13" aria-valuemax="24" aria-label="Complete" style="--rf-progress: 54%" data-rune="progress" data-density="full">
<span data-name="label" class="rf-progress__label">Complete</span>
<span data-name="value" class="rf-progress__value">13/24</span>
<span data-name="track" class="rf-progress__track">
<span data-name="fill" class="rf-progress__fill"></span>
</span>
</div>
</p>
</div>
<div data-name="items" class="rf-aggregate__items rf-aggregate__items">
<div class="rf-aggregate__group" data-group="planning" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="neutral" data-meta-type="status" data-rune="badge" data-density="full">
6
Planning
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="active" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="positive" data-meta-type="status" data-rune="badge" data-density="full">
5
Active
</span>
</p>
</div>
<div class="rf-aggregate__group" data-group="complete" data-block="">
<p>
<span class="rf-badge rf-badge" data-meta-sentiment="positive" data-meta-type="status" data-rune="badge" data-density="full">
13
Complete
</span>
</p>
</div>
</div>
</section>
</div>
</section>Scoping
milestone= lowers to a registry filter, so every bar counts only that milestone's items:
{% plan-progress milestone="v1.0.0" /%}
Scope to a single type with type= — its done-state drives the bar:
{% plan-progress type="spec" /%}
Attributes
| Attribute | Type | Default | Description |
|---|---|---|---|
type | string | work,bug | Entity type(s) to chart, comma-separated: work, bug, spec, decision, milestone. |
show | string | — | Legacy alias for type; all expands to the full plan set. |
milestone | string | — | Scope every bar to a milestone — lowers to filter="milestone:…". |
filter | string | — | Raw field:value filter clauses (collection grammar); overrides milestone. |
value | string | per type | Override the achieved-subset clause for every bar (default: each type's terminal-positive status). |
How it composes
plan-progress emits one {% aggregate %} per type (group="status", value="status:<that type's done-state>") and lets aggregate resolve the counts. The bar is the progress rune, labelled with the achieved status — Done (work), Fixed (bug), Accepted (spec / decision), Complete (milestone) — with the count shown alongside. The breakdown is one badge per status. (Per-status badge colour is on the roadmap — it needs per-group sentiment projection in aggregate.)