@vibecheckai/cli 3.5.0 → 3.5.2

package/bin/runners/lib/cli-help-formatter.js

@@ -1,439 +0,0 @@
-/**
- * CLI Help Formatter - Consistent, beautiful help output for all Vibecheck commands
- * 
- * Provides standardized help formatting including:
- * - Command usage and aliases
- * - Categorized options with tier badges
- * - Examples with syntax highlighting
- * - Exit codes documentation
- * - Links to documentation
- */
-
-"use strict";
-
-const {
-  ansi,
-  sym,
-  box,
-  TIER_LABELS,
-  padRight,
-  visibleLength,
-} = require("./unified-cli-output");
-
-// ═══════════════════════════════════════════════════════════════════════════════
-// CONFIGURATION
-// ═══════════════════════════════════════════════════════════════════════════════
-
-const HELP_WIDTH = 72;
-const OPTION_INDENT = 4;
-const DESC_INDENT = 22;
-
-// ═══════════════════════════════════════════════════════════════════════════════
-// HELP BUILDER CLASS
-// ═══════════════════════════════════════════════════════════════════════════════
-
-class HelpBuilder {
-  constructor(command) {
-    this.command = command;
-    this.sections = [];
-  }
-
-  usage(usage, aliases) {
-    this.usageText = usage;
-    this.aliasesText = aliases;
-    return this;
-  }
-
-  description(desc) {
-    this.descriptionText = desc;
-    return this;
-  }
-
-  section(title, items) {
-    this.sections.push({ title, items });
-    return this;
-  }
-
-  options(items) {
-    return this.section('OPTIONS', items);
-  }
-
-  examples(items) {
-    return this.section('EXAMPLES', items.map(ex => ({
-      name: ex.comment || '',
-      description: ex.command,
-      isExample: true,
-    })));
-  }
-
-  exitCodes(codes) {
-    return this.section('EXIT CODES', codes.map(c => ({
-      name: String(c.code),
-      description: c.description,
-      isExitCode: true,
-      color: c.color,
-    })));
-  }
-
-  footer(text) {
-    this.footerText = text;
-    return this;
-  }
-
-  docLink(url) {
-    this.docUrl = url;
-    return this;
-  }
-
-  build() {
-    const lines = [];
-    
-    // Usage
-    lines.push('');
-    lines.push(`  ${ansi.bold}USAGE${ansi.reset}`);
-    lines.push(`    ${ansi.cyan}${this.usageText}${ansi.reset}`);
-    
-    if (this.aliasesText) {
-      lines.push(`  ${ansi.dim}Aliases: ${this.aliasesText}${ansi.reset}`);
-    }
-    
-    // Description
-    if (this.descriptionText) {
-      lines.push('');
-      // Word wrap description
-      const words = this.descriptionText.split(' ');
-      let currentLine = '  ';
-      for (const word of words) {
-        if (currentLine.length + word.length + 1 > HELP_WIDTH) {
-          lines.push(currentLine);
-          currentLine = '  ' + word;
-        } else {
-          currentLine += (currentLine === '  ' ? '' : ' ') + word;
-        }
-      }
-      if (currentLine !== '  ') lines.push(currentLine);
-    }
-    
-    // Sections
-    for (const section of this.sections) {
-      lines.push('');
-      lines.push(`  ${ansi.bold}${section.title}${ansi.reset}`);
-      
-      for (const item of section.items) {
-        if (item.isExample) {
-          // Example formatting
-          if (item.name) {
-            lines.push(`    ${ansi.dim}# ${item.name}${ansi.reset}`);
-          }
-          lines.push(`    ${ansi.cyan}${item.description}${ansi.reset}`);
-        } else if (item.isExitCode) {
-          // Exit code formatting
-          const color = item.color || ansi.reset;
-          lines.push(`    ${color}${item.name}${ansi.reset}  ${item.description}`);
-        } else {
-          // Option formatting
-          const tierBadge = item.tier && item.tier !== 'free' 
-            ? ` ${ansi.dim}[${TIER_LABELS[item.tier]}]${ansi.reset}` 
-            : '';
-          const nameStr = `${ansi.cyan}${item.name}${ansi.reset}`;
-          const paddedName = padRight(item.name, DESC_INDENT - OPTION_INDENT);
-          lines.push(`    ${ansi.cyan}${paddedName}${ansi.reset}${item.description}${tierBadge}`);
-        }
-      }
-    }
-    
-    // Footer
-    if (this.footerText) {
-      lines.push('');
-      lines.push(`  ${this.footerText}`);
-    }
-    
-    // Documentation link
-    if (this.docUrl) {
-      lines.push('');
-      lines.push(`  ${ansi.dim}${box.horizontal.repeat(HELP_WIDTH - 4)}${ansi.reset}`);
-      lines.push(`  ${ansi.dim}Documentation: ${this.docUrl}${ansi.reset}`);
-    }
-    
-    lines.push('');
-    
-    return lines.join('\n');
-  }
-}
-
-// ═══════════════════════════════════════════════════════════════════════════════
-// PREDEFINED HELP TEMPLATES
-// ═══════════════════════════════════════════════════════════════════════════════
-
-const helpTemplates = {
-  scan: new HelpBuilder('scan')
-    .usage('vibecheck scan [path] [options]', 's, check')
-    .description('The core analysis engine. Scans your codebase for route integrity issues, security vulnerabilities, code quality problems, and mock data detection.')
-    .section('SCAN LAYERS', [
-      { name: '(default)', description: 'Layer 1: AST static analysis (fast, ~2s)' },
-      { name: '--truth, -t', description: 'Layer 1+2: + build manifest verification' },
-      { name: '--reality, -r', description: 'Layer 1+2+3: + Playwright runtime proof', tier: 'pro' },
-    ])
-    .options([
-      { name: '--path, -p <path>', description: 'Project path (default: current directory)' },
-      { name: '--json', description: 'Output JSON report only (CI integration)' },
-      { name: '--sarif', description: 'Output SARIF format for code scanning' },
-      { name: '--autofix, -f', description: 'Generate fix missions for issues', tier: 'pro' },
-      { name: '--baseline', description: 'Compare against previous scan baseline' },
-      { name: '--quiet, -q', description: 'Suppress non-essential output' },
-      { name: '--verbose, -v', description: 'Show detailed output' },
-    ])
-    .examples([
-      { comment: 'Quick scan', command: 'vibecheck scan' },
-      { comment: 'With truth verification', command: 'vibecheck scan --truth' },
-      { comment: 'CI pipeline (JSON)', command: 'vibecheck scan --json' },
-      { comment: 'Specific directory', command: 'vibecheck scan ./src' },
-    ])
-    .exitCodes([
-      { code: 0, description: 'SHIP - Ready to deploy', color: ansi.green },
-      { code: 1, description: 'WARN - Review recommended', color: ansi.yellow },
-      { code: 2, description: 'BLOCK - Critical issues found', color: ansi.red },
-    ])
-    .docLink('https://docs.vibecheckai.dev/cli/scan')
-    .build(),
-
-  ship: new HelpBuilder('ship')
-    .usage('vibecheck ship [path] [options]', 'go, deploy')
-    .description('The one command to ship with confidence. Runs comprehensive checks and gives you a clear SHIP/WARN/BLOCK verdict with actionable insights.')
-    .options([
-      { name: '--path, -p <path>', description: 'Project path (default: current directory)' },
-      { name: '--json', description: 'Output JSON report only' },
-      { name: '--badge', description: 'Generate embeddable badge', tier: 'pro' },
-      { name: '--quiet, -q', description: 'Suppress non-essential output' },
-      { name: '--strict', description: 'Fail on warnings (default: fail on blocks only)' },
-    ])
-    .examples([
-      { comment: 'Ship check', command: 'vibecheck ship' },
-      { comment: 'Generate badge', command: 'vibecheck ship --badge' },
-      { comment: 'CI pipeline', command: 'vibecheck ship --json --strict' },
-    ])
-    .exitCodes([
-      { code: 0, description: 'SHIP - All checks passed', color: ansi.green },
-      { code: 1, description: 'WARN - Minor issues found', color: ansi.yellow },
-      { code: 2, description: 'BLOCK - Cannot ship', color: ansi.red },
-    ])
-    .docLink('https://docs.vibecheckai.dev/cli/ship')
-    .build(),
-
-  fix: new HelpBuilder('fix')
-    .usage('vibecheck fix [options]', 'repair, autofix')
-    .description('Generate AI-powered fix missions for detected issues. Creates surgical prompts that guide AI assistants to fix problems without introducing new ones.')
-    .section('FIX MODES', [
-      { name: '--plan', description: 'Show fix plan only, no changes (default for free)' },
-      { name: '--apply', description: 'Apply fixes automatically', tier: 'pro' },
-      { name: '--interactive', description: 'Review each fix before applying', tier: 'pro' },
-    ])
-    .options([
-      { name: '--path, -p <path>', description: 'Project path' },
-      { name: '--max <n>', description: 'Maximum fixes to generate (default: 5)' },
-      { name: '--dry-run', description: 'Show what would be changed' },
-      { name: '--backup', description: 'Create backup before applying fixes' },
-      { name: '--json', description: 'Output fix plan as JSON' },
-    ])
-    .examples([
-      { comment: 'Show fix plan', command: 'vibecheck fix --plan' },
-      { comment: 'Apply fixes with backup', command: 'vibecheck fix --apply --backup' },
-      { comment: 'Interactive mode', command: 'vibecheck fix --interactive' },
-    ])
-    .docLink('https://docs.vibecheckai.dev/cli/fix')
-    .build(),
-
-  doctor: new HelpBuilder('doctor')
-    .usage('vibecheck doctor [options]', 'health, diag')
-    .description('Comprehensive environment diagnostics with auto-fix capability. Checks Node.js, dependencies, configuration, security, and network connectivity.')
-    .section('CATEGORIES', [
-      { name: 'system', description: 'OS, memory, disk, CPU' },
-      { name: 'runtime', description: 'Node.js, npm, package managers' },
-      { name: 'project', description: 'package.json, dependencies, TypeScript' },
-      { name: 'security', description: 'Secrets, gitignore, env files' },
-      { name: 'network', description: 'Internet, npm registry, API' },
-      { name: 'vibecheck', description: 'Config, truth pack, scan status' },
-    ])
-    .options([
-      { name: '--fix', description: 'Auto-fix issues when possible' },
-      { name: '--dry-run', description: 'Show what fixes would be applied' },
-      { name: '--category, -c <cat>', description: 'Run specific category only' },
-      { name: '--skip-network', description: 'Skip slow network checks' },
-      { name: '--json', description: 'Output as JSON' },
-    ])
-    .examples([
-      { comment: 'Full diagnostic', command: 'vibecheck doctor' },
-      { comment: 'Auto-fix issues', command: 'vibecheck doctor --fix' },
-      { comment: 'Security checks only', command: 'vibecheck doctor -c security' },
-    ])
-    .exitCodes([
-      { code: 0, description: 'Healthy (or warnings without --fail-on-warn)', color: ansi.green },
-      { code: 1, description: 'Errors found', color: ansi.red },
-      { code: 2, description: 'Warnings found (with --fail-on-warn)', color: ansi.yellow },
-    ])
-    .docLink('https://docs.vibecheckai.dev/cli/doctor')
-    .build(),
-
-  init: new HelpBuilder('init')
-    .usage('vibecheck init [options]', 'setup, configure')
-    .description('Initialize Vibecheck in your project. Detects your framework, creates configuration files, and sets up CI integration.')
-    .section('SETUP MODES', [
-      { name: '--quick', description: 'Quick setup with defaults' },
-      { name: '--wizard', description: 'Interactive setup wizard (default)' },
-      { name: '--ci', description: 'Generate CI workflow only' },
-    ])
-    .options([
-      { name: '--template <name>', description: 'Use preset template (nextjs, express, etc.)' },
-      { name: '--hooks', description: 'Install git pre-commit hooks' },
-      { name: '--force', description: 'Overwrite existing config' },
-      { name: '--json', description: 'Output as JSON' },
-    ])
-    .examples([
-      { comment: 'Interactive setup', command: 'vibecheck init' },
-      { comment: 'Quick setup', command: 'vibecheck init --quick' },
-      { comment: 'Next.js template', command: 'vibecheck init --template nextjs' },
-      { comment: 'With git hooks', command: 'vibecheck init --hooks' },
-    ])
-    .docLink('https://docs.vibecheckai.dev/cli/init')
-    .build(),
-
-  guard: new HelpBuilder('guard')
-    .usage('vibecheck guard [options]', 'ai-guard, firewall, validate')
-    .description('Validate AI-generated code and prompts. Detects prompt injection, verifies claims against your codebase, and ensures AI outputs meet standards.')
-    .section('CHECK MODES', [
-      { name: '--claims', description: 'Verify AI claims against truthpack' },
-      { name: '--prompts', description: 'Check code for prompt injection' },
-      { name: '--hallucinations', description: 'Detect AI hallucination patterns' },
-    ])
-    .options([
-      { name: '--file <path>', description: 'Check specific file(s)' },
-      { name: '--strict', description: 'Fail on warnings' },
-      { name: '--json', description: 'Output as JSON' },
-    ])
-    .examples([
-      { comment: 'Run all checks', command: 'vibecheck guard' },
-      { comment: 'Verify claims in file', command: 'vibecheck guard --claims --file api.ts' },
-      { comment: 'CI pipeline', command: 'vibecheck guard --strict --json' },
-    ])
-    .exitCodes([
-      { code: 0, description: 'All checks passed', color: ansi.green },
-      { code: 1, description: 'Warnings found', color: ansi.yellow },
-      { code: 2, description: 'Errors found (blocking)', color: ansi.red },
-    ])
-    .docLink('https://docs.vibecheckai.dev/cli/guard')
-    .build(),
-
-  context: new HelpBuilder('context')
-    .usage('vibecheck context [options]', 'rules, ai-rules, mdc')
-    .description('Generate project-aware AI coding rules for your IDE. These rules help AI assistants understand your codebase conventions.')
-    .section('FORMATS', [
-      { name: 'cursor', description: '.cursorrules file for Cursor IDE' },
-      { name: 'mdc', description: 'MDC format (.cursor/rules/*.mdc)' },
-      { name: 'windsurf', description: 'Windsurf rules directory' },
-      { name: 'copilot', description: 'GitHub Copilot instructions' },
-      { name: 'all', description: 'Generate all formats (default)' },
-    ])
-    .options([
-      { name: '-f, --format <fmt>', description: 'Format to generate' },
-      { name: '-o, --output <dir>', description: 'Output directory' },
-      { name: '--json', description: 'Output as JSON' },
-    ])
-    .examples([
-      { comment: 'Generate all rules', command: 'vibecheck context' },
-      { comment: 'Cursor only', command: 'vibecheck context --format cursor' },
-      { comment: 'Custom output', command: 'vibecheck context --output ./ai-rules' },
-    ])
-    .docLink('https://docs.vibecheckai.dev/cli/context')
-    .build(),
-
-  login: new HelpBuilder('login')
-    .usage('vibecheck login [options]', 'auth, signin')
-    .description('Authenticate with your Vibecheck API key to unlock paid features and sync with the dashboard.')
-    .options([
-      { name: '--key <key>', description: 'Provide API key directly (non-interactive)' },
-      { name: '--json', description: 'Output as JSON' },
-    ])
-    .examples([
-      { comment: 'Interactive login', command: 'vibecheck login' },
-      { comment: 'Non-interactive', command: 'vibecheck login --key YOUR_API_KEY' },
-      { comment: 'Environment variable', command: 'VIBECHECK_API_KEY=xxx vibecheck whoami' },
-    ])
-    .footer(`Get your API key at: ${ansi.cyan}https://vibecheckai.dev/settings/keys${ansi.reset}`)
-    .docLink('https://docs.vibecheckai.dev/authentication')
-    .build(),
-
-  whoami: new HelpBuilder('whoami')
-    .usage('vibecheck whoami [options]', 'me, user')
-    .description('Display information about the currently authenticated user, including plan, limits, and available scopes.')
-    .options([
-      { name: '--json', description: 'Output as JSON' },
-      { name: '--quiet, -q', description: 'Suppress non-essential output' },
-    ])
-    .examples([
-      { comment: 'Check current user', command: 'vibecheck whoami' },
-      { comment: 'JSON for scripts', command: 'vibecheck whoami --json' },
-    ])
-    .docLink('https://docs.vibecheckai.dev/authentication')
-    .build(),
-};
-
-// ═══════════════════════════════════════════════════════════════════════════════
-// MAIN HELP OUTPUT
-// ═══════════════════════════════════════════════════════════════════════════════
-
-function renderMainHelp() {
-  return `
-  ${ansi.bold}${ansi.cyan}VIBECHECK${ansi.reset} ${ansi.dim}v${process.env.npm_package_version || '2.0.0'}${ansi.reset}
-  ${ansi.dim}AI-powered code verification for production readiness${ansi.reset}
-
-  ${ansi.bold}USAGE${ansi.reset}
-    ${ansi.cyan}vibecheck${ansi.reset} <command> [options]
-
-  ${ansi.bold}CORE COMMANDS${ansi.reset}
-    ${ansi.cyan}scan${ansi.reset}      ${ansi.dim}s${ansi.reset}        Analyze codebase for issues
-    ${ansi.cyan}ship${ansi.reset}      ${ansi.dim}go${ansi.reset}       One command to ship with confidence
-    ${ansi.cyan}fix${ansi.reset}       ${ansi.dim}repair${ansi.reset}   AI-powered fix missions
-    ${ansi.cyan}doctor${ansi.reset}    ${ansi.dim}health${ansi.reset}   Environment diagnostics
-
-  ${ansi.bold}AI TOOLS${ansi.reset}
-    ${ansi.cyan}guard${ansi.reset}     ${ansi.dim}firewall${ansi.reset} Validate AI-generated code
-    ${ansi.cyan}context${ansi.reset}   ${ansi.dim}rules${ansi.reset}    Generate AI coding rules
-    ${ansi.cyan}truth${ansi.reset}     ${ansi.dim}verify${ansi.reset}   Build verification manifest
-
-  ${ansi.bold}SETUP${ansi.reset}
-    ${ansi.cyan}init${ansi.reset}      ${ansi.dim}setup${ansi.reset}    Initialize project
-    ${ansi.cyan}login${ansi.reset}     ${ansi.dim}auth${ansi.reset}     Authenticate with API key
-    ${ansi.cyan}whoami${ansi.reset}    ${ansi.dim}me${ansi.reset}       Show current user
-
-  ${ansi.bold}OPTIONS${ansi.reset}
-    ${ansi.cyan}--help, -h${ansi.reset}           Show help for command
-    ${ansi.cyan}--version, -V${ansi.reset}        Show version
-    ${ansi.cyan}--json${ansi.reset}               Output as JSON
-    ${ansi.cyan}--quiet, -q${ansi.reset}          Suppress non-essential output
-    ${ansi.cyan}--no-banner${ansi.reset}          Skip banner display
-
-  ${ansi.bold}EXAMPLES${ansi.reset}
-    ${ansi.dim}# Quick scan${ansi.reset}
-    ${ansi.cyan}vibecheck scan${ansi.reset}
-
-    ${ansi.dim}# Ship check with badge${ansi.reset}
-    ${ansi.cyan}vibecheck ship --badge${ansi.reset}
-
-    ${ansi.dim}# CI pipeline${ansi.reset}
-    ${ansi.cyan}vibecheck scan --json --strict${ansi.reset}
-
-  ${ansi.dim}${box.horizontal.repeat(68)}${ansi.reset}
-  ${ansi.dim}Documentation: https://docs.vibecheckai.dev${ansi.reset}
-  ${ansi.dim}Get help: vibecheck <command> --help${ansi.reset}
-`;
-}
-
-// ═══════════════════════════════════════════════════════════════════════════════
-// EXPORTS
-// ═══════════════════════════════════════════════════════════════════════════════
-
-module.exports = {
-  HelpBuilder,
-  helpTemplates,
-  renderMainHelp,
-};