codesummary 1.0.0

package/src/cli.js

@@ -0,0 +1,392 @@
+import inquirer from 'inquirer';
+import chalk from 'chalk';
+import path from 'path';
+import fs from 'fs-extra';
+import ora from 'ora';
+
+import ConfigManager from './configManager.js';
+import Scanner from './scanner.js';
+import PDFGenerator from './pdfGenerator.js';
+import ErrorHandler from './errorHandler.js';
+
+/**
+ * Command Line Interface for CodeSummary
+ * Handles user interaction and orchestrates the scanning and PDF generation process
+ */
+export class CLI {
+  constructor() {
+    this.configManager = new ConfigManager();
+    this.config = null;
+    this.scanner = null;
+    this.pdfGenerator = null;
+  }
+
+  /**
+   * Main entry point for CLI execution
+   * @param {Array} args - Command line arguments
+   */
+  async run(args = []) {
+    try {
+      // Parse command line arguments
+      const options = this.parseArguments(args);
+      
+      // Handle special commands
+      if (options.showConfig) {
+        await this.showConfig();
+        return;
+      }
+
+      if (options.resetConfig) {
+        await this.resetConfig();
+        return;
+      }
+
+      if (options.config) {
+        await this.editConfig();
+        return;
+      }
+
+      // Main scanning and PDF generation flow
+      await this.executeMainFlow(options);
+
+    } catch (error) {
+      ErrorHandler.handleError(error, 'CLI Operation');
+    }
+  }
+
+  /**
+   * Parse command line arguments
+   * @param {Array} args - Raw arguments
+   * @returns {object} Parsed options
+   */
+  parseArguments(args) {
+    const options = {
+      output: null,
+      showConfig: false,
+      resetConfig: false,
+      config: false,
+      help: false,
+      noInteractive: false
+    };
+
+    for (let i = 0; i < args.length; i++) {
+      const arg = args[i];
+
+      switch (arg) {
+        case '--output':
+        case '-o':
+          options.output = args[++i];
+          break;
+        case '--show-config':
+          options.showConfig = true;
+          break;
+        case '--reset-config':
+          options.resetConfig = true;
+          break;
+        case 'config':
+          options.config = true;
+          break;
+        case '--help':
+        case '-h':
+          options.help = true;
+          break;
+        case '--no-interactive':
+          options.noInteractive = true;
+          break;
+        default:
+          if (arg.startsWith('-')) {
+            throw new Error(`Unknown option: ${arg}`);
+          }
+      }
+    }
+
+    if (options.help) {
+      this.showHelp();
+      process.exit(0);
+    }
+
+    return options;
+  }
+
+  /**
+   * Execute the main scanning and PDF generation flow
+   * @param {object} options - Parsed command line options
+   */
+  async executeMainFlow(options) {
+    // Load or create configuration
+    this.config = await this.loadConfiguration();
+    
+    // Initialize components
+    this.scanner = new Scanner(this.config);
+    this.pdfGenerator = new PDFGenerator(this.config);
+
+    // Determine scan path (default: current working directory)
+    const scanPath = process.cwd();
+    const projectName = path.basename(scanPath);
+
+    console.log(chalk.cyan(`CodeSummary - Scanning project: ${chalk.bold(projectName)}\n`));
+
+    // Scan directory
+    const spinner = ora('Scanning directory structure...').start();
+    const filesByExtension = await this.scanner.scanDirectory(scanPath);
+    spinner.succeed('Directory scan completed');
+
+    // Check if any supported files were found
+    if (Object.keys(filesByExtension).length === 0) {
+      console.log(chalk.red('ERROR: No supported files found. Nothing to document.'));
+      process.exit(1);
+    }
+
+    // Display scan summary
+    this.scanner.displayScanSummary(filesByExtension);
+
+    // Let user select extensions to include
+    const selectedExtensions = await this.selectExtensions(filesByExtension);
+
+    if (selectedExtensions.length === 0) {
+      console.log(chalk.yellow('WARNING: No extensions selected. Exiting.'));
+      process.exit(0);
+    }
+
+    // Check file count threshold
+    const totalFiles = this.calculateTotalFiles(filesByExtension, selectedExtensions);
+    await this.checkFileCountThreshold(totalFiles);
+
+    // Determine output path
+    const outputPath = this.determineOutputPath(options.output, projectName);
+    
+    // Ensure output directory exists
+    await PDFGenerator.ensureOutputDirectory(path.dirname(outputPath));
+
+    // Generate PDF
+    const generationSpinner = ora('Generating PDF document...').start();
+    const result = await this.pdfGenerator.generatePDF(
+      filesByExtension,
+      selectedExtensions,
+      outputPath,
+      projectName
+    );
+    generationSpinner.succeed('PDF generation completed');
+
+    // Display success summary
+    await this.displayCompletionSummary(result.outputPath, selectedExtensions, totalFiles, result.pageCount);
+  }
+
+  /**
+   * Load configuration (with first-run setup if needed)
+   * @returns {object} Configuration object
+   */
+  async loadConfiguration() {
+    let config = await this.configManager.loadConfig();
+
+    if (!config) {
+      // First run - trigger setup wizard
+      config = await this.configManager.runFirstTimeSetup();
+    } else {
+      console.log(chalk.gray(`Using configuration from ${this.configManager.configPath}`));
+    }
+
+    return config;
+  }
+
+  /**
+   * Let user select which extensions to include
+   * @param {object} filesByExtension - Available files by extension
+   * @returns {Array} Selected extensions
+   */
+  async selectExtensions(filesByExtension) {
+    const extensionInfo = this.scanner.getExtensionInfo(filesByExtension);
+    
+    const choices = extensionInfo.map(info => ({
+      name: `${info.extension} → ${info.description} (${info.count} files)`,
+      value: info.extension,
+      checked: true // Pre-select all detected extensions
+    }));
+
+    const { selectedExtensions } = await inquirer.prompt([{
+      type: 'checkbox',
+      name: 'selectedExtensions',
+      message: 'Select file extensions to include:',
+      choices,
+      validate: (answer) => {
+        if (answer.length === 0) {
+          return 'You must select at least one extension.';
+        }
+        return true;
+      }
+    }]);
+
+    return selectedExtensions;
+  }
+
+  /**
+   * Calculate total files for selected extensions
+   * @param {object} filesByExtension - Files by extension
+   * @param {Array} selectedExtensions - Selected extensions
+   * @returns {number} Total file count
+   */
+  calculateTotalFiles(filesByExtension, selectedExtensions) {
+    return selectedExtensions.reduce((total, ext) => {
+      return total + (filesByExtension[ext]?.length || 0);
+    }, 0);
+  }
+
+  /**
+   * Check if file count exceeds threshold and prompt user
+   * @param {number} totalFiles - Total file count
+   */
+  async checkFileCountThreshold(totalFiles) {
+    if (totalFiles > this.config.settings.maxFilesBeforePrompt) {
+      console.log(chalk.yellow(`WARNING: Found ${totalFiles} files. Generating the PDF may take a while.`));
+      
+      const { shouldContinue } = await inquirer.prompt([{
+        type: 'confirm',
+        name: 'shouldContinue',
+        message: 'Do you want to continue?',
+        default: true
+      }]);
+
+      if (!shouldContinue) {
+        console.log(chalk.gray('Operation cancelled by user.'));
+        process.exit(0);
+      }
+    }
+  }
+
+  /**
+   * Determine final output path for PDF
+   * @param {string} overridePath - Optional override path from CLI
+   * @param {string} projectName - Project name
+   * @returns {string} Final output path
+   */
+  determineOutputPath(overridePath, projectName) {
+    let outputDir;
+
+    if (overridePath) {
+      // Validate and sanitize override path from CLI
+      const sanitizedPath = ErrorHandler.sanitizeInput(overridePath);
+      ErrorHandler.validatePath(sanitizedPath, { preventTraversal: true });
+      
+      outputDir = path.resolve(sanitizedPath);
+      console.log(chalk.gray(`PDF will be saved to: ${outputDir}`));
+    } else {
+      // Use config settings
+      if (this.config.output.mode === 'relative') {
+        outputDir = process.cwd();
+      } else {
+        outputDir = path.resolve(this.config.output.fixedPath);
+      }
+    }
+
+    // Sanitize project name for filename
+    const sanitizedProjectName = ErrorHandler.sanitizeInput(projectName);
+    
+    return PDFGenerator.generateOutputPath(sanitizedProjectName, outputDir);
+  }
+
+  /**
+   * Display completion summary
+   * @param {string} outputPath - Generated PDF path
+   * @param {Array} selectedExtensions - Selected extensions
+   * @param {number} totalFiles - Total files processed
+   * @param {number|string} pageCount - Number of pages in PDF or 'N/A'
+   */
+  async displayCompletionSummary(outputPath, selectedExtensions, totalFiles, pageCount) {
+    // Get PDF stats
+    const stats = await fs.stat(outputPath);
+    const fileSizeFormatted = this.formatFileSize(stats.size);
+
+    console.log(chalk.green('\nSUCCESS: PDF generation completed successfully!\n'));
+    console.log(chalk.cyan('Summary:'));
+    console.log(chalk.gray(`   Output: ${outputPath}`));
+    console.log(chalk.gray(`   Extensions: ${selectedExtensions.join(', ')}`));
+    console.log(chalk.gray(`   Total files: ${totalFiles}`));
+    if (pageCount !== 'N/A') {
+      console.log(chalk.gray(`   Total pages: ${pageCount}`));
+    }
+    console.log(chalk.gray(`   PDF size: ${fileSizeFormatted}`));
+    console.log();
+  }
+
+  /**
+   * Show current configuration
+   */
+  async showConfig() {
+    const config = await this.configManager.loadConfig();
+    if (config) {
+      this.configManager.displayConfig(config);
+    } else {
+      console.log(chalk.yellow('WARNING: No configuration found. Run codesummary to set up.'));
+    }
+  }
+
+  /**
+   * Reset configuration
+   */
+  async resetConfig() {
+    await this.configManager.resetConfig();
+    console.log(chalk.green('SUCCESS: Configuration reset. Run codesummary to set up again.'));
+  }
+
+  /**
+   * Edit configuration interactively
+   */
+  async editConfig() {
+    let config = await this.configManager.loadConfig();
+    
+    if (!config) {
+      console.log(chalk.yellow('WARNING: No configuration found. Running first-time setup...'));
+      config = await this.configManager.runFirstTimeSetup();
+    } else {
+      config = await this.configManager.editConfig(config);
+    }
+  }
+
+  /**
+   * Format file size in human readable format
+   * @param {number} bytes - Size in bytes
+   * @returns {string} Formatted size
+   */
+  formatFileSize(bytes) {
+    const units = ['B', 'KB', 'MB', 'GB'];
+    let size = bytes;
+    let unitIndex = 0;
+
+    while (size >= 1024 && unitIndex < units.length - 1) {
+      size /= 1024;
+      unitIndex++;
+    }
+
+    return `${size.toFixed(1)} ${units[unitIndex]}`;
+  }
+
+  /**
+   * Show help information
+   */
+  showHelp() {
+    console.log(chalk.cyan('\nCodeSummary - Generate PDF documentation from source code\n'));
+    
+    console.log(chalk.white('Usage:'));
+    console.log('  codesummary [options]                 Scan current directory and generate PDF');
+    console.log('  codesummary config                    Edit configuration settings');
+    console.log();
+    
+    console.log(chalk.white('Options:'));
+    console.log('  -o, --output <path>                   Override output directory');
+    console.log('  --show-config                         Display current configuration');
+    console.log('  --reset-config                        Reset configuration to defaults');
+    console.log('  -h, --help                            Show this help message');
+    console.log();
+    
+    console.log(chalk.white('Examples:'));
+    console.log('  codesummary                           Scan current project');
+    console.log('  codesummary --output ./docs           Save PDF to ./docs folder');
+    console.log('  codesummary config                    Edit settings');
+    console.log('  codesummary --show-config             View current settings');
+    console.log();
+    
+    console.log(chalk.gray('For more information, visit: https://github.com/skamoll/CodeSummary'));
+  }
+}
+
+export default CLI;