nubos-pilot 0.1.0

package/lib/roadmap-render.cjs

@@ -0,0 +1,206 @@
+const fs = require('node:fs');
+const path = require('node:path');
+const YAML = require('yaml');
+const {
+  withFileLock,
+  atomicWriteFileSync,
+  projectStateDir,
+  NubosPilotError,
+} = require('./core.cjs');
+
+const GENERATED_HEADER = '<!-- Generated from roadmap.yaml — do not edit by hand -->';
+
+function _yamlPath(cwd) {
+  try {
+    return path.join(projectStateDir(cwd), 'roadmap.yaml');
+  } catch (err) {
+    if (!err || err.code !== 'not-in-project') throw err;
+    return path.join(path.resolve(cwd), '.planning', 'roadmap.yaml');
+  }
+}
+
+function _mdPath(cwd) {
+  try {
+    return path.join(projectStateDir(cwd), 'ROADMAP.md');
+  } catch (err) {
+    if (!err || err.code !== 'not-in-project') throw err;
+    return path.join(path.resolve(cwd), '.planning', 'ROADMAP.md');
+  }
+}
+
+function _readYaml(p) {
+  let raw;
+  try {
+    raw = fs.readFileSync(p, 'utf-8');
+  } catch (err) {
+    throw new NubosPilotError(
+      'roadmap-render-read-error',
+      'roadmap.yaml not readable',
+      { path: p, cause: err && err.code },
+    );
+  }
+  try {
+    return YAML.parse(raw);
+  } catch (err) {
+    throw new NubosPilotError(
+      'roadmap-render-read-error',
+      'roadmap.yaml invalid YAML',
+      { path: p, cause: err && err.message },
+    );
+  }
+}
+
+function _statusLabel(status) {
+  switch (status) {
+    case 'done':
+    case 'complete':
+      return 'Complete';
+    case 'in-progress':
+      return 'In Progress';
+    case 'pending':
+      return 'Not started';
+    default:
+      return status ? String(status) : 'Not started';
+  }
+}
+
+function _plansComplete(plans) {
+  if (!Array.isArray(plans) || plans.length === 0) return '0/0';
+  const total = plans.length;
+  const done = plans.filter((p) => p && p.complete === true).length;
+  return `${done}/${total}`;
+}
+
+function _dependsOnStr(v) {
+  if (v == null) return '-';
+  if (Array.isArray(v)) return v.length ? v.map(String).join(', ') : '-';
+  return String(v);
+}
+
+function _renderPhaseDetail(lines, ph) {
+  lines.push(`### Phase ${ph.number}: ${ph.name || ''}`);
+  lines.push(`**Goal**: ${ph.goal || ''}`);
+  lines.push(`**Depends on**: ${_dependsOnStr(ph.depends_on)}`);
+  const reqs = Array.isArray(ph.requirements) ? ph.requirements : [];
+  lines.push(`**Requirements**: ${reqs.length ? reqs.join(', ') : '-'}`);
+  const sc = Array.isArray(ph.success_criteria) ? ph.success_criteria : [];
+  if (sc.length) {
+    lines.push('**Success Criteria**:');
+    for (let i = 0; i < sc.length; i++) {
+      lines.push(`  ${i + 1}. ${sc[i]}`);
+    }
+  } else {
+    lines.push('**Success Criteria**: -');
+  }
+  const plans = Array.isArray(ph.plans) ? ph.plans : [];
+  if (plans.length) {
+    lines.push('**Plans**:');
+    for (const pl of plans) {
+      const box = pl && pl.complete ? 'x' : ' ';
+      const id = pl && pl.id ? pl.id : '';
+      const title = pl && pl.title ? pl.title : '';
+      lines.push(`  - [${box}] ${id}${title ? ' — ' + title : ''}`);
+    }
+  } else {
+    lines.push('**Plans**: -');
+  }
+  lines.push('');
+}
+
+function _renderBacklogSection(lines, milestone) {
+  lines.push('## Backlog');
+  lines.push('');
+  const phases = Array.isArray(milestone.phases) ? milestone.phases : [];
+  if (phases.length === 0) {
+    lines.push('*No backlog items.*');
+    lines.push('');
+    return;
+  }
+  for (const ph of phases) {
+    if (!ph || ph.number == null) continue;
+    lines.push(`- [ ] Phase ${ph.number}: ${ph.name || ''}`);
+  }
+  lines.push('');
+}
+
+function renderMarkdown(data) {
+  const lines = [];
+  lines.push(GENERATED_HEADER);
+  lines.push('');
+  lines.push('# Roadmap');
+  lines.push('');
+  lines.push('## Overview');
+  lines.push('');
+
+  if (!data || !Array.isArray(data.milestones)) {
+    lines.push('*No milestones defined.*');
+    lines.push('');
+    return lines.join('\n') + '\n';
+  }
+
+  const tablePhases = [];
+  for (const ms of data.milestones) {
+    if (!ms || !Array.isArray(ms.phases)) continue;
+    if (ms.id === 'backlog') continue;
+    for (const ph of ms.phases) {
+      if (!ph || ph.number == null) continue;
+      tablePhases.push(ph);
+    }
+  }
+
+  const regularMilestones = data.milestones.filter((m) => m && m.id !== 'backlog');
+  lines.push(`Milestones: ${regularMilestones.length}. Phases: ${tablePhases.length}.`);
+  lines.push('');
+
+  lines.push('## Progress');
+  lines.push('');
+  lines.push('| Phase | Plans Complete | Status |');
+  lines.push('|-------|----------------|--------|');
+  for (const ph of tablePhases) {
+    const num = String(ph.number);
+    const name = ph.name || '';
+    const pc = _plansComplete(ph.plans);
+    const st = _statusLabel(ph.status);
+    lines.push(`| ${num}. ${name} | ${pc} | ${st} |`);
+  }
+  lines.push('');
+
+  lines.push('## Phase Details');
+  lines.push('');
+  for (const ms of data.milestones) {
+    if (!ms || !Array.isArray(ms.phases)) continue;
+    if (ms.id === 'backlog') continue;
+    const phases = ms.phases.filter((ph) => ph && ph.number != null);
+    if (phases.length === 0) continue;
+    if (ms.collapsed === true) {
+      const at = ms.collapsed_at || '';
+      const summary = `${ms.id}${at ? ' — completed on ' + at : ''}`;
+      lines.push(`<details><summary>${summary}</summary>`);
+      lines.push('');
+      for (const ph of phases) _renderPhaseDetail(lines, ph);
+      lines.push('</details>');
+      lines.push('');
+    } else {
+      for (const ph of phases) _renderPhaseDetail(lines, ph);
+    }
+  }
+
+  const backlog = data.milestones.find((m) => m && m.id === 'backlog');
+  if (backlog) {
+    _renderBacklogSection(lines, backlog);
+  }
+
+  return lines.join('\n') + '\n';
+}
+
+function renderRoadmap(cwd = process.cwd()) {
+  const ymlPath = _yamlPath(cwd);
+  const mdPath = _mdPath(cwd);
+  const data = _readYaml(ymlPath);
+  const content = renderMarkdown(data);
+  return withFileLock(mdPath, () => {
+    atomicWriteFileSync(mdPath, content);
+  });
+}
+
+module.exports = { renderRoadmap, renderMarkdown, GENERATED_HEADER };

