logicsrc/packages/openprd/src/lifecycle.ts
Anthony Ettinger 296775e003
feat(openprd): implement the OpenPRD standard — engine, CLI, conformance bundle (#100)
OpenPRD has existed as a document (docs/openprd.md), a front-matter schema, a
template, and this repo's prd/ collection. Nothing enforced it. This adds the
reference implementation.

@logicsrc/openprd
  - parser: front-matter + the eight `##` sections + numbered requirements.
    `###` stays content so a long Requirements section can be organized, and
    headings or R#-shaped lines inside code fences are ignored
  - validation splits the standard's four conformance rules (filename,
    front-matter schema, id-matches-prefix, eight sections in order) from
    lint (empty section, missing priority tag, numbering gaps, duplicate R#,
    date order, one-sided supersession, stale index). Conformance failures are
    errors; --strict promotes the rest. Stable codes, file, line, hint
  - collection rules the per-file view cannot see: unique ids, monotonic
    numbering with no gaps, 0000 reserved for the template, cross-references
    that resolve
  - lifecycle enforced rather than advisory: Draft cannot jump to Final,
    terminal statuses do not resume, Superseded must name its replacement
  - deterministic index generation, so `prd index` is idempotent and CI can
    diff it
  - front-matter rewriting that leaves the body byte-identical
  - the optional LogicSRC task bridge the standard describes: each R# becomes
    one logicsrc.task, validated against logicsrc-task.schema.json before it
    is emitted; creator DID derived from the author email

CLI: logicsrc prd init|new|list|show|validate|lint|index|status|next|tasks|
export. Exit codes stable for CI (0 ok, 1 invalid, 2 usage, 3 not found).

Conformance bundle: packages/schemas/fixtures/openprd/ — 6 documents that must
validate and 12 that must fail, each naming the error code it must produce.
Several rules depend on the filename, so every fixture records the name it is
validated as.

Docs: an Implementation section in docs/openprd.md (CLI, validation model,
task bridge, conformance bundle), the spec added to the site's docs surface,
nav and sitemap entries, and a README section.

Verification: 76 new tests; full monorepo build and all 451 workspace tests
pass. The suite dogfoods this repo — prd/ validates with zero errors and zero
warnings, the embedded template is byte-identical to docs/openprd/0000-
template.md, and all 210 requirements in PRD 0001 map to schema-valid tasks.
prd/README.md is regenerated by the tool it now ships.

Refs: docs/openprd.md

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-28 04:11:07 -07:00

71 lines
2.1 KiB
TypeScript

import type { PrdStatus } from "./types.js";
/**
* The lifecycle from docs/openprd.md:
*
* Draft → Review → Accepted → Final
* ↘ Rejected
* ↘ Withdrawn
* ↘ Superseded by NNNN
*
* Rejected, Withdrawn, and Superseded are terminal — the standard keeps them
* on disk because the *why* is part of the record, not because they resume.
* A Final PRD can still be superseded by a follow-up.
*/
export const TRANSITIONS: Record<PrdStatus, PrdStatus[]> = {
Draft: ["Review", "Withdrawn"],
Review: ["Accepted", "Rejected", "Withdrawn", "Draft"],
Accepted: ["Final", "Superseded", "Withdrawn"],
Final: ["Superseded"],
Rejected: [],
Withdrawn: [],
Superseded: []
};
export function nextStatuses(from: PrdStatus): PrdStatus[] {
return TRANSITIONS[from] ?? [];
}
export function canTransition(from: PrdStatus, to: PrdStatus): boolean {
return nextStatuses(from).includes(to);
}
export interface TransitionCheck {
ok: boolean;
reason?: string;
/** Front-matter keys the transition requires alongside `status`. */
requires: string[];
}
export function checkTransition(
from: PrdStatus,
to: PrdStatus,
options: { supersededBy?: string | null } = {}
): TransitionCheck {
if (from === to) {
return { ok: false, reason: `PRD is already ${to}`, requires: [] };
}
if (!canTransition(from, to)) {
const allowed = nextStatuses(from);
return {
ok: false,
reason: allowed.length
? `${from} may only move to ${allowed.join(", ")}`
: `${from} is terminal; open a follow-up PRD instead`,
requires: []
};
}
if (to === "Superseded" && !options.supersededBy) {
return {
ok: false,
reason: "Superseded requires the id of the PRD that replaces this one",
requires: ["superseded-by"]
};
}
return { ok: true, requires: to === "Superseded" ? ["superseded-by"] : [] };
}
/** Statuses whose PRDs are still open work rather than historical record. */
export function isActive(status: PrdStatus): boolean {
return status === "Draft" || status === "Review" || status === "Accepted";
}