@girardmedia/bootspring 2.5.0 → 2.5.2

package/generators/sprint.js

@@ -1,675 +0,0 @@
-/**
- * Bootspring SPRINT.md Generator
- *
- * Generates sprint documentation with goals, tasks, blockers,
- * dependencies, progress tracking, and burndown metrics.
- *
- * @package bootspring
- * @module generators/sprint
- */
-
-const fs = require('fs');
-const path = require('path');
-
-/**
- * Sprint status values
- */
-const SPRINT_STATUS = {
-  PLANNING: 'planning',
-  ACTIVE: 'active',
-  REVIEW: 'review',
-  COMPLETED: 'completed'
-};
-
-/**
- * Task status values
- */
-const TASK_STATUS = {
-  TODO: 'todo',
-  IN_PROGRESS: 'in_progress',
-  BLOCKED: 'blocked',
-  IN_REVIEW: 'in_review',
-  DONE: 'done'
-};
-
-/**
- * Priority levels
- */
-const PRIORITY = {
-  CRITICAL: { value: 1, label: 'Critical', emoji: '🔴' },
-  HIGH: { value: 2, label: 'High', emoji: '🟠' },
-  MEDIUM: { value: 3, label: 'Medium', emoji: '🟡' },
-  LOW: { value: 4, label: 'Low', emoji: '🟢' }
-};
-
-/**
- * Default sprint configuration
- */
-const DEFAULT_CONFIG = {
-  sprintDuration: 14, // days
-  workingHoursPerDay: 8,
-  velocityBuffer: 0.8, // 80% of capacity
-  includeWeekends: false
-};
-
-/**
- * Sprint Document Generator
- */
-class SprintGenerator {
-  constructor(options = {}) {
-    this.projectRoot = options.projectRoot || process.cwd();
-    this.config = { ...DEFAULT_CONFIG, ...options };
-    this.sprintDataPath = path.join(this.projectRoot, '.bootspring', 'sprint.json');
-  }
-
-  /**
-   * Load current sprint data
-   */
-  loadSprintData() {
-    try {
-      if (fs.existsSync(this.sprintDataPath)) {
-        return JSON.parse(fs.readFileSync(this.sprintDataPath, 'utf-8'));
-      }
-    } catch (_err) {
-      // Return default
-    }
-
-    return this.createDefaultSprint();
-  }
-
-  /**
-   * Save sprint data
-   */
-  saveSprintData(data) {
-    const dir = path.dirname(this.sprintDataPath);
-    if (!fs.existsSync(dir)) {
-      fs.mkdirSync(dir, { recursive: true });
-    }
-    fs.writeFileSync(this.sprintDataPath, JSON.stringify(data, null, 2));
-  }
-
-  /**
-   * Create default sprint structure
-   */
-  createDefaultSprint() {
-    const now = new Date();
-    const endDate = new Date(now);
-    endDate.setDate(endDate.getDate() + this.config.sprintDuration);
-
-    return {
-      id: `sprint-${now.getTime()}`,
-      name: `Sprint ${this.getSprintNumber()}`,
-      status: SPRINT_STATUS.PLANNING,
-      startDate: now.toISOString().split('T')[0],
-      endDate: endDate.toISOString().split('T')[0],
-      goals: [],
-      tasks: [],
-      blockers: [],
-      metrics: {
-        totalPoints: 0,
-        completedPoints: 0,
-        velocity: 0
-      },
-      dailyProgress: [],
-      team: [],
-      notes: ''
-    };
-  }
-
-  /**
-   * Get sprint number based on history
-   */
-  getSprintNumber() {
-    const historyPath = path.join(this.projectRoot, '.bootspring', 'sprint-history.json');
-    try {
-      if (fs.existsSync(historyPath)) {
-        const history = JSON.parse(fs.readFileSync(historyPath, 'utf-8'));
-        return (history.sprints?.length || 0) + 1;
-      }
-    } catch (_err) {
-      // Return default
-    }
-    return 1;
-  }
-
-  /**
-   * Add a goal to the sprint
-   */
-  addGoal(sprint, goal) {
-    sprint.goals.push({
-      id: `goal-${Date.now()}`,
-      description: goal.description,
-      success_criteria: goal.success_criteria || [],
-      status: 'pending',
-      created: new Date().toISOString()
-    });
-    return sprint;
-  }
-
-  /**
-   * Add a task to the sprint
-   */
-  addTask(sprint, task) {
-    sprint.tasks.push({
-      id: `task-${Date.now()}`,
-      title: task.title,
-      description: task.description || '',
-      assignee: task.assignee || null,
-      estimate: task.estimate || 0, // story points or hours
-      status: TASK_STATUS.TODO,
-      priority: task.priority || 'medium',
-      dependencies: task.dependencies || [],
-      blockedBy: task.blockedBy || [],
-      labels: task.labels || [],
-      created: new Date().toISOString(),
-      started: null,
-      completed: null
-    });
-
-    // Update metrics
-    sprint.metrics.totalPoints += task.estimate || 0;
-
-    return sprint;
-  }
-
-  /**
-   * Add a blocker
-   */
-  addBlocker(sprint, blocker) {
-    sprint.blockers.push({
-      id: `blocker-${Date.now()}`,
-      description: blocker.description,
-      affectedTasks: blocker.affectedTasks || [],
-      severity: blocker.severity || 'medium',
-      status: 'open',
-      owner: blocker.owner || null,
-      created: new Date().toISOString(),
-      resolved: null
-    });
-    return sprint;
-  }
-
-  /**
-   * Update task status
-   */
-  updateTaskStatus(sprint, taskId, newStatus) {
-    const task = sprint.tasks.find(t => t.id === taskId);
-    if (task) {
-      const oldStatus = task.status;
-      task.status = newStatus;
-
-      if (newStatus === TASK_STATUS.IN_PROGRESS && !task.started) {
-        task.started = new Date().toISOString();
-      }
-
-      if (newStatus === TASK_STATUS.DONE && !task.completed) {
-        task.completed = new Date().toISOString();
-        sprint.metrics.completedPoints += task.estimate || 0;
-      }
-
-      // If reverting from done, adjust points
-      if (oldStatus === TASK_STATUS.DONE && newStatus !== TASK_STATUS.DONE) {
-        sprint.metrics.completedPoints -= task.estimate || 0;
-      }
-    }
-    return sprint;
-  }
-
-  /**
-   * Record daily progress
-   */
-  recordDailyProgress(sprint) {
-    const today = new Date().toISOString().split('T')[0];
-
-    // Check if already recorded today
-    const existingIndex = sprint.dailyProgress.findIndex(p => p.date === today);
-
-    const progress = {
-      date: today,
-      completedPoints: sprint.metrics.completedPoints,
-      remainingPoints: sprint.metrics.totalPoints - sprint.metrics.completedPoints,
-      tasksDone: sprint.tasks.filter(t => t.status === TASK_STATUS.DONE).length,
-      tasksInProgress: sprint.tasks.filter(t => t.status === TASK_STATUS.IN_PROGRESS).length,
-      blockerCount: sprint.blockers.filter(b => b.status === 'open').length
-    };
-
-    if (existingIndex >= 0) {
-      sprint.dailyProgress[existingIndex] = progress;
-    } else {
-      sprint.dailyProgress.push(progress);
-    }
-
-    return sprint;
-  }
-
-  /**
-   * Calculate burndown data
-   */
-  calculateBurndown(sprint) {
-    const startDate = new Date(sprint.startDate);
-    const endDate = new Date(sprint.endDate);
-    const totalDays = Math.ceil((endDate - startDate) / (1000 * 60 * 60 * 24));
-    const idealPointsPerDay = sprint.metrics.totalPoints / totalDays;
-
-    const burndown = [];
-    const currentDate = new Date(startDate);
-    let idealRemaining = sprint.metrics.totalPoints;
-
-    while (currentDate <= endDate) {
-      const dateStr = currentDate.toISOString().split('T')[0];
-      const actualProgress = sprint.dailyProgress.find(p => p.date === dateStr);
-
-      burndown.push({
-        date: dateStr,
-        ideal: Math.max(0, Math.round(idealRemaining * 10) / 10),
-        actual: actualProgress ? actualProgress.remainingPoints : null
-      });
-
-      idealRemaining -= idealPointsPerDay;
-      currentDate.setDate(currentDate.getDate() + 1);
-    }
-
-    return burndown;
-  }
-
-  /**
-   * Calculate sprint metrics
-   */
-  calculateMetrics(sprint) {
-    const tasks = sprint.tasks;
-    const now = new Date();
-    const startDate = new Date(sprint.startDate);
-    const endDate = new Date(sprint.endDate);
-
-    const totalDays = Math.ceil((endDate - startDate) / (1000 * 60 * 60 * 24));
-    const elapsedDays = Math.ceil((now - startDate) / (1000 * 60 * 60 * 24));
-    const remainingDays = Math.max(0, totalDays - elapsedDays);
-
-    const completedTasks = tasks.filter(t => t.status === TASK_STATUS.DONE);
-    const inProgressTasks = tasks.filter(t => t.status === TASK_STATUS.IN_PROGRESS);
-    const blockedTasks = tasks.filter(t => t.status === TASK_STATUS.BLOCKED);
-    const todoTasks = tasks.filter(t => t.status === TASK_STATUS.TODO);
-
-    const completedPoints = completedTasks.reduce((sum, t) => sum + (t.estimate || 0), 0);
-    const totalPoints = tasks.reduce((sum, t) => sum + (t.estimate || 0), 0);
-    const remainingPoints = totalPoints - completedPoints;
-
-    const percentComplete = totalPoints > 0 ? Math.round((completedPoints / totalPoints) * 100) : 0;
-    const velocity = elapsedDays > 0 ? Math.round((completedPoints / elapsedDays) * 10) / 10 : 0;
-    const projectedCompletion = velocity > 0 ? Math.ceil(remainingPoints / velocity) : null;
-
-    return {
-      totalTasks: tasks.length,
-      completedTasks: completedTasks.length,
-      inProgressTasks: inProgressTasks.length,
-      blockedTasks: blockedTasks.length,
-      todoTasks: todoTasks.length,
-      totalPoints,
-      completedPoints,
-      remainingPoints,
-      percentComplete,
-      velocity,
-      elapsedDays,
-      remainingDays,
-      projectedCompletion,
-      onTrack: projectedCompletion !== null && projectedCompletion <= remainingDays,
-      openBlockers: sprint.blockers.filter(b => b.status === 'open').length
-    };
-  }
-
-  /**
-   * Generate SPRINT.md content
-   */
-  generate(sprint = null) {
-    if (!sprint) {
-      sprint = this.loadSprintData();
-    }
-
-    const metrics = this.calculateMetrics(sprint);
-    const burndown = this.calculateBurndown(sprint);
-    const now = new Date().toISOString().split('T')[0];
-
-    const sections = [];
-
-    // Header
-    sections.push(`# ${sprint.name}
-
-**Status:** ${this.formatStatus(sprint.status)}
-**Period:** ${sprint.startDate} → ${sprint.endDate}
-**Last Updated:** ${now}
-
----`);
-
-    // Progress Overview
-    const progressBar = this.generateProgressBar(metrics.percentComplete);
-    sections.push(`## Progress Overview
-
-${progressBar} **${metrics.percentComplete}%** Complete
-
-| Metric | Value |
-|--------|-------|
-| Total Tasks | ${metrics.totalTasks} |
-| Completed | ${metrics.completedTasks} |
-| In Progress | ${metrics.inProgressTasks} |
-| Blocked | ${metrics.blockedTasks} |
-| Story Points | ${metrics.completedPoints}/${metrics.totalPoints} |
-| Velocity | ${metrics.velocity} pts/day |
-| Days Remaining | ${metrics.remainingDays} |
-| Status | ${metrics.onTrack ? '✅ On Track' : '⚠️ At Risk'} |
-
----`);
-
-    // Sprint Goals
-    if (sprint.goals.length > 0) {
-      sections.push(`## Sprint Goals
-
-${sprint.goals.map((goal, i) => {
-    const statusIcon = goal.status === 'completed' ? '✅' : goal.status === 'in_progress' ? '🔄' : '⬜';
-    return `${i + 1}. ${statusIcon} **${goal.description}**
-   ${goal.success_criteria.length > 0 ? goal.success_criteria.map(c => `   - ${c}`).join('\n') : ''}`;
-  }).join('\n\n')}
-
----`);
-    }
-
-    // Tasks by Status
-    sections.push(`## Tasks
-
-### 🔄 In Progress (${metrics.inProgressTasks})
-
-${this.formatTaskList(sprint.tasks.filter(t => t.status === TASK_STATUS.IN_PROGRESS))}
-
-### 🚫 Blocked (${metrics.blockedTasks})
-
-${this.formatTaskList(sprint.tasks.filter(t => t.status === TASK_STATUS.BLOCKED))}
-
-### 📋 To Do (${metrics.todoTasks})
-
-${this.formatTaskList(sprint.tasks.filter(t => t.status === TASK_STATUS.TODO))}
-
-### ✅ Done (${metrics.completedTasks})
-
-${this.formatTaskList(sprint.tasks.filter(t => t.status === TASK_STATUS.DONE), true)}
-
----`);
-
-    // Blockers
-    if (sprint.blockers.length > 0) {
-      const openBlockers = sprint.blockers.filter(b => b.status === 'open');
-      const resolvedBlockers = sprint.blockers.filter(b => b.status === 'resolved');
-
-      sections.push(`## Blockers
-
-### 🚨 Open (${openBlockers.length})
-
-${openBlockers.length > 0 ? openBlockers.map(b => `- **${b.description}**
-  - Severity: ${b.severity}
-  - Owner: ${b.owner || 'Unassigned'}
-  - Affects: ${b.affectedTasks.length} task(s)`).join('\n\n') : '_No open blockers_'}
-
-### ✅ Resolved (${resolvedBlockers.length})
-
-${resolvedBlockers.length > 0 ? resolvedBlockers.map(b => `- ~~${b.description}~~ (resolved ${b.resolved || 'unknown'})`).join('\n') : '_No resolved blockers_'}
-
----`);
-    }
-
-    // Burndown Chart (ASCII)
-    sections.push(`## Burndown
-
-\`\`\`
-${this.generateAsciiBurndown(burndown, metrics.totalPoints)}
-\`\`\`
-
----`);
-
-    // Daily Log
-    if (sprint.dailyProgress.length > 0) {
-      const recentProgress = sprint.dailyProgress.slice(-7);
-      sections.push(`## Daily Progress (Last 7 Days)
-
-| Date | Points Done | Remaining | Tasks Done | Blockers |
-|------|-------------|-----------|------------|----------|
-${recentProgress.map(p => `| ${p.date} | ${p.completedPoints} | ${p.remainingPoints} | ${p.tasksDone} | ${p.blockerCount} |`).join('\n')}
-
----`);
-    }
-
-    // Team
-    if (sprint.team.length > 0) {
-      sections.push(`## Team
-
-${sprint.team.map(member => `- **${member.name}** - ${member.role || 'Team Member'}
-  - Tasks: ${sprint.tasks.filter(t => t.assignee === member.name).length}
-  - Points: ${sprint.tasks.filter(t => t.assignee === member.name).reduce((s, t) => s + (t.estimate || 0), 0)}`).join('\n\n')}
-
----`);
-    }
-
-    // Notes
-    if (sprint.notes) {
-      sections.push(`## Notes
-
-${sprint.notes}
-
----`);
-    }
-
-    // Footer
-    sections.push(`---
-
-*Generated by [Bootspring](https://bootspring.com) Sprint Generator*
-*Sprint ID: ${sprint.id}*
-`);
-
-    return sections.join('\n\n');
-  }
-
-  /**
-   * Format status with emoji
-   */
-  formatStatus(status) {
-    const statusMap = {
-      [SPRINT_STATUS.PLANNING]: '📝 Planning',
-      [SPRINT_STATUS.ACTIVE]: '🚀 Active',
-      [SPRINT_STATUS.REVIEW]: '🔍 Review',
-      [SPRINT_STATUS.COMPLETED]: '✅ Completed'
-    };
-    return statusMap[status] || status;
-  }
-
-  /**
-   * Generate progress bar
-   */
-  generateProgressBar(percent, width = 20) {
-    const filled = Math.round((percent / 100) * width);
-    const empty = width - filled;
-    return `[${'█'.repeat(filled)}${'░'.repeat(empty)}]`;
-  }
-
-  /**
-   * Format task list
-   */
-  formatTaskList(tasks, collapsed = false) {
-    if (tasks.length === 0) {
-      return '_No tasks_';
-    }
-
-    return tasks.map(task => {
-      const priority = PRIORITY[task.priority?.toUpperCase()] || PRIORITY.MEDIUM;
-      const estimate = task.estimate ? `(${task.estimate} pts)` : '';
-      const assignee = task.assignee ? `@${task.assignee}` : '';
-      const labels = task.labels.length > 0 ? task.labels.map(l => `\`${l}\``).join(' ') : '';
-
-      if (collapsed) {
-        return `- [x] ${task.title} ${estimate}`;
-      }
-
-      return `- [ ] ${priority.emoji} **${task.title}** ${estimate}
-  ${task.description ? task.description + '\n  ' : ''}${assignee} ${labels}`.trim();
-    }).join('\n\n');
-  }
-
-  /**
-   * Generate ASCII burndown chart
-   */
-  generateAsciiBurndown(burndown, maxPoints) {
-    const height = 10;
-    const width = Math.min(burndown.length, 30);
-    const pointsPerRow = maxPoints / height;
-
-    const chart = [];
-
-    // Y-axis labels
-    for (let row = 0; row <= height; row++) {
-      const points = Math.round(maxPoints - (row * pointsPerRow));
-      const label = points.toString().padStart(4);
-      let line = `${label} |`;
-
-      // Plot points
-      for (let col = 0; col < width && col < burndown.length; col++) {
-        const data = burndown[col];
-        const idealRow = Math.round((maxPoints - data.ideal) / pointsPerRow);
-        const actualRow = data.actual !== null ? Math.round((maxPoints - data.actual) / pointsPerRow) : null;
-
-        if (row === idealRow && actualRow === row) {
-          line += '◆'; // Both ideal and actual
-        } else if (row === idealRow) {
-          line += '─'; // Ideal line
-        } else if (row === actualRow) {
-          line += '●'; // Actual point
-        } else {
-          line += ' ';
-        }
-      }
-
-      chart.push(line);
-    }
-
-    // X-axis
-    chart.push('     +' + '─'.repeat(width));
-    chart.push('      ' + burndown.slice(0, width).map((_, i) => (i % 5 === 0 ? '|' : ' ')).join(''));
-
-    // Legend
-    chart.push('');
-    chart.push('Legend: ─ Ideal  ● Actual  ◆ Both');
-
-    return chart.join('\n');
-  }
-
-  /**
-   * Import tasks from todo.md
-   */
-  importFromTodo(sprint, todoContent) {
-    const lines = todoContent.split('\n');
-    const tasks = [];
-
-    for (const line of lines) {
-      const match = line.match(/^[-*]\s*\[([ x])\]\s*(.+)$/);
-      if (match) {
-        const done = match[1] === 'x';
-        const title = match[2].trim();
-
-        tasks.push({
-          title,
-          estimate: this.estimateFromTitle(title),
-          status: done ? TASK_STATUS.DONE : TASK_STATUS.TODO,
-          priority: this.inferPriority(title)
-        });
-      }
-    }
-
-    for (const task of tasks) {
-      this.addTask(sprint, task);
-    }
-
-    return sprint;
-  }
-
-  /**
-   * Estimate points from task title (heuristic)
-   */
-  estimateFromTitle(title) {
-    const lower = title.toLowerCase();
-
-    if (lower.includes('fix') || lower.includes('typo') || lower.includes('update')) {
-      return 1;
-    }
-    if (lower.includes('add') || lower.includes('implement') || lower.includes('create')) {
-      return 3;
-    }
-    if (lower.includes('refactor') || lower.includes('redesign') || lower.includes('migrate')) {
-      return 5;
-    }
-    if (lower.includes('integrate') || lower.includes('authentication') || lower.includes('payment')) {
-      return 8;
-    }
-
-    return 2; // Default
-  }
-
-  /**
-   * Infer priority from title
-   */
-  inferPriority(title) {
-    const lower = title.toLowerCase();
-
-    if (lower.includes('critical') || lower.includes('urgent') || lower.includes('security')) {
-      return 'critical';
-    }
-    if (lower.includes('important') || lower.includes('high')) {
-      return 'high';
-    }
-    if (lower.includes('low') || lower.includes('nice to have')) {
-      return 'low';
-    }
-
-    return 'medium';
-  }
-}
-
-/**
- * Generate SPRINT.md from project state
- */
-function generate(options = {}) {
-  const generator = new SprintGenerator(options);
-  const sprint = generator.loadSprintData();
-  return generator.generate(sprint);
-}
-
-/**
- * Create a new sprint
- */
-function createSprint(options = {}) {
-  const generator = new SprintGenerator(options);
-  const sprint = generator.createDefaultSprint();
-  generator.saveSprintData(sprint);
-  return sprint;
-}
-
-/**
- * Load current sprint
- */
-function loadSprint(options = {}) {
-  const generator = new SprintGenerator(options);
-  return generator.loadSprintData();
-}
-
-/**
- * Save sprint data
- */
-function saveSprint(sprint, options = {}) {
-  const generator = new SprintGenerator(options);
-  generator.saveSprintData(sprint);
-}
-
-module.exports = {
-  SprintGenerator,
-  generate,
-  createSprint,
-  loadSprint,
-  saveSprint,
-  SPRINT_STATUS,
-  TASK_STATUS,
-  PRIORITY
-};