dotmd-cli 0.83.0 → 0.84.0

package/README.md

@@ -213,6 +213,9 @@ runlist new plan platform-work --coordination
 runlist runlists
 ```
 
+`runlist new hub platform-work` makes the same coordination hub; add
+`--runlist a,b,c` or `--roadmap` for the other two shapes.
+
 For progress across several runlists, create a roadmap:
 
 ```bash
@@ -225,6 +228,37 @@ Roadmaps roll up progress recursively and choose the first startable plan across
 their child runlists. Runlists and roadmaps are held out of actionable plan
 counts so dashboards do not double-count their children.
 
+## Decisions
+
+A decision is an entry in its plan, not a document of its own. Write the record
+(the situation, what exists today, what each answer leaves in place) to a file
+and add it:
+
+```bash
+runlist new decision auth-revamp --question "Which token store?" @record.md
+```
+
+It takes the next id (`D1`, `D2`, …) that no decision item in that plan uses,
+lands at the end of the plan's top-level decisions section (created before
+`## Version History` when there is none) with a `Disposition: OPEN.` line, and
+refuses an empty record. `--disposition held` parks it instead.
+
+A corpus that indexes its decisions in one register numbers them in one
+sequence. Name the register, and the id follows the highest the register or the
+plan uses, and the register gets the entry's row in the same locked write:
+
+```js
+export const decisions = {
+  section: 'Decisions',
+  prefix: 'D',
+  register: { file: 'docs/plans/register.md', statusLine: 'waiting on you:' },
+};
+```
+
+The register block is the fenced block whose first line carries `statusLine`.
+The row is the question plus `--answers` (what each answer leaves in place),
+which is required when a register is configured.
+
 ## Safety Model
 
 - Mutation commands support `--dry-run` / `-n`.

package/bin/dotmd.mjs

@@ -1001,6 +1001,21 @@ Examples:
   EOF
   runlist new prompt cleanup-tomorrow "look at remaining lint warnings"
 
