@paths.design/caws-cli 10.2.0 → 11.0.0

package/dist/commands/archive.js

@@ -1,500 +0,0 @@
-/**
- * @fileoverview CAWS Archive Command
- * Archive completed changes with lifecycle management (multi-spec aware)
- * @author @darianrosebrook
- */
-
-const fs = require('fs-extra');
-const path = require('path');
-const yaml = require('js-yaml');
-const chalk = require('chalk');
-const { execSync } = require('child_process');
-const { safeAsync, outputResult } = require('../error-handler');
-const { findProjectRoot } = require('../utils/detection');
-
-// Import spec resolution system
-const { resolveSpec } = require('../utils/spec-resolver');
-
-/**
- * Load change folder structure
- * @param {string} changeId - Change identifier
- * @returns {Promise<Object|null>} Change data or null
- */
-async function loadChange(changeId) {
-  const projectRoot = findProjectRoot();
-  const changesDir = path.join(projectRoot, '.caws/changes');
-  const changePath = path.join(changesDir, changeId);
-
-  if (!(await fs.pathExists(changePath))) {
-    return null;
-  }
-
-  try {
-    const metadataPath = path.join(changePath, 'metadata.yaml');
-    const workingSpecPath = path.join(changePath, 'working-spec.yaml');
-
-    const metadata = (await fs.pathExists(metadataPath))
-      ? yaml.load(await fs.readFile(metadataPath, 'utf8'))
-      : {};
-
-    const workingSpec = (await fs.pathExists(workingSpecPath))
-      ? yaml.load(await fs.readFile(workingSpecPath, 'utf8'))
-      : null;
-
-    return {
-      id: changeId,
-      path: changePath,
-      metadata,
-      workingSpec,
-      workingSpecPath: (await fs.pathExists(workingSpecPath)) ? workingSpecPath : null,
-      exists: true,
-    };
-  } catch (error) {
-    throw new Error(`Failed to load change '${changeId}': ${error.message}`);
-  }
-}
-
-/**
- * Validate all acceptance criteria are met
- * @param {Object} workingSpec - Working specification
- * @returns {Promise<Object>} Validation result
- */
-async function validateAcceptanceCriteria(workingSpec) {
-  const criteria = Array.isArray(workingSpec?.acceptance_criteria)
-    ? workingSpec.acceptance_criteria
-    : Array.isArray(workingSpec?.acceptance)
-      ? workingSpec.acceptance
-      : [];
-
-  if (!workingSpec || criteria.length === 0) {
-    return {
-      valid: false,
-      message: 'No acceptance criteria found in working spec',
-    };
-  }
-
-  const hasCompletionTracking = criteria.some((criterion) => criterion.completed !== undefined);
-  const incomplete = [];
-
-  for (const criterion of criteria) {
-    if (criterion.completed === false) {
-      incomplete.push(criterion.id || 'unknown');
-    }
-  }
-
-  if (incomplete.length > 0) {
-    return {
-      valid: false,
-      message: `Incomplete acceptance criteria: ${incomplete.join(', ')}`,
-    };
-  }
-
-  if (!hasCompletionTracking) {
-    return {
-      valid: true,
-      message: `Acceptance criteria present (${criteria.length}); no explicit completion flags found`,
-    };
-  }
-
-  return {
-    valid: true,
-    message: `All ${criteria.length} acceptance criteria completed`,
-  };
-}
-
-/**
- * Validate change meets quality gates
- * Runs the actual quality gates runner and checks for violations
- * @param {string} changeId - Change identifier
- * @returns {Promise<Object>} Quality gate result
- */
-async function validateQualityGates(_changeId) {
-  const gates = [];
-  const violations = [];
-  const warnings = [];
-
-  try {
-    // Try to run the quality gates runner
-    const qualityGatesPath = path.join(
-      __dirname,
-      '..',
-      '..',
-      '..',
-      'quality-gates',
-      'run-quality-gates.mjs'
-    );
-
-    // Check if quality gates runner exists
-    if (await fs.pathExists(qualityGatesPath)) {
-      try {
-        // Run quality gates in CI mode (checks all files, not just staged)
-        const result = execSync(`node "${qualityGatesPath}" --context=ci --json 2>&1`, {
-          encoding: 'utf8',
-          timeout: 60000, // 60 second timeout
-          cwd: process.cwd(),
-        });
-
-        // Try to parse JSON output
-        try {
-          const jsonMatch = result.match(/\{[\s\S]*\}$/);
-          if (jsonMatch) {
-            const parsed = JSON.parse(jsonMatch[0]);
-            if (parsed.violations) {
-              violations.push(...parsed.violations);
-            }
-            if (parsed.warnings) {
-              warnings.push(...parsed.warnings);
-            }
-            gates.push(...(parsed.gates || []));
-          }
-        } catch {
-          // JSON parsing failed, check for error indicators in output
-          if (result.includes('') || result.includes('FAIL')) {
-            violations.push({ message: 'Quality gates reported failures', output: result });
-          }
-        }
-      } catch (execError) {
-        // Command failed - check exit code and output
-        if (execError.status !== 0) {
-          const output = execError.stdout || execError.message;
-          if (output.includes('violations') || output.includes('')) {
-            violations.push({ message: 'Quality gates failed', output: output.substring(0, 500) });
-          }
-        }
-      }
-    }
-
-    // Also check for active waivers that might cover violations
-    const waiversPath = path.join(process.cwd(), '.caws', 'waivers', 'active-waivers.yaml');
-    let hasActiveWaivers = false;
-    if (await fs.pathExists(waiversPath)) {
-      const waiversContent = await fs.readFile(waiversPath, 'utf8');
-      const waivers = yaml.load(waiversContent);
-      if (waivers && waivers.waivers) {
-        const activeWaiverCount = Object.keys(waivers.waivers).length;
-        if (activeWaiverCount > 0) {
-          hasActiveWaivers = true;
-          gates.push(`${activeWaiverCount} active waiver(s)`);
-        }
-      }
-    }
-
-    // Determine overall validity
-    const hasBlockingViolations = violations.some(
-      (v) => v.severity === 'block' || v.severity === 'fail'
-    );
-
-    if (violations.length === 0) {
-      return {
-        valid: true,
-        message: 'All quality gates passed',
-        gates: gates.length > 0 ? gates : ['naming', 'duplication', 'god-objects', 'hidden-todo'],
-        violations: [],
-        warnings,
-      };
-    } else if (hasActiveWaivers && !hasBlockingViolations) {
-      return {
-        valid: true,
-        message: `Quality gates passed with ${violations.length} waived violation(s)`,
-        gates,
-        violations,
-        warnings,
-        waived: true,
-      };
-    } else {
-      return {
-        valid: false,
-        message: `${violations.length} quality gate violation(s) found`,
-        gates,
-        violations,
-        warnings,
-      };
-    }
-  } catch (error) {
-    // If quality gates can't be run, warn but don't block
-    return {
-      valid: true,
-      message: `Quality gates check skipped: ${error.message}`,
-      gates: [],
-      violations: [],
-      warnings: [{ message: `Could not run quality gates: ${error.message}` }],
-      skipped: true,
-    };
-  }
-}
-
-/**
- * Generate change summary for archival
- * @param {Object} change - Change data
- * @returns {Promise<string>} Summary text
- */
-async function generateChangeSummary(change, workingSpec) {
-  const { metadata } = change;
-
-  let summary = `# Change Summary: ${change.id}\n\n`;
-
-  if (workingSpec) {
-    summary += `**Title**: ${workingSpec.title || 'Untitled'}\n`;
-    summary += `**Risk Tier**: ${workingSpec.risk_tier || 'Unknown'}\n`;
-    summary += `**Mode**: ${workingSpec.mode || 'Unknown'}\n\n`;
-
-    if (workingSpec.acceptance_criteria) {
-      const total = workingSpec.acceptance_criteria.length;
-      const completed = workingSpec.acceptance_criteria.filter((c) => c.completed).length;
-      summary += `**Acceptance Criteria**: ${completed}/${total} completed\n\n`;
-    }
-  }
-
-  if (metadata.created_at) {
-    summary += `**Created**: ${new Date(metadata.created_at).toISOString()}\n`;
-  }
-
-  if (metadata.completed_at) {
-    summary += `**Completed**: ${new Date(metadata.completed_at).toISOString()}\n`;
-  }
-
-  summary += `\n**Files Changed**: ${metadata.files_changed || 0}\n`;
-  summary += `**Lines Added**: ${metadata.lines_added || 0}\n`;
-  summary += `**Lines Removed**: ${metadata.lines_removed || 0}\n`;
-
-  return summary;
-}
-
-/**
- * Archive change folder to archive directory
- * @param {Object} change - Change data
- * @returns {Promise<void>}
- */
-async function archiveChange(change) {
-  const archiveDir = '.caws/archive';
-  const archivePath = path.join(archiveDir, change.id);
-
-  // Ensure archive directory exists
-  await fs.ensureDir(archiveDir);
-
-  // Move change folder to archive
-  await fs.move(change.path, archivePath);
-
-  console.log(chalk.green(`   Moved to: ${archivePath}`));
-}
-
-/**
- * Update provenance with completion
- * @param {Object} change - Change data
- * @returns {Promise<void>}
- */
-async function updateProvenance(change, specSelection) {
-  const provenanceDir = '.caws/provenance';
-  const chainPath = path.join(provenanceDir, 'chain.json');
-
-  try {
-    let chain = [];
-
-    if (await fs.pathExists(chainPath)) {
-      chain = JSON.parse(await fs.readFile(chainPath, 'utf8'));
-    }
-
-    // Add completion entry
-    const completionEntry = {
-      timestamp: new Date().toISOString(),
-      action: 'change_completed',
-      change_id: change.id,
-      metadata: {
-        title: specSelection?.spec?.title || change.workingSpec?.title,
-        risk_tier: specSelection?.spec?.risk_tier || change.workingSpec?.risk_tier,
-        spec_id: specSelection?.spec?.id || change.workingSpec?.id || null,
-        spec_path: specSelection?.path || change.workingSpecPath || null,
-        spec_type: specSelection?.type || (change.workingSpecPath ? 'change-snapshot' : null),
-        files_changed: change.metadata?.files_changed || 0,
-        lines_added: change.metadata?.lines_added || 0,
-        lines_removed: change.metadata?.lines_removed || 0,
-      },
-    };
-
-    chain.push(completionEntry);
-
-    await fs.ensureDir(provenanceDir);
-    await fs.writeFile(chainPath, JSON.stringify(chain, null, 2));
-
-    console.log(chalk.green(`   Provenance updated: ${chain.length} total entries`));
-  } catch (error) {
-    console.log(chalk.yellow(`   Could not update provenance: ${error.message}`));
-  }
-}
-
-/**
- * Display archive results
- * @param {Object} change - Change data
- * @param {Object} validation - Validation result
- * @param {Object} qualityGates - Quality gates result
- */
-function displayArchiveResults(change, validation, qualityGates, specSelection) {
-  console.log(chalk.bold.cyan(`\nArchiving Change: ${change.id}`));
-  console.log(chalk.cyan('==============================================\n'));
-
-  if (specSelection?.spec) {
-    console.log(chalk.blue('Spec Context:'));
-    console.log(
-      chalk.gray(
-        `   ${specSelection.spec.id || 'unknown'} (${specSelection.type}) -> ${specSelection.path}`
-      )
-    );
-    console.log('');
-  }
-
-  // Validation status
-  if (validation.valid) {
-    console.log(chalk.green('Acceptance Criteria'));
-    console.log(chalk.gray(`   ${validation.message}`));
-  } else {
-    console.log(chalk.red('Acceptance Criteria'));
-    console.log(chalk.gray(`   ${validation.message}`));
-  }
-
-  console.log('');
-
-  // Quality gates status
-  if (qualityGates.valid) {
-    console.log(chalk.green('Quality Gates'));
-    console.log(chalk.gray(`   ${qualityGates.message}`));
-  } else {
-    console.log(chalk.red('Quality Gates'));
-    console.log(chalk.gray(`   ${qualityGates.message}`));
-  }
-
-  console.log('');
-
-  // Archive action
-  console.log(chalk.blue('Archive Actions:'));
-  console.log(chalk.gray('   - Moving change folder to archive'));
-  console.log(chalk.gray('   - Updating provenance chain'));
-  console.log(chalk.gray('   - Generating change summary'));
-
-  console.log('');
-}
-
-/**
- * Archive command handler
- * @param {string} changeId - Change identifier to archive
- * @param {Object} options - Command options
- */
-async function archiveCommand(changeId, options = {}) {
-  return safeAsync(
-    async () => {
-      if (!changeId) {
-        throw new Error('Change ID is required. Usage: caws archive <change-id>');
-      }
-
-      // Load change data
-      const change = await loadChange(changeId);
-      if (!change) {
-        throw new Error(`Change '${changeId}' not found in .caws/changes/`);
-      }
-
-      // Resolve spec using priority system
-      let specSelection = null;
-      if (options.specId || options.specFile) {
-        specSelection = await resolveSpec({
-          specId: options.specId,
-          specFile: options.specFile,
-          warnLegacy: false,
-        });
-      } else if (change.workingSpec) {
-        specSelection = {
-          path: change.workingSpecPath || path.join(change.path, 'working-spec.yaml'),
-          type: 'change-snapshot',
-          spec: change.workingSpec,
-        };
-      } else {
-        specSelection = await resolveSpec({
-          warnLegacy: false,
-        });
-      }
-
-      const workingSpec = specSelection.spec;
-
-      // Validate acceptance criteria
-      const validation = await validateAcceptanceCriteria(workingSpec);
-
-      // Validate quality gates
-      const qualityGates = await validateQualityGates(changeId);
-
-      // Display results
-      displayArchiveResults(change, validation, qualityGates, specSelection);
-
-      // Check if we should proceed with archival
-      if (!validation.valid) {
-        console.log(chalk.yellow('Cannot archive: Incomplete acceptance criteria'));
-        if (!options.force) {
-          console.log(chalk.yellow('Use --force to archive anyway'));
-          return outputResult({
-            command: 'archive',
-            change: changeId,
-            archived: false,
-            reason: 'incomplete_criteria',
-          });
-        }
-      }
-
-      if (!qualityGates.valid) {
-        console.log(chalk.yellow('Cannot archive: Quality gates not met'));
-        if (!options.force) {
-          console.log(chalk.yellow('Use --force to archive anyway'));
-          return outputResult({
-            command: 'archive',
-            change: changeId,
-            archived: false,
-            reason: 'quality_gates_failed',
-          });
-        }
-      }
-
-      // Perform archival
-      console.log(chalk.blue('Performing archival...'));
-
-      // Update metadata with completion timestamp
-      change.metadata.completed_at = new Date().toISOString();
-      change.metadata.archived = true;
-
-      // Generate and save summary
-      const summary = await generateChangeSummary(change, workingSpec);
-      const summaryPath = path.join(change.path, 'archive-summary.md');
-      await fs.writeFile(summaryPath, summary);
-
-      // Archive the change
-      await archiveChange(change);
-
-      // Update provenance
-      await updateProvenance(change, specSelection);
-
-      console.log(chalk.green(`\nSuccessfully archived change: ${changeId}`));
-
-      return outputResult({
-        command: 'archive',
-        change: changeId,
-        archived: true,
-        specSelection: {
-          id: workingSpec?.id || null,
-          path: specSelection?.path || null,
-          type: specSelection?.type || null,
-        },
-        validation: validation.valid,
-        qualityGates: qualityGates.valid,
-        summary: summary,
-      });
-    },
-    'archive change',
-    true
-  );
-}
-
-module.exports = {
-  archiveCommand,
-  loadChange,
-  validateAcceptanceCriteria,
-  validateQualityGates,
-  generateChangeSummary,
-  archiveChange,
-  updateProvenance,
-  displayArchiveResults,
-};

