roadmapsmith 0.9.2 → 0.9.3

package/README.md

@@ -1,4 +1,8 @@
-# roadmap-skill
+<p align="center">
+  <img src="https://raw.githubusercontent.com/PapiScholz/roadmapsmith/main/assets/roadmapsmith-logo.png" alt="RoadmapSmith logo" width="180">
+</p>
+
+<h1 align="center">RoadmapSmith</h1>
 
 Production-grade roadmap generator and sync tool for agent-driven projects.
 

package/bin/cli.js

@@ -1,254 +1,254 @@
-#!/usr/bin/env node
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-const { parseArgv } = require('../src/utils');
-const { loadConfig, resolveRoadmapFile, resolveAgentsFile, loadPlugins } = require('../src/config');
-const { readTextIfExists, writeText, printDryRunDiff } = require('../src/io');
-const { renderRoadmapTemplate, renderAgentsTemplate } = require('../src/templates');
-const { generateRoadmapDocument } = require('../src/generator');
-const { parseRoadmap } = require('../src/parser');
-const { buildValidationContext, validateTasks, auditValidation, CONFIDENCE_RANK, applyMinimumConfidence } = require('../src/validator');
-const { applySync } = require('../src/sync');
-
-function printHelp() {
-  console.log([
-    'Usage:',
-    '  roadmapsmith init [--roadmap-file <path>] [--agents-file <path>] [--dry-run]',
-    '  roadmapsmith generate [--project-root <path>] [--config <path>] [--roadmap-file <path>] [--dry-run] [--audit]',
-    '  roadmapsmith sync [--roadmap-file <path>] [--project-root <path>] [--config <path>] [--dry-run] [--audit]',
-    '  roadmapsmith validate [--roadmap-file <path>] [--project-root <path>] [--config <path>] [--task <id|text>] [--json]',
-    '  roadmapsmith doctor [--roadmap-file <path>] [--project-root <path>] [--config <path>]'
-  ].join('\n'));
-}
-
-function isEnabled(value) {
-  if (value === true) return true;
-  if (typeof value !== 'string') return false;
-  const normalized = value.toLowerCase();
-  return normalized === '1' || normalized === 'true' || normalized === 'yes';
-}
-
-function formatResultLine(task, result) {
-  const status = result.passed ? 'PASS' : 'FAIL';
-  const reason = result.reasons.length > 0 ? ` :: ${result.reasons.join('; ')}` : '';
-  return `${status} [${task.id}] ${task.text}${reason}`;
-}
-
-function maybeFilterTasks(tasks, filterValue) {
-  if (!filterValue) return tasks;
-  const normalized = String(filterValue).toLowerCase();
-  return tasks.filter((task) => {
-    return task.id.toLowerCase() === normalized || task.text.toLowerCase().includes(normalized);
-  });
-}
-
-function printAudit(audit) {
-  console.log(`Audit summary: ${audit.checkedWithoutEvidence.length} checked-without-evidence, ${audit.readyButUnchecked.length} ready-but-unchecked.`);
-  if (audit.checkedWithoutEvidence.length > 0) {
-    console.log('Checked without evidence:');
-    audit.checkedWithoutEvidence.forEach((item) => {
-      console.log(`- [${item.task.id}] ${item.task.text}`);
-    });
-  }
-  if (audit.readyButUnchecked.length > 0) {
-    console.log('Ready but unchecked:');
-    audit.readyButUnchecked.forEach((item) => {
-      console.log(`- [${item.task.id}] ${item.task.text}`);
-    });
-  }
-}
-
-async function run() {
-  const parsed = parseArgv(process.argv.slice(2));
-  const command = parsed.command;
-  const flags = parsed.flags;
-
-  if (isEnabled(flags.version) || isEnabled(flags.v)) {
-    const pkg = require(path.join(__dirname, '..', 'package.json'));
-    process.stdout.write(pkg.version + '\n');
-    process.exit(0);
-  }
-
-  if (!command || isEnabled(flags.help) || isEnabled(flags.h)) {
-    printHelp();
-    return;
-  }
-
-  if (command === 'init') {
-    const projectRoot = process.cwd();
-    const config = loadConfig({ projectRoot });
-    const roadmapFile = resolveRoadmapFile(projectRoot, config, flags['roadmap-file']);
-    const agentsFile = resolveAgentsFile(projectRoot, config, flags['agents-file']);
-    const dryRun = isEnabled(flags['dry-run']);
-
-    const roadmapExists = fs.existsSync(roadmapFile);
-    const agentsExists = fs.existsSync(agentsFile);
-
-    if (!roadmapExists) {
-      const roadmap = renderRoadmapTemplate();
-      const result = writeText(roadmapFile, roadmap, { dryRun });
-      if (dryRun && result.changed) {
-        printDryRunDiff(roadmapFile, result.before, result.after);
-      }
-      console.log(`${dryRun ? 'Would create' : 'Created'} ${roadmapFile}`);
-    } else {
-      console.log(`Skipped existing ${roadmapFile}`);
-    }
-
-    if (!agentsExists) {
-      const agents = renderAgentsTemplate({ roadmapPath: path.basename(roadmapFile) });
-      const result = writeText(agentsFile, agents, { dryRun });
-      if (dryRun && result.changed) {
-        printDryRunDiff(agentsFile, result.before, result.after);
-      }
-      console.log(`${dryRun ? 'Would create' : 'Created'} ${agentsFile}`);
-    } else {
-      console.log(`Skipped existing ${agentsFile}`);
-    }
-    return;
-  }
-
-  if (command === 'generate') {
-    const projectRoot = path.resolve(String(flags['project-root'] || process.cwd()));
-    const config = loadConfig({ projectRoot, configPath: flags.config });
-    const roadmapFile = resolveRoadmapFile(projectRoot, config, flags['roadmap-file']);
-    const plugins = loadPlugins(projectRoot, config.plugins);
-    const existingContent = readTextIfExists(roadmapFile) || '';
-    const dryRun = isEnabled(flags['dry-run']);
-
-    const document = generateRoadmapDocument({
-      projectRoot,
-      roadmapPath: roadmapFile,
-      existingContent,
-      config,
-      plugins
-    });
-
-    const writeResult = writeText(roadmapFile, document, { dryRun });
-    if (dryRun) {
-      if (writeResult.changed) {
-        printDryRunDiff(roadmapFile, writeResult.before, writeResult.after);
-      } else {
-        console.log(`No changes for ${roadmapFile}`);
-      }
-    } else {
-      console.log(writeResult.changed ? `Updated ${roadmapFile}` : `No changes for ${roadmapFile}`);
-    }
-
-    if (isEnabled(flags.audit)) {
-      const parsedRoadmap = parseRoadmap(document);
-      const validationContext = buildValidationContext(projectRoot, config, plugins);
-      const results = validateTasks(parsedRoadmap.tasks, validationContext, config, plugins);
-      const audit = auditValidation(parsedRoadmap.tasks, results);
-      printAudit(audit);
-    }
-    return;
-  }
-
-  if (command === 'sync') {
-    const projectRoot = path.resolve(String(flags['project-root'] || process.cwd()));
-    const config = loadConfig({ projectRoot, configPath: flags.config });
-    const roadmapFile = resolveRoadmapFile(projectRoot, config, flags['roadmap-file']);
-    const content = readTextIfExists(roadmapFile);
-    if (content == null) {
-      throw new Error(`Roadmap not found: ${roadmapFile}`);
-    }
-
-    const parsedRoadmap = parseRoadmap(content);
-    const validationContext = buildValidationContext(projectRoot, config, loadPlugins(projectRoot, config.plugins));
-    const results = validateTasks(parsedRoadmap.tasks, validationContext, config, validationContext.plugins);
-    applyMinimumConfidence(results, config.validation?.minimumConfidence);
-    const next = applySync(content, parsedRoadmap.tasks, results);
-    const dryRun = isEnabled(flags['dry-run']);
-    const writeResult = writeText(roadmapFile, next, { dryRun });
-
-    if (dryRun) {
-      if (writeResult.changed) {
-        printDryRunDiff(roadmapFile, writeResult.before, writeResult.after);
-      } else {
-        console.log(`No changes for ${roadmapFile}`);
-      }
-    } else {
-      console.log(writeResult.changed ? `Updated ${roadmapFile}` : `No changes for ${roadmapFile}`);
-    }
-
-    if (isEnabled(flags.audit)) {
-      const audit = auditValidation(parsedRoadmap.tasks, results);
-      printAudit(audit);
-    }
-    return;
-  }
-
-  if (command === 'validate') {
-    const projectRoot = path.resolve(String(flags['project-root'] || process.cwd()));
-    const config = loadConfig({ projectRoot, configPath: flags.config });
-    const roadmapFile = resolveRoadmapFile(projectRoot, config, flags['roadmap-file']);
-    const content = readTextIfExists(roadmapFile);
-    if (content == null) {
-      throw new Error(`Roadmap not found: ${roadmapFile}`);
-    }
-
-    const parsedRoadmap = parseRoadmap(content);
-    const tasks = maybeFilterTasks(parsedRoadmap.tasks, flags.task);
-    const validationContext = buildValidationContext(projectRoot, config, loadPlugins(projectRoot, config.plugins));
-    const results = validateTasks(tasks, validationContext, config, validationContext.plugins);
-
-    const minRank = CONFIDENCE_RANK[config.validation && config.validation.minimumConfidence] ?? 0;
-    const visibleTasks = tasks.filter((task) => (CONFIDENCE_RANK[results[task.id].confidence] ?? 0) >= minRank);
-
-    if (isEnabled(flags.json)) {
-      const payload = visibleTasks.map((task) => ({ task, result: results[task.id] }));
-      console.log(JSON.stringify(payload, null, 2));
-    } else {
-      visibleTasks.forEach((task) => {
-        console.log(formatResultLine(task, results[task.id]));
-      });
-    }
-
-    const failed = visibleTasks.some((task) => !results[task.id].passed);
-    if (failed) {
-      process.exitCode = 1;
-    }
-    return;
-  }
-
-  if (command === 'doctor') {
-    const projectRoot = path.resolve(String(flags['project-root'] || process.cwd()));
-    let ok = true;
-
-    let config;
-    try {
-      config = loadConfig({ projectRoot, configPath: flags.config });
-      console.log('[ok] Config loaded without errors');
-    } catch (error) {
-      console.error(`[fail] Config error: ${error.message}`);
-      ok = false;
-    }
-
-    if (config) {
-      const roadmapFile = resolveRoadmapFile(projectRoot, config, flags['roadmap-file']);
-      if (fs.existsSync(roadmapFile)) {
-        console.log(`[ok] ROADMAP file found: ${roadmapFile}`);
-      } else {
-        console.error(`[fail] ROADMAP file not found: ${roadmapFile}`);
-        ok = false;
-      }
-    }
-
-    if (!ok) {
-      process.exitCode = 1;
-      return;
-    }
-    console.log('doctor: all checks passed');
-    return;
-  }
-
-  throw new Error(`Unknown command: ${command}`);
-}
-
-run().catch((error) => {
-  console.error(error.message);
-  process.exitCode = 1;
-});
+#!/usr/bin/env node
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const { parseArgv } = require('../src/utils');
+const { loadConfig, resolveRoadmapFile, resolveAgentsFile, loadPlugins } = require('../src/config');
+const { readTextIfExists, writeText, printDryRunDiff } = require('../src/io');
+const { renderRoadmapTemplate, renderAgentsTemplate } = require('../src/templates');
+const { generateRoadmapDocument } = require('../src/generator');
+const { parseRoadmap } = require('../src/parser');
+const { buildValidationContext, validateTasks, auditValidation, CONFIDENCE_RANK, applyMinimumConfidence } = require('../src/validator');
+const { applySync } = require('../src/sync');
+
+function printHelp() {
+  console.log([
+    'Usage:',
+    '  roadmapsmith init [--roadmap-file <path>] [--agents-file <path>] [--dry-run]',
+    '  roadmapsmith generate [--project-root <path>] [--config <path>] [--roadmap-file <path>] [--dry-run] [--audit]',
+    '  roadmapsmith sync [--roadmap-file <path>] [--project-root <path>] [--config <path>] [--dry-run] [--audit]',
+    '  roadmapsmith validate [--roadmap-file <path>] [--project-root <path>] [--config <path>] [--task <id|text>] [--json]',
+    '  roadmapsmith doctor [--roadmap-file <path>] [--project-root <path>] [--config <path>]'
+  ].join('\n'));
+}
+
+function isEnabled(value) {
+  if (value === true) return true;
+  if (typeof value !== 'string') return false;
+  const normalized = value.toLowerCase();
+  return normalized === '1' || normalized === 'true' || normalized === 'yes';
+}
+
+function formatResultLine(task, result) {
+  const status = result.passed ? 'PASS' : 'FAIL';
+  const reason = result.reasons.length > 0 ? ` :: ${result.reasons.join('; ')}` : '';
+  return `${status} [${task.id}] ${task.text}${reason}`;
+}
+
+function maybeFilterTasks(tasks, filterValue) {
+  if (!filterValue) return tasks;
+  const normalized = String(filterValue).toLowerCase();
+  return tasks.filter((task) => {
+    return task.id.toLowerCase() === normalized || task.text.toLowerCase().includes(normalized);
+  });
+}
+
+function printAudit(audit) {
+  console.log(`Audit summary: ${audit.checkedWithoutEvidence.length} checked-without-evidence, ${audit.readyButUnchecked.length} ready-but-unchecked.`);
+  if (audit.checkedWithoutEvidence.length > 0) {
+    console.log('Checked without evidence:');
+    audit.checkedWithoutEvidence.forEach((item) => {
+      console.log(`- [${item.task.id}] ${item.task.text}`);
+    });
+  }
+  if (audit.readyButUnchecked.length > 0) {
+    console.log('Ready but unchecked:');
+    audit.readyButUnchecked.forEach((item) => {
+      console.log(`- [${item.task.id}] ${item.task.text}`);
+    });
+  }
+}
+
+async function run() {
+  const parsed = parseArgv(process.argv.slice(2));
+  const command = parsed.command;
+  const flags = parsed.flags;
+
+  if (isEnabled(flags.version) || isEnabled(flags.v)) {
+    const pkg = require(path.join(__dirname, '..', 'package.json'));
+    process.stdout.write(pkg.version + '\n');
+    process.exit(0);
+  }
+
+  if (!command || isEnabled(flags.help) || isEnabled(flags.h)) {
+    printHelp();
+    return;
+  }
+
+  if (command === 'init') {
+    const projectRoot = process.cwd();
+    const config = loadConfig({ projectRoot });
+    const roadmapFile = resolveRoadmapFile(projectRoot, config, flags['roadmap-file']);
+    const agentsFile = resolveAgentsFile(projectRoot, config, flags['agents-file']);
+    const dryRun = isEnabled(flags['dry-run']);
+
+    const roadmapExists = fs.existsSync(roadmapFile);
+    const agentsExists = fs.existsSync(agentsFile);
+
+    if (!roadmapExists) {
+      const roadmap = renderRoadmapTemplate();
+      const result = writeText(roadmapFile, roadmap, { dryRun });
+      if (dryRun && result.changed) {
+        printDryRunDiff(roadmapFile, result.before, result.after);
+      }
+      console.log(`${dryRun ? 'Would create' : 'Created'} ${roadmapFile}`);
+    } else {
+      console.log(`Skipped existing ${roadmapFile}`);
+    }
+
+    if (!agentsExists) {
+      const agents = renderAgentsTemplate({ roadmapPath: path.basename(roadmapFile) });
+      const result = writeText(agentsFile, agents, { dryRun });
+      if (dryRun && result.changed) {
+        printDryRunDiff(agentsFile, result.before, result.after);
+      }
+      console.log(`${dryRun ? 'Would create' : 'Created'} ${agentsFile}`);
+    } else {
+      console.log(`Skipped existing ${agentsFile}`);
+    }
+    return;
+  }
+
+  if (command === 'generate') {
+    const projectRoot = path.resolve(String(flags['project-root'] || process.cwd()));
+    const config = loadConfig({ projectRoot, configPath: flags.config });
+    const roadmapFile = resolveRoadmapFile(projectRoot, config, flags['roadmap-file']);
+    const plugins = loadPlugins(projectRoot, config.plugins);
+    const existingContent = readTextIfExists(roadmapFile) || '';
+    const dryRun = isEnabled(flags['dry-run']);
+
+    const document = generateRoadmapDocument({
+      projectRoot,
+      roadmapPath: roadmapFile,
+      existingContent,
+      config,
+      plugins
+    });
+
+    const writeResult = writeText(roadmapFile, document, { dryRun });
+    if (dryRun) {
+      if (writeResult.changed) {
+        printDryRunDiff(roadmapFile, writeResult.before, writeResult.after);
+      } else {
+        console.log(`No changes for ${roadmapFile}`);
+      }
+    } else {
+      console.log(writeResult.changed ? `Updated ${roadmapFile}` : `No changes for ${roadmapFile}`);
+    }
+
+    if (isEnabled(flags.audit)) {
+      const parsedRoadmap = parseRoadmap(document);
+      const validationContext = buildValidationContext(projectRoot, config, plugins);
+      const results = validateTasks(parsedRoadmap.tasks, validationContext, config, plugins);
+      const audit = auditValidation(parsedRoadmap.tasks, results);
+      printAudit(audit);
+    }
+    return;
+  }
+
+  if (command === 'sync') {
+    const projectRoot = path.resolve(String(flags['project-root'] || process.cwd()));
+    const config = loadConfig({ projectRoot, configPath: flags.config });
+    const roadmapFile = resolveRoadmapFile(projectRoot, config, flags['roadmap-file']);
+    const content = readTextIfExists(roadmapFile);
+    if (content == null) {
+      throw new Error(`Roadmap not found: ${roadmapFile}`);
+    }
+
+    const parsedRoadmap = parseRoadmap(content);
+    const validationContext = buildValidationContext(projectRoot, config, loadPlugins(projectRoot, config.plugins));
+    const results = validateTasks(parsedRoadmap.tasks, validationContext, config, validationContext.plugins);
+    applyMinimumConfidence(results, config.validation?.minimumConfidence);
+    const next = applySync(content, parsedRoadmap.tasks, results);
+    const dryRun = isEnabled(flags['dry-run']);
+    const writeResult = writeText(roadmapFile, next, { dryRun });
+
+    if (dryRun) {
+      if (writeResult.changed) {
+        printDryRunDiff(roadmapFile, writeResult.before, writeResult.after);
+      } else {
+        console.log(`No changes for ${roadmapFile}`);
+      }
+    } else {
+      console.log(writeResult.changed ? `Updated ${roadmapFile}` : `No changes for ${roadmapFile}`);
+    }
+
+    if (isEnabled(flags.audit)) {
+      const audit = auditValidation(parsedRoadmap.tasks, results);
+      printAudit(audit);
+    }
+    return;
+  }
+
+  if (command === 'validate') {
+    const projectRoot = path.resolve(String(flags['project-root'] || process.cwd()));
+    const config = loadConfig({ projectRoot, configPath: flags.config });
+    const roadmapFile = resolveRoadmapFile(projectRoot, config, flags['roadmap-file']);
+    const content = readTextIfExists(roadmapFile);
+    if (content == null) {
+      throw new Error(`Roadmap not found: ${roadmapFile}`);
+    }
+
+    const parsedRoadmap = parseRoadmap(content);
+    const tasks = maybeFilterTasks(parsedRoadmap.tasks, flags.task);
+    const validationContext = buildValidationContext(projectRoot, config, loadPlugins(projectRoot, config.plugins));
+    const results = validateTasks(tasks, validationContext, config, validationContext.plugins);
+
+    const minRank = CONFIDENCE_RANK[config.validation && config.validation.minimumConfidence] ?? 0;
+    const visibleTasks = tasks.filter((task) => (CONFIDENCE_RANK[results[task.id].confidence] ?? 0) >= minRank);
+
+    if (isEnabled(flags.json)) {
+      const payload = visibleTasks.map((task) => ({ task, result: results[task.id] }));
+      console.log(JSON.stringify(payload, null, 2));
+    } else {
+      visibleTasks.forEach((task) => {
+        console.log(formatResultLine(task, results[task.id]));
+      });
+    }
+
+    const failed = visibleTasks.some((task) => !results[task.id].passed);
+    if (failed) {
+      process.exitCode = 1;
+    }
+    return;
+  }
+
+  if (command === 'doctor') {
+    const projectRoot = path.resolve(String(flags['project-root'] || process.cwd()));
+    let ok = true;
+
+    let config;
+    try {
+      config = loadConfig({ projectRoot, configPath: flags.config });
+      console.log('[ok] Config loaded without errors');
+    } catch (error) {
+      console.error(`[fail] Config error: ${error.message}`);
+      ok = false;
+    }
+
+    if (config) {
+      const roadmapFile = resolveRoadmapFile(projectRoot, config, flags['roadmap-file']);
+      if (fs.existsSync(roadmapFile)) {
+        console.log(`[ok] ROADMAP file found: ${roadmapFile}`);
+      } else {
+        console.error(`[fail] ROADMAP file not found: ${roadmapFile}`);
+        ok = false;
+      }
+    }
+
+    if (!ok) {
+      process.exitCode = 1;
+      return;
+    }
+    console.log('doctor: all checks passed');
+    return;
+  }
+
+  throw new Error(`Unknown command: ${command}`);
+}
+
+run().catch((error) => {
+  console.error(error.message);
+  process.exitCode = 1;
+});

