api-scout/src/cli/generate.js

🔍 Automatically scout, discover and generate beautiful interactive API documentation from your codebase. Supports Express.js, NestJS, FastAPI, Spring Boot with interactive testing and security analysis.

const chalk = require('chalk');
const ora = require('ora');
const APIDocsGenerator = require('../index');

module.exports = async function generateCommand(options) {
  const spinner = ora('🔍 Initializing API Scout...').start();
  
  try {
    const generator = new APIDocsGenerator(options);
    
    spinner.text = '🕵️ Scouting codebase for API endpoints...';
    const result = await generator.generate();
    
    spinner.succeed(chalk.green('✅ API documentation generated successfully!'));
    
    console.log(chalk.cyan('\n📊 Scout Report:'));
    console.log(`  • ${result.endpoints.length} API endpoints discovered`);
    console.log(`  • ${result.frameworks.length} framework(s) detected: ${result.frameworks.join(', ')}`);
    console.log(`  • Output directory: ${chalk.yellow(options.output)}`);
    
    if (result.security && result.security.recommendations?.length > 0) {
      const criticalIssues = result.security.recommendations.filter(r => r.priority === 'critical').length;
      const highIssues = result.security.recommendations.filter(r => r.priority === 'high').length;
      
      console.log(chalk.cyan('\n🔐 Security Analysis:'));
      if (criticalIssues > 0) {
        console.log(`  • ${chalk.red(criticalIssues + ' critical security issue(s) found')}`);
      }
      if (highIssues > 0) {
        console.log(`  • ${chalk.yellow(highIssues + ' high priority recommendation(s)')}`);
      }
      if (criticalIssues === 0 && highIssues === 0) {
        console.log(`  • ${chalk.green('No critical security issues detected')}`);
      }
    }
    
    console.log(chalk.cyan('\n🚀 Next steps:'));
    console.log(`  • Serve docs: ${chalk.yellow('api-scout serve')}`);
    console.log(`  • Watch mode: ${chalk.yellow('api-scout watch')}`);
    console.log(`  • Interactive testing: Open docs and click ${chalk.yellow('"🧪 Test API"')} buttons`);
    
  } catch (error) {
    spinner.fail(chalk.red('❌ Failed to generate documentation'));
    console.error(chalk.red('\nError details:'));
    console.error(error.message);
    
    if (error.stack && process.env.DEBUG) {
      console.error(chalk.gray('\nStack trace:'));
      console.error(error.stack);
    }
    
    process.exit(1);
  }
};