roadmapsmith 0.2.0 → 0.5.0

package/src/model.js

@@ -1,28 +1,32 @@
-'use strict';
-
-const PHASE_ORDER = ['P0', 'P1', 'P2'];
-
-function phaseWeight(phase) {
-  const idx = PHASE_ORDER.indexOf(phase);
-  return idx >= 0 ? idx : PHASE_ORDER.length;
-}
-
-function createRoadmapModel(input) {
-  return {
-    northStar: input.northStar,
-    currentState: input.currentState,
-    phases: input.phases,
-    milestones: input.milestones,
-    commandBreakdown: input.commandBreakdown,
-    exitCriteria: input.exitCriteria,
-    risks: input.risks,
-    antiGoals: input.antiGoals,
-    customSections: input.customSections || []
-  };
-}
-
-module.exports = {
-  PHASE_ORDER,
-  createRoadmapModel,
-  phaseWeight
+'use strict';
+
+const PHASE_ORDER = ['P0', 'P1', 'P2'];
+
+function phaseWeight(phase) {
+  const idx = PHASE_ORDER.indexOf(phase);
+  return idx >= 0 ? idx : PHASE_ORDER.length;
+}
+
+function createRoadmapModel(input) {
+  return {
+    northStar: input.northStar,
+    product: input.product || {},
+    currentState: input.currentState,
+    phases: input.phases,
+    steps: input.steps || [],
+    phasesDetailed: input.phasesDetailed || [],
+    milestones: input.milestones,
+    commandBreakdown: input.commandBreakdown,
+    exitCriteria: input.exitCriteria,
+    risks: input.risks,
+    antiGoals: input.antiGoals,
+    successCriteria: input.successCriteria || [],
+    customSections: input.customSections || [],
+    checkedById: input.checkedById || {}
+  };
+}
+
+module.exports = {
+  PHASE_ORDER,
+  createRoadmapModel
 };

package/src/parser/index.js

@@ -1,109 +1,107 @@
-'use strict';
-
-const { slugify } = require('../utils');
-
-const TASK_LINE_RE = /^(\s*)- \[( |x|X)\] (.*?)(?:\s*<!--\s*rs:task=([a-z0-9-]+)\s*-->)?\s*$/;
-const WARNING_RE = /^\s*-\s+⚠️ attempted but validation failed:\s*(.+?)\s*$/;
-const HEADING_RE = /^#{2,3}\s+(.*)$/;
-
-const MANAGED_START = '<!-- rs:managed:start -->';
-const MANAGED_END = '<!-- rs:managed:end -->';
-
-function parseRoadmap(content) {
-  const lines = String(content || '').split(/\r?\n/);
-  const tasks = [];
-  let section = '';
-
-  for (let index = 0; index < lines.length; index += 1) {
-    const line = lines[index];
-    const headingMatch = line.match(HEADING_RE);
-    if (headingMatch) {
-      section = headingMatch[1].trim();
-    }
-
-    const taskMatch = line.match(TASK_LINE_RE);
-    if (!taskMatch) {
-      continue;
-    }
-
-    const indent = taskMatch[1] || '';
-    const checked = taskMatch[2].toLowerCase() === 'x';
-    const text = taskMatch[3].trim();
-    const markerId = taskMatch[4] || null;
-
-    let warningLineIndex = null;
-    let warningText = null;
-    if (index + 1 < lines.length) {
-      const nextLine = lines[index + 1];
-      const warningMatch = nextLine.match(WARNING_RE);
-      if (warningMatch) {
-        warningLineIndex = index + 1;
-        warningText = warningMatch[1].trim();
-      }
-    }
-
-    const id = markerId || slugify(text);
-    tasks.push({
-      id,
-      text,
-      checked,
-      lineIndex: index,
-      warningLineIndex,
-      warningText,
-      markerId,
-      indent,
-      section
-    });
-  }
-
-  return {
-    lines,
-    tasks
-  };
-}
-
-function findManagedRange(lines) {
-  let start = -1;
-  let end = -1;
-
-  for (let i = 0; i < lines.length; i += 1) {
-    if (lines[i].trim() === MANAGED_START) {
-      start = i;
-      continue;
-    }
-    if (lines[i].trim() === MANAGED_END) {
-      end = i;
-      break;
-    }
-  }
-
-  if (start >= 0 && end >= 0 && start < end) {
-    return { start, end };
-  }
-  return null;
-}
-
-function upsertManagedBlock(existingContent, managedBody) {
-  const existing = String(existingContent || '');
-  const lines = existing.split(/\r?\n/);
-  const range = findManagedRange(lines);
-  const bodyLines = managedBody.split(/\r?\n/);
-
-  if (!range) {
-    if (existing.trim().length === 0) {
-      return [MANAGED_START, ...bodyLines, MANAGED_END].join('\n');
-    }
-    return `${existing.replace(/\s+$/, '')}\n\n${MANAGED_START}\n${managedBody}\n${MANAGED_END}`;
-  }
-
-  const prefix = lines.slice(0, range.start + 1);
-  const suffix = lines.slice(range.end);
-  return [...prefix, ...bodyLines, ...suffix].join('\n');
-}
-
-module.exports = {
-  MANAGED_END,
-  MANAGED_START,
-  parseRoadmap,
-  upsertManagedBlock
+'use strict';
+
+const { slugify } = require('../utils');
+
+const TASK_LINE_RE = /^(\s*)- \[( |x|X)\] (.*?)(?:\s*<!--\s*rs:task=([a-z0-9-]+)\s*-->)?\s*$/;
+const WARNING_RE = /^\s*-\s+⚠️ attempted but validation failed:\s*(.+?)\s*$/;
+const HEADING_RE = /^#{2,3}\s+(.*)$/;
+
+const MANAGED_START = '<!-- rs:managed:start -->';
+const MANAGED_END = '<!-- rs:managed:end -->';
+
+function parseRoadmap(content) {
+  const lines = String(content || '').split(/\r?\n/);
+  const tasks = [];
+  let section = '';
+
+  for (let index = 0; index < lines.length; index += 1) {
+    const line = lines[index];
+    const headingMatch = line.match(HEADING_RE);
+    if (headingMatch) {
+      section = headingMatch[1].trim();
+    }
+
+    const taskMatch = line.match(TASK_LINE_RE);
+    if (!taskMatch) {
+      continue;
+    }
+
+    const indent = taskMatch[1] || '';
+    const checked = taskMatch[2].toLowerCase() === 'x';
+    const text = taskMatch[3].trim();
+    const markerId = taskMatch[4] || null;
+
+    let warningLineIndex = null;
+    let warningText = null;
+    if (index + 1 < lines.length) {
+      const nextLine = lines[index + 1];
+      const warningMatch = nextLine.match(WARNING_RE);
+      if (warningMatch) {
+        warningLineIndex = index + 1;
+        warningText = warningMatch[1].trim();
+      }
+    }
+
+    const id = markerId || slugify(text);
+    tasks.push({
+      id,
+      text,
+      checked,
+      lineIndex: index,
+      warningLineIndex,
+      warningText,
+      markerId,
+      indent,
+      section
+    });
+  }
+
+  return {
+    lines,
+    tasks
+  };
+}
+
+function findManagedRange(lines) {
+  let start = -1;
+  let end = -1;
+
+  for (let i = 0; i < lines.length; i += 1) {
+    if (lines[i].trim() === MANAGED_START) {
+      start = i;
+      continue;
+    }
+    if (lines[i].trim() === MANAGED_END) {
+      end = i;
+      break;
+    }
+  }
+
+  if (start >= 0 && end >= 0 && start < end) {
+    return { start, end };
+  }
+  return null;
+}
+
+function upsertManagedBlock(existingContent, managedBody) {
+  const existing = String(existingContent || '');
+  const lines = existing.split(/\r?\n/);
+  const range = findManagedRange(lines);
+  const bodyLines = managedBody.split(/\r?\n/);
+
+  if (!range) {
+    if (existing.trim().length === 0) {
+      return [MANAGED_START, ...bodyLines, MANAGED_END].join('\n');
+    }
+    return `${existing.replace(/\s+$/, '')}\n\n${MANAGED_START}\n${managedBody}\n${MANAGED_END}`;
+  }
+
+  const prefix = lines.slice(0, range.start + 1);
+  const suffix = lines.slice(range.end);
+  return [...prefix, ...bodyLines, ...suffix].join('\n');
+}
+
+module.exports = {
+  parseRoadmap,
+  upsertManagedBlock
 };

package/src/renderer/compact.js

@@ -0,0 +1,89 @@
+'use strict';
+
+const { slugify, ensureTrailingNewline } = require('../utils');
+const { taskLine, checkedState } = require('./helpers');
+
+function renderCompact(model) {
+  const lines = [];
+
+  lines.push('# Project Roadmap');
+  lines.push('');
+  lines.push('## Product North Star');
+  lines.push(model.northStar);
+  lines.push('');
+
+  lines.push('## Current State');
+  lines.push(`- Implemented surface: ${model.currentState.implementedSummary}`);
+  lines.push(`- TODO surface: ${model.currentState.todoSummary}`);
+  lines.push(`- Detected stacks: ${model.currentState.stackSummary}`);
+  lines.push('');
+
+  lines.push('## Phased Roadmap');
+  lines.push('');
+  lines.push('### Phase P0 (Critical)');
+  for (const task of model.phases.P0) {
+    lines.push(taskLine(task));
+  }
+  lines.push('');
+  lines.push('### Phase P1 (Important)');
+  for (const task of model.phases.P1) {
+    lines.push(taskLine(task));
+  }
+  lines.push('');
+  lines.push('### Phase P2 (Optimization)');
+  for (const task of model.phases.P2) {
+    lines.push(taskLine(task));
+  }
+  lines.push('');
+
+  lines.push('## Release Milestones');
+  for (const milestone of model.milestones) {
+    const id = `milestone-${slugify(milestone.version)}`;
+    lines.push(`- [${checkedState(model, id) ? 'x' : ' '}] ${milestone.version}: ${milestone.goal} <!-- rs:task=${id} -->`);
+  }
+  lines.push('');
+
+  lines.push('## Command/Module Breakdown');
+  if (model.commandBreakdown.length === 0) {
+    const id = 'identify-command-module-boundaries';
+    lines.push(`- [${checkedState(model, id) ? 'x' : ' '}] Identify command/module boundaries for the next increment <!-- rs:task=${id} -->`);
+  } else {
+    for (const item of model.commandBreakdown) {
+      const id = `module-${slugify(item)}`;
+      lines.push(`- [${checkedState(model, id) ? 'x' : ' '}] ${item} <!-- rs:task=${id} -->`);
+    }
+  }
+  lines.push('');
+
+  lines.push('## Exit Criteria Per Phase');
+  for (const item of model.exitCriteria) {
+    const id = `exit-${slugify(item)}`;
+    lines.push(`- [${checkedState(model, id) ? 'x' : ' '}] ${item} <!-- rs:task=${id} -->`);
+  }
+  lines.push('');
+
+  for (const section of model.customSections) {
+    lines.push(`## ${section.title}`);
+    for (const line of section.items) {
+      lines.push(line);
+    }
+    lines.push('');
+  }
+
+  lines.push('## Risks and Anti-goals');
+  lines.push('### Risks');
+  for (const risk of model.risks) {
+    const id = `risk-${slugify(risk)}`;
+    lines.push(`- [${checkedState(model, id) ? 'x' : ' '}] ${risk} <!-- rs:task=${id} -->`);
+  }
+  lines.push('');
+  lines.push('### Anti-goals');
+  for (const antiGoal of model.antiGoals) {
+    const id = `anti-goal-${slugify(antiGoal)}`;
+    lines.push(`- [${checkedState(model, id) ? 'x' : ' '}] ${antiGoal} <!-- rs:task=${id} -->`);
+  }
+
+  return ensureTrailingNewline(lines.join('\n')).trimEnd();
+}
+
+module.exports = { renderCompact };

package/src/renderer/helpers.js

@@ -0,0 +1,19 @@
+'use strict';
+
+function taskLine(task) {
+  return `- [${task.checked ? 'x' : ' '}] ${task.text} <!-- rs:task=${task.id} -->`;
+}
+
+function sectionHeader(n, title) {
+  return `## ${n}. ${title}`;
+}
+
+function checkedState(model, id) {
+  return Boolean(model.checkedById && model.checkedById[id]);
+}
+
+function priorityLabel(priority) {
+  return priority ? `\`[${priority}]\`` : '';
+}
+
+module.exports = { taskLine, sectionHeader, checkedState, priorityLabel };

package/src/renderer/index.js

@@ -0,0 +1,18 @@
+'use strict';
+
+const { renderCompact } = require('./compact');
+const { renderProfessional } = require('./professional');
+
+function renderBody(model, profile) {
+  if (profile === 'professional') return renderProfessional(model);
+  if (profile === 'enterprise') {
+    throw new Error(
+      'roadmapProfile "enterprise" is not yet implemented. ' +
+      'Use "professional" instead, or contribute via the plugin registry. ' +
+      'See docs/use-cases/ for the extension guide.'
+    );
+  }
+  return renderCompact(model);
+}
+
+module.exports = { renderBody };