+Hubs and decisions:
+  runlist new hub <slug>                     # coordination hub (a plan)
+  runlist new hub <slug> --runlist a,b,c     # sprint hub plus child plans
+  runlist new hub <slug> --roadmap           # roadmap hub
+  runlist new decision <plan> --question "<question>" [--answers "<…>"] @record.md
+                       Adds the next numbered entry to the plan's top-level
+                       decisions section with a \`Disposition: OPEN.\` line (or
+                       \`--disposition held\`) and the record, which is required;
+                       a plan with no such section gets \`## Decisions\`. With a
+                       register in config, the id is numbered across the corpus
+                       and the register gets its row, question plus --answers
+                       (required then), in the same locked write. Config:
+                       \`export const decisions = { section, prefix,
+                       register: { file, statusLine } }\`.
+
 Scaffolding runlists (plans only):
   --runlist <a,b,c>    Create a sprint runlist hub plus one child plan per slug.
                        The hub carries \`runlist: [<hub>-01-a.md, <hub>-02-b.md, …]\`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotmd-cli",
-  "version": "0.83.0",
+  "version": "0.84.0",
   "description": "CLI for managing markdown documents with YAML frontmatter — index, query, validate, graph, export, lifecycle, and AI summaries.",
   "type": "module",
   "license": "MIT",

package/src/config.mjs

@@ -137,6 +137,8 @@ const DEFAULTS = {
   templates: {},
 
   glossary: null,
+  // `runlist new decision`: { section, prefix, register: { file, statusLine } }.
+  decisions: null,
 
   // Opt-in JSONL command journal at .dotmd/journal.jsonl. Default off — agents
   // and users who want usage observability flip this on (or set RUNLIST_JOURNAL=1).
@@ -417,6 +419,14 @@ function validateConfig(userConfig, config, validStatuses, indexPath) {
     }
   }
 
+  if (userConfig.decisions != null) {
+    const d = userConfig.decisions;
+    if (typeof d !== 'object' || Array.isArray(d)) warnings.push('Config: decisions must be an object.');
+    else if (d.register != null && (typeof d.register?.file !== 'string' || typeof d.register?.statusLine !== 'string')) {
+      warnings.push('Config: decisions.register needs a file and a statusLine.');
+    }
+  }
+
   // Unknown top-level user config keys
   for (const key of Object.keys(userConfig)) {
     if (!VALID_CONFIG_KEYS.has(key)) {

package/src/decision.mjs

@@ -0,0 +1,220 @@
+import { readFileSync } from 'node:fs';
+import path from 'node:path';
+import { mutateFileSet } from './atomic-mutation.mjs';
+import { authorizeManagedSource } from './managed-path.mjs';
+import { walkSections } from './section.mjs';
+import { die, nowIso, resolveDocPath, toRepoPath } from './util.mjs';
+import { green, dim } from './color.mjs';
+
+// `runlist new decision <plan> --question "…" @record.md`
+//
+// A decision is not a document of its own: it is an entry in the owning plan's
+// decisions section, carrying an id, a disposition and a written record. This
+// adds one, numbered after the highest id of its prefix the plan (and the
+// register, when there is one) already uses, at the end of the plan's top-level
+// decisions section, creating `## Decisions` when the plan has none. A
+// decisions heading nested inside a workstream is that workstream's record and
+// is left alone.
+//
+// Config (`runlist.config.mjs`), all optional:
+//   export const decisions = {
+//     section: 'Decisions',   // the heading the entry lands under
+//     prefix: 'D',            // what a new id is written under
+//     register: { file: 'docs/plans/register.md', statusLine: 'waiting on you:' },
+//   };
+// With a register, ids are one sequence across the corpus: the next id is
+// numbered after the highest the register or the plan uses, and the register
+// gets the entry's index row in the same locked write as the plan. Without
+// one, ids are plan-local.
+
+const DISPOSITIONS = new Set(['open', 'held']);
+const DECISION_HEADING = /\bdecisions?\b/i;
+
+function splitDoc(raw) {
+  if (!raw.startsWith('---\n')) return null;
+  const end = raw.indexOf('\n---\n', 4);
+  if (end === -1) return null;
+  return { frontmatter: raw.slice(4, end), body: raw.slice(end + 5) };
+}
+
+function stripFences(text) {
+  return text.replace(/^(`{3,}|~{3,})[^\n]*\n[\s\S]*?^\1[^\n]*$/gm, '');
+}
+
+const escapeRe = text => text.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+
+// Ids are read where a decision item starts (a heading, a list or bold lead,
+// a table row or a register row), never from prose, where the same shape is
+// as likely to be a job code or a citation of another plan's decision.
+function highestId(text, prefix) {
+  const re = new RegExp(`^\\s*(?:#{1,6}\\s+|[-*]\\s+(?:\\[[ xX]\\]\\s+)?|\\|\\s*)?\\**${escapeRe(prefix)}(\\d{1,4})\\b`);
+  let max = 0;
+  for (const line of text.split('\n')) {
+    const m = line.match(re);
+    if (m) max = Math.max(max, Number(m[1]));
+  }
+  return max;
+}
+
+export function nextDecisionId(body, prefix, register = null) {
+  let max = highestId(stripFences(body), prefix);
+  if (register) {
+    const rows = register.rows.map(row => row.match(new RegExp(`^${escapeRe(prefix)}(\\d{1,4})\\b`))?.[1]);
+    for (const n of rows) if (n) max = Math.max(max, Number(n));
+  }
+  return `${prefix}${max + 1}`;
+}
+
+// The register block: a fence whose first line carries the configured status
+// line. Returns its rows and where the closing fence sits, or null.
+export function findRegister(text, statusLine) {
+  const lines = text.split('\n');
+  const wanted = statusLine.trim().toLowerCase();
+  for (let i = 0; i < lines.length; i++) {
+    const open = lines[i].match(/^(`{3,}|~{3,})/);
+    if (!open) continue;
+    let close = i + 1;
+    while (close < lines.length && !lines[close].startsWith(open[1])) close++;
+    if (close >= lines.length) return null;
+    const first = (lines[i + 1] ?? '').trim().toLowerCase();
+    if (first.includes(wanted)) {
+      return { closeLine: close, rows: lines.slice(i + 2, close).filter(line => line.trim()) };
+    }
+    i = close;
+  }
+  return null;
+}
+
+export function insertRegisterRow(text, register, row) {
+  const lines = text.split('\n');
+  let at = register.closeLine;
+  while (at > 0 && lines[at - 1].trim() === '') at--;
+  lines.splice(at, 0, row);
+  return lines.join('\n');
+}
+
+// Returns the new body and where the entry went. Pure, for tests.
+export function insertDecision(body, { id, question, disposition, record, section: heading = 'Decisions' }) {
+  const lines = body.split('\n');
+  const sections = walkSections(body);
+  const named = s => s.heading.replace(/[^\w\s]+$/, '').trim().toLowerCase() === heading.toLowerCase();
+  const section = sections.find(s => s.level === 2 && named(s))
+    ?? sections.find(s => s.level === 2 && DECISION_HEADING.test(s.heading));
+  const level = section ? Math.min(section.level + 1, 6) : 3;
+  const entry = [
+    `${'#'.repeat(level)} ${id}  ${question.trim()}`,
+    '',
+    `Disposition: ${disposition.toUpperCase()}.`,
+    '',
+    record.trim(),
+  ];
+
+  if (section) {
+    // After the section's last non-blank line, subsections included.
+    let at = section.lineEnd;
+    while (at > section.lineStart && lines[at - 1].trim() === '') at--;
+    const tail = at < lines.length && lines[at].trim() !== '' ? [''] : [];
+    lines.splice(at, 0, '', ...entry, ...tail);
+    return { body: lines.join('\n'), placement: `under \`${section.heading}\``, heading: section.heading };
+  }
+
+  const block = [`## ${heading}`, '', ...entry];
+  const before = sections.find(s => s.level === 2 && /^(version history|closeout)\b/i.test(s.heading));
+  if (before) {
+    lines.splice(before.lineStart - 1, 0, ...block, '');
+    return { body: lines.join('\n'), placement: `in a new \`## ${heading}\` before \`${before.heading}\``, heading };
+  }
+  const trimmed = body.replace(/\n+$/, '');
+  return { body: `${trimmed}\n\n${block.join('\n')}\n`, placement: `in a new \`## ${heading}\` at the end`, heading };
+}
+
+export function runNewDecision({ planArg, question, disposition, record, answers = null }, config, { dryRun = false } = {}) {
+  const usage = 'Usage: runlist new decision <plan> --question "<the question>" @record.md';
+  if (!planArg) die(`${usage}\nThe plan is the file whose decisions section gets the entry.`);
+  if (!question || !question.trim()) die(`--question is required.\n${usage}`);
+  if (/\n/.test(question)) die('--question is one line; the record carries the rest.');
+  if (!record || !record.trim()) {
+    die('A decision needs its record: the situation, what exists today, and what each answer leaves in place.\n'
+      + `Write it to a file and pass @path, pipe it in, or pass --body "...".\n${usage}`);
+  }
+  disposition = (disposition ?? 'open').toLowerCase();
+  if (!DISPOSITIONS.has(disposition)) {
+    die(`--disposition must be open or held; a ruled or closed decision is edited in place, not added.`);
+  }
+
+  const resolved = resolveDocPath(planArg, config)
+    ?? (planArg.endsWith('.md') ? null : resolveDocPath(`${planArg}.md`, config))
+    ?? (planArg.includes('/') ? null : resolveDocPath(path.join('plans', `${planArg}.md`), config));
+  if (!resolved) die(`No such plan: ${planArg}`);
+  const planPath = authorizeManagedSource(resolved, config, { kind: 'Decision target' }).path;
+  const planRepoPath = toRepoPath(planPath, config.repoRoot);
+
+  const settings = config.raw?.decisions ?? {};
+  const prefix = settings.prefix ?? 'D';
+  const section = settings.section ?? 'Decisions';
+  let registerPath = null;
+  if (settings.register?.file) {
+    if (!settings.register.statusLine) die('decisions.register needs a statusLine: the first line of the register block.');
+    const registerResolved = resolveDocPath(settings.register.file, config);
+    if (!registerResolved) die(`The decisions register in config does not exist: ${settings.register.file}`);
+    registerPath = authorizeManagedSource(registerResolved, config, { kind: 'Decision register' }).path;
+  }
+  const sameFile = registerPath === planPath;
+  if (registerPath && (!answers || !answers.trim())) {
+    die('--answers is required with a register: the row says what each answer leaves in place and what it costs.\n'
+      + `${usage} --answers "Yes: … No: …"`);
+  }
+
+  const today = nowIso();
+  const planRaw = readFileSync(planPath, 'utf8');
+  const registerRaw = registerPath && !sameFile ? readFileSync(registerPath, 'utf8') : null;
+
+  const planDoc = splitDoc(planRaw.replace(/\r\n/g, '\n'));
+  if (!planDoc) die(`${planRepoPath} has no frontmatter block; runlist only adds decisions to managed documents.`);
+  const registerText = sameFile ? planDoc.body : registerRaw?.replace(/\r\n/g, '\n');
+  const register = registerPath ? findRegister(registerText, settings.register.statusLine) : null;
+  if (registerPath && !register) {
+    die(`${toRepoPath(registerPath, config.repoRoot)} has no block whose first line carries "${settings.register.statusLine}".`);
+  }
+
+  const id = nextDecisionId(planDoc.body, prefix, register);
+  const inserted = insertDecision(planDoc.body, { id, question, disposition, record, section });
+  let planBody = inserted.body;
+  let row = null;
+  if (register && sameFile) {
+    row = registerRow({ id, disposition, today, question, answers, heading: inserted.heading, link: path.basename(planPath) });
+    planBody = insertRegisterRow(planBody, findRegister(planBody, settings.register.statusLine), row);
+  }
+  const bump = fm => (/^updated:/m.test(fm) ? fm.replace(/^updated:.*$/m, `updated: ${today}`) : fm);
+  const planOut = `---\n${bump(planDoc.frontmatter)}\n---\n${planBody}`;
+
+  const updates = [{ path: planPath, expectedContent: planRaw, content: planOut }];
+  if (register && !sameFile) {
+    const link = path.relative(path.dirname(registerPath), planPath).split(path.sep).join('/');
+    row = registerRow({ id, disposition, today, question, answers, heading: inserted.heading, link });
+    const registerOut = insertRegisterRow(registerText, register, row);
+    const registerDoc = splitDoc(registerOut);
+    updates.push({
+      path: registerPath,
+      expectedContent: registerRaw,
+      content: registerDoc ? `---\n${bump(registerDoc.frontmatter)}\n---\n${registerDoc.body}` : registerOut,
+    });
+  }
+
+  const registerRepoPath = registerPath ? toRepoPath(registerPath, config.repoRoot) : null;
+  if (dryRun) {
+    process.stdout.write(`[dry-run] Would add ${id} to ${planRepoPath} ${inserted.placement}\n`);
+    if (row) process.stdout.write(`[dry-run] Would add its row to the register in ${registerRepoPath}:\n  ${row}\n`);
+    return { id, row };
+  }
+
+  mutateFileSet({ updates }, { repoRoot: config.repoRoot });
+  process.stdout.write(`${green('Added')} ${id} to ${planRepoPath} ${dim(inserted.placement)}\n`);
+  if (row) process.stdout.write(`${green('Added')} its row to the register in ${registerRepoPath}\n`);
+  return { id, row };
+}
+
+function registerRow({ id, disposition, today, question, answers, heading, link }) {
+  const text = `${question.trim()} ${answers.trim()}`;
+  return `${id} ${disposition.toUpperCase()} ${today.slice(0, 10)}: ${text} Record: [${link} § ${heading} ${id}](${link}).`;
+}

package/src/new.mjs

@@ -2,6 +2,7 @@ import { spawnSync } from 'node:child_process';
 import { existsSync, readFileSync, mkdirSync, fstatSync } from 'node:fs';
 import path from 'node:path';
 import { fileURLToPath } from 'node:url';
+import { runNewDecision } from './decision.mjs';
 import { toRepoPath, die, warn, nowIso, emitFilesFooter } from './util.mjs';
 import { green, dim, bold } from './color.mjs';
 import { isInteractive, promptText } from './prompt.mjs';
@@ -652,9 +653,14 @@ next_step:
 export async function runNew(argv, config, opts = {}) {
   const { dryRun } = opts;
 
+  if (argv.find(a => !a.startsWith('-')) === 'decision') return runNewDecisionArgs(argv, config, opts);
+
   const knownTypes = new Set(Object.keys(BUILTIN_TEMPLATES));
   // Also include any custom templates from config
   for (const k of Object.keys(config.raw?.templates ?? {})) knownTypes.add(k);
+  // `hub` is a plan with a hub body; `decision` is handled above.
+  knownTypes.add('hub');
+  knownTypes.add('decision');
 
   const hasNameForBody = args => {
     if (args.length >= 2 && knownTypes.has(args[0])) return true;
@@ -713,11 +719,27 @@ export async function runNew(argv, config, opts = {}) {
     name = positional[1];
     if (positional.length > 2) bodyArg = positional.slice(2).join(' ');
   } else {
+    // `new <name> <inline body>` is a doc with the type left out, but a single
+    // bare word in the body slot is almost always a mistyped type and a slug
+    // (`new decison foo`), which used to create `<type-name>.md` with the slug
+    // as its whole body.
+    const [first, second] = positional;
+    if (positional.length === 2 && !/[/\\]|\.md$/.test(first) && /^[A-Za-z][\w.-]*$/.test(second)) {
+      die(`Unknown type \`${first}\`. Types: ${[...knownTypes].join(', ')}.\n`
+        + `For a doc named ${first} with "${second}" as its body, run: runlist new doc ${first} "${second}"`);
+    }
     typeName = 'doc';
     name = positional[0];
     if (positional.length > 1) bodyArg = positional.slice(1).join(' ');
   }
 
+  // A hub is a plan with a hub body. Coordination is the default shape, being
+  // the one a hub without children or tiers has.
+  if (typeName === 'hub') {
+    typeName = 'plan';
+    if (runlistArg === null && !roadmap) coordination = true;
+  }
+
   if (!name) {
     if (isInteractive()) {
       name = await promptText(`${typeName} name: `);
@@ -1145,6 +1167,8 @@ export function newHelpForRepo(config) {
     if (statuses.length) rows.push(`  ${''.padEnd(width)}   statuses: ${statuses.join(', ')}`);
   }
   const roots = (config.docsRoots ?? [config.docsRoot]).map(r => path.basename(r));
+  rows.push(`  ${'hub'.padEnd(width)} → a plan with a hub body (coordination unless --runlist or --roadmap)`);
+  rows.push(`  ${'decision'.padEnd(width)} → an entry in an existing plan's decisions section`);
   return `This repo:
 ${rows.join('\n')}
   roots (for --root): ${roots.join(', ')}`;
@@ -1206,4 +1230,29 @@ function listTemplates(config) {
     if (desc) process.stdout.write(`  ${dim(desc)}\n`);
     process.stdout.write('\n');
   }
+  process.stdout.write(`  hub\n  ${dim('A plan with a hub body: coordination by default, --runlist or --roadmap for the others.')}\n\n`);
+  process.stdout.write(`  decision\n  ${dim('An entry in an existing plan\'s decisions section: runlist new decision <plan> --question "…" @record.md')}\n\n`);
+}
+
+function runNewDecisionArgs(argv, config, opts) {
+  const positional = [];
+  let question = null;
+  let disposition = null;
+  let answers = null;
+  let bodyFlag = null;
+  for (let i = 0; i < argv.length; i++) {
+    const a = argv[i];
+    if (a === '--question' && argv[i + 1] !== undefined) { question = argv[++i]; continue; }
+    if (a === '--disposition' && argv[i + 1] !== undefined) { disposition = argv[++i]; continue; }
+    if (a === '--answers' && argv[i + 1] !== undefined) { answers = argv[++i]; continue; }
+    if ((a === '--body' || a === '--message') && argv[i + 1] !== undefined) { bodyFlag = argv[++i]; continue; }
+    if (a === '--config' || a === '--root') { i++; continue; }
+    if (!a.startsWith('-') || a === '-') positional.push(a);
+  }
+  const [, planArg, ...rest] = positional;
+  let record = null;
+  if (bodyFlag !== null) record = readBodyInput(bodyFlag);
+  else if (rest.length) record = readBodyInput(rest.join(' '));
+  else record = readPipedBodyInput();
+  return runNewDecision({ planArg, question, disposition, record, answers }, config, { dryRun: opts.dryRun });
 }