package/package.json

@@ -1,56 +1,56 @@
-{
-  "name": "roadmapsmith",
-  "version": "0.9.2",
-  "description": "Evidence-backed ROADMAP.md generator and sync tool for AI coding agents.",
-  "main": "src/index.js",
-  "bin": {
-    "roadmapsmith": "bin/cli.js"
-  },
-  "type": "commonjs",
-  "scripts": {
-    "test": "node --test test/*.test.js"
-  },
-  "keywords": [
-    "roadmap",
-    "planning",
-    "agent",
-    "cli",
-    "validation",
-    "sync",
-    "task-tracking",
-    "evidence-based",
-    "deterministic",
-    "monorepo",
-    "claude-code",
-    "ai-agent",
-    "project-management",
-    "coding-agents",
-    "agent-skills",
-    "roadmap-generator",
-    "roadmap-sync",
-    "task-validation",
-    "developer-tools",
-    "markdown",
-    "agent-workflow"
-  ],
-  "author": "PapiScholz",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/PapiScholz/roadmapsmith.git",
-    "directory": "roadmap-skill"
-  },
-  "bugs": {
-    "url": "https://github.com/PapiScholz/roadmapsmith/issues"
-  },
-  "homepage": "https://github.com/PapiScholz/roadmapsmith#readme",
-  "engines": {
-    "node": ">=18"
-  },
-  "files": [
-    "bin",
-    "src",
-    "templates",
-    "README.md"
-  ]
-}
+{
+  "name": "roadmapsmith",
+  "version": "0.9.3",
+  "description": "Evidence-backed ROADMAP.md generator and sync tool for AI coding agents.",
+  "main": "src/index.js",
+  "bin": {
+    "roadmapsmith": "bin/cli.js"
+  },
+  "type": "commonjs",
+  "scripts": {
+    "test": "node --test test/*.test.js"
+  },
+  "keywords": [
+    "roadmap",
+    "planning",
+    "agent",
+    "cli",
+    "validation",
+    "sync",
+    "task-tracking",
+    "evidence-based",
+    "deterministic",
+    "monorepo",
+    "claude-code",
+    "ai-agent",
+    "project-management",
+    "coding-agents",
+    "agent-skills",
+    "roadmap-generator",
+    "roadmap-sync",
+    "task-validation",
+    "developer-tools",
+    "markdown",
+    "agent-workflow"
+  ],
+  "author": "PapiScholz",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PapiScholz/roadmapsmith.git",
+    "directory": "roadmap-skill"
+  },
+  "bugs": {
+    "url": "https://github.com/PapiScholz/roadmapsmith/issues"
+  },
+  "homepage": "https://github.com/PapiScholz/roadmapsmith#readme",
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "bin",
+    "src",
+    "templates",
+    "README.md"
+  ]
+}