package/dist/commands/burnup.js

@@ -1,198 +0,0 @@
-/**
- * @fileoverview Burn-up Command Handler
- * Generates budget burn-up reports for scope visibility
- * @author @darianrosebrook
- */
-
-const fs = require('fs-extra');
-const path = require('path');
-const yaml = require('js-yaml');
-const chalk = require('chalk');
-const { execSync } = require('child_process');
-
-const { deriveBudget, generateBurnupReport } = require('../budget-derivation');
-const { resolveSpec } = require('../utils/spec-resolver');
-
-/**
- * Get actual git change statistics from the repository
- * Analyzes changes since the last tag or initial commit
- * @param {string} specDir - Directory containing the spec file
- * @returns {Object} Stats with files_changed, lines_added, lines_removed, lines_changed
- */
-function getGitChangeStats(specDir) {
-  try {
-    const cwd = specDir || process.cwd();
-
-    // Find the base reference - prefer last tag, fall back to first commit
-    let baseRef;
-    try {
-      baseRef = execSync('git describe --tags --abbrev=0 2>/dev/null', {
-        cwd,
-        encoding: 'utf8',
-      }).trim();
-    } catch {
-      // No tags, use first commit
-      try {
-        baseRef = execSync('git rev-list --max-parents=0 HEAD', {
-          cwd,
-          encoding: 'utf8',
-        }).trim();
-      } catch {
-        // Not a git repo or no commits
-        return null;
-      }
-    }
-
-    // Get file change count
-    const filesOutput = execSync(`git diff --name-only ${baseRef}..HEAD`, {
-      cwd,
-      encoding: 'utf8',
-    });
-    const filesChanged = filesOutput.trim().split('\n').filter(Boolean).length;
-
-    // Get line statistics using --numstat
-    const numstatOutput = execSync(`git diff --numstat ${baseRef}..HEAD`, {
-      cwd,
-      encoding: 'utf8',
-    });
-
-    let linesAdded = 0;
-    let linesRemoved = 0;
-
-    numstatOutput
-      .trim()
-      .split('\n')
-      .filter(Boolean)
-      .forEach((line) => {
-        const [added, removed] = line.split('\t');
-        // Skip binary files (shown as '-')
-        if (added !== '-' && removed !== '-') {
-          linesAdded += parseInt(added, 10) || 0;
-          linesRemoved += parseInt(removed, 10) || 0;
-        }
-      });
-
-    return {
-      files_changed: filesChanged,
-      lines_added: linesAdded,
-      lines_removed: linesRemoved,
-      lines_changed: linesAdded + linesRemoved,
-      base_ref: baseRef,
-    };
-  } catch (error) {
-    // Return null if git analysis fails
-    return null;
-  }
-}
-
-/**
- * Burn-up command handler
- * @param {string} specFile - Path to spec file (positional, optional)
- * @param {object} options - Command options including --spec-id
- */
-async function burnupCommand(specFile, options = {}) {
-  try {
-    let specPath;
-    let spec;
-
-    // Resolve spec: explicit file > --spec-id > resolver default
-    if (specFile) {
-      specPath = specFile;
-      if (!fs.existsSync(specPath)) {
-        console.error(chalk.red(`Spec file not found: ${specPath}`));
-        process.exit(1);
-      }
-      spec = yaml.load(fs.readFileSync(specPath, 'utf8'));
-    } else {
-      const resolved = await resolveSpec({ specId: options.specId });
-      specPath = resolved.path;
-      spec = resolved.spec;
-    }
-
-    console.log(chalk.cyan('Generating CAWS budget burn-up report...'));
-
-    // Derive budget
-    const derivedBudget = await deriveBudget(spec, path.dirname(specPath));
-
-    // Get actual git change statistics
-    const gitStats = getGitChangeStats(path.dirname(specPath));
-
-    let currentStats;
-    if (gitStats) {
-      currentStats = {
-        files_changed: gitStats.files_changed,
-        lines_changed: gitStats.lines_changed,
-        lines_added: gitStats.lines_added,
-        lines_removed: gitStats.lines_removed,
-        risk_tier: spec.risk_tier,
-        base_ref: gitStats.base_ref,
-      };
-      console.log(chalk.gray(`   Analyzing changes since: ${gitStats.base_ref}`));
-    } else {
-      // Fallback if git analysis fails (not in a repo or no commits)
-      console.log(chalk.yellow('   Could not analyze git history, using zero values'));
-      currentStats = {
-        files_changed: 0,
-        lines_changed: 0,
-        lines_added: 0,
-        lines_removed: 0,
-        risk_tier: spec.risk_tier,
-      };
-    }
-
-    // Generate report
-    const report = generateBurnupReport(derivedBudget, currentStats);
-
-    console.log(report);
-
-    // Show detailed breakdown
-    console.log(chalk.gray('\nDetailed Budget Analysis:'));
-    console.log(
-      chalk.gray(
-        `   Baseline (Tier ${spec.risk_tier}): ${derivedBudget.baseline.max_files} files, ${derivedBudget.baseline.max_loc} LOC`
-      )
-    );
-    console.log(
-      chalk.gray(
-        `   Effective Budget: ${derivedBudget.effective.max_files} files, ${derivedBudget.effective.max_loc} LOC`
-      )
-    );
-
-    if (derivedBudget.waivers_applied.length > 0) {
-      console.log(chalk.yellow(`   Waivers Applied: ${derivedBudget.waivers_applied.join(', ')}`));
-    }
-
-    console.log(
-      chalk.gray(
-        `   Current Usage: ${currentStats.files_changed} files, ${currentStats.lines_changed} LOC`
-      )
-    );
-    if (currentStats.lines_added !== undefined) {
-      console.log(
-        chalk.gray(
-          `   Breakdown: +${currentStats.lines_added} added, -${currentStats.lines_removed} removed`
-        )
-      );
-    }
-
-    const filePercent = Math.round(
-      (currentStats.files_changed / derivedBudget.effective.max_files) * 100
-    );
-    const locPercent = Math.round(
-      (currentStats.lines_changed / derivedBudget.effective.max_loc) * 100
-    );
-
-    if (filePercent > 90 || locPercent > 90) {
-      console.log(chalk.yellow('\nWARNING: Approaching budget limits'));
-    } else {
-      console.log(chalk.green('\nWithin budget limits'));
-    }
-  } catch (error) {
-    console.error(chalk.red('Error generating burn-up report:'), error.message);
-    process.exit(1);
-  }
-}
-
-module.exports = {
-  burnupCommand,
-};