package/lib/roadmap-render.test.cjs

@@ -0,0 +1,121 @@
+const { test, afterEach } = require('node:test');
+const assert = require('node:assert/strict');
+const fs = require('node:fs');
+const os = require('node:os');
+const path = require('node:path');
+
+const render = require('./roadmap-render.cjs');
+
+const FIXTURES = path.join(__dirname, 'fixtures', 'roadmap');
+const MINIMAL = fs.readFileSync(path.join(FIXTURES, 'roadmap-minimal.yaml'), 'utf-8');
+
+const sandboxes = [];
+
+function makeSandbox(yamlContent) {
+  const dir = fs.mkdtempSync(path.join(os.tmpdir(), 'np-rr-'));
+  fs.mkdirSync(path.join(dir, '.nubos-pilot'));
+  if (yamlContent != null) {
+    fs.writeFileSync(path.join(dir, '.nubos-pilot', 'roadmap.yaml'), yamlContent);
+  }
+  sandboxes.push(dir);
+  return dir;
+}
+
+afterEach(() => {
+  while (sandboxes.length) {
+    const d = sandboxes.pop();
+    try { fs.rmSync(d, { recursive: true, force: true }); } catch {}
+  }
+});
+
+test('RR-1: renderRoadmap writes ROADMAP.md containing generated-header marker', () => {
+  const root = makeSandbox(MINIMAL);
+  render.renderRoadmap(root);
+  const out = fs.readFileSync(path.join(root, '.nubos-pilot', 'ROADMAP.md'), 'utf-8');
+  assert.ok(out.startsWith(render.GENERATED_HEADER), 'output starts with generated-header marker');
+  assert.match(out, /# Roadmap/);
+});
+
+test('RR-2: renderRoadmap is byte-idempotent across two consecutive calls', () => {
+  const root = makeSandbox(MINIMAL);
+  render.renderRoadmap(root);
+  const first = fs.readFileSync(path.join(root, '.nubos-pilot', 'ROADMAP.md'));
+  render.renderRoadmap(root);
+  const second = fs.readFileSync(path.join(root, '.nubos-pilot', 'ROADMAP.md'));
+  assert.ok(Buffer.compare(first, second) === 0, 'byte-identical output');
+});
+
+test('RR-3: renderRoadmap on missing roadmap.yaml throws roadmap-render-read-error', () => {
+  const root = makeSandbox(null);
+  assert.throws(
+    () => render.renderRoadmap(root),
+    (err) => err && err.name === 'NubosPilotError' && err.code === 'roadmap-render-read-error',
+  );
+});
+
+test('RR-4: rendered MD contains all three phase names from minimal fixture', () => {
+  const root = makeSandbox(MINIMAL);
+  render.renderRoadmap(root);
+  const out = fs.readFileSync(path.join(root, '.nubos-pilot', 'ROADMAP.md'), 'utf-8');
+  assert.match(out, /Foundation/);
+  assert.match(out, /Hotfix/);
+  assert.match(out, /Core/);
+});
+
+test('RR-5: rendered MD progress table marks Phase 1 Complete', () => {
+  const root = makeSandbox(MINIMAL);
+  render.renderRoadmap(root);
+  const out = fs.readFileSync(path.join(root, '.nubos-pilot', 'ROADMAP.md'), 'utf-8');
+
+  assert.match(out, /\|\s*1\.\s*Foundation\s*\|[^|]*\|\s*Complete\s*\|/);
+});
+
+test('ROAD-RENDER-BACKLOG: synthetic id:backlog renders as ## Backlog, excluded from progress table', () => {
+  const doc = {
+    milestones: [
+      {
+        id: 'v1.0',
+        name: 'v1',
+        phases: [
+          { number: 1, name: 'First', slug: 'first', goal: 'g', status: 'done', plans: [] },
+        ],
+      },
+      {
+        id: 'backlog',
+        name: 'Backlog',
+        phases: [
+          { number: '999.1', name: 'Fix deploy key auth', slug: 'fix-deploy-key-auth', status: 'backlog', plans: [] },
+          { number: '999.2', name: 'Add feature X', slug: 'add-feature-x', status: 'backlog', plans: [] },
+        ],
+      },
+    ],
+  };
+  const md = render.renderMarkdown(doc);
+  assert.match(md, /## Backlog/);
+  assert.match(md, /Phase 999\.1: Fix deploy key auth/);
+  assert.match(md, /Phase 999\.2: Add feature X/);
+  const progressLines = md.split('\n').filter((l) => l.startsWith('|') && !l.startsWith('|-------'));
+  const progressText = progressLines.join('\n');
+  assert.doesNotMatch(progressText, /999\.1/);
+  assert.match(md, /Milestones:\s*1\./);
+});
+
+test('ROAD-RENDER-COLLAPSED: collapsed:true wraps phase-details block in <details>', () => {
+  const doc = {
+    milestones: [
+      {
+        id: 'v1.0',
+        name: 'v1',
+        collapsed: true,
+        collapsed_at: '2026-04-17',
+        phases: [
+          { number: 1, name: 'First', slug: 'first', goal: 'g', status: 'done', plans: [] },
+        ],
+      },
+    ],
+  };
+  const md = render.renderMarkdown(doc);
+  assert.match(md, /<details><summary>v1\.0 — completed on 2026-04-17<\/summary>/);
+  assert.match(md, /<\/details>/);
+  assert.match(md, /### Phase 1:/);
+});