bmad-method 5.1.2 → 6.0.0-alpha.0

package/tools/cli/lib/cli-utils.js

@@ -0,0 +1,208 @@
+const chalk = require('chalk');
+const boxen = require('boxen');
+const wrapAnsi = require('wrap-ansi');
+const figlet = require('figlet');
+
+const CLIUtils = {
+  /**
+   * Display BMAD logo
+   */
+  displayLogo() {
+    console.clear();
+
+    // ASCII art logo
+    const logo = `
+    ██████╗ ███╗   ███╗ █████╗ ██████╗ ™
+    ██╔══██╗████╗ ████║██╔══██╗██╔══██╗
+    ██████╔╝██╔████╔██║███████║██║  ██║
+    ██╔══██╗██║╚██╔╝██║██╔══██║██║  ██║
+    ██████╔╝██║ ╚═╝ ██║██║  ██║██████╔╝
+    ╚═════╝ ╚═╝     ╚═╝╚═╝  ╚═╝╚═════╝`;
+
+    console.log(chalk.cyan(logo));
+    console.log(chalk.dim('    Build More, Architect Dreams\n'));
+  },
+
+  /**
+   * Display section header
+   * @param {string} title - Section title
+   * @param {string} subtitle - Optional subtitle
+   */
+  displaySection(title, subtitle = null) {
+    console.log('\n' + chalk.cyan('═'.repeat(80)));
+    console.log(chalk.cyan.bold(` ${title}`));
+    if (subtitle) {
+      console.log(chalk.dim(` ${subtitle}`));
+    }
+    console.log(chalk.cyan('═'.repeat(80)) + '\n');
+  },
+
+  /**
+   * Display info box
+   * @param {string|Array} content - Content to display
+   * @param {Object} options - Box options
+   */
+  displayBox(content, options = {}) {
+    const defaultOptions = {
+      padding: 1,
+      margin: 1,
+      borderStyle: 'round',
+      borderColor: 'cyan',
+      ...options,
+    };
+
+    // Handle array content
+    let text = content;
+    if (Array.isArray(content)) {
+      text = content.join('\n\n');
+    }
+
+    // Wrap text to prevent overflow
+    const wrapped = wrapAnsi(text, 76, { hard: true, wordWrap: true });
+
+    console.log(boxen(wrapped, defaultOptions));
+  },
+
+  /**
+   * Display prompt section
+   * @param {string|Array} prompts - Prompts to display
+   */
+  displayPromptSection(prompts) {
+    const promptArray = Array.isArray(prompts) ? prompts : [prompts];
+
+    const formattedPrompts = promptArray.map((p) => wrapAnsi(p, 76, { hard: true, wordWrap: true }));
+
+    this.displayBox(formattedPrompts, {
+      borderColor: 'yellow',
+      borderStyle: 'double',
+    });
+  },
+
+  /**
+   * Display step indicator
+   * @param {number} current - Current step
+   * @param {number} total - Total steps
+   * @param {string} description - Step description
+   */
+  displayStep(current, total, description) {
+    const progress = `[${current}/${total}]`;
+    console.log('\n' + chalk.cyan(progress) + ' ' + chalk.bold(description));
+    console.log(chalk.dim('─'.repeat(80 - progress.length - 1)) + '\n');
+  },
+
+  /**
+   * Display completion message
+   * @param {string} message - Completion message
+   */
+  displayComplete(message) {
+    console.log(
+      '\n' +
+        boxen(chalk.green('✨ ' + message), {
+          padding: 1,
+          margin: 1,
+          borderStyle: 'round',
+          borderColor: 'green',
+        }),
+    );
+  },
+
+  /**
+   * Display error message
+   * @param {string} message - Error message
+   */
+  displayError(message) {
+    console.log(
+      '\n' +
+        boxen(chalk.red('✗ ' + message), {
+          padding: 1,
+          margin: 1,
+          borderStyle: 'round',
+          borderColor: 'red',
+        }),
+    );
+  },
+
+  /**
+   * Format list for display
+   * @param {Array} items - Items to display
+   * @param {string} prefix - Item prefix
+   */
+  formatList(items, prefix = '•') {
+    return items.map((item) => `  ${prefix} ${item}`).join('\n');
+  },
+
+  /**
+   * Clear previous lines
+   * @param {number} lines - Number of lines to clear
+   */
+  clearLines(lines) {
+    for (let i = 0; i < lines; i++) {
+      process.stdout.moveCursor(0, -1);
+      process.stdout.clearLine(1);
+    }
+  },
+
+  /**
+   * Display table
+   * @param {Array} data - Table data
+   * @param {Object} options - Table options
+   */
+  displayTable(data, options = {}) {
+    const Table = require('cli-table3');
+    const table = new Table({
+      style: {
+        head: ['cyan'],
+        border: ['dim'],
+      },
+      ...options,
+    });
+
+    for (const row of data) table.push(row);
+    console.log(table.toString());
+  },
+
+  /**
+   * Display module completion message
+   * @param {string} moduleName - Name of the completed module
+   * @param {boolean} clearScreen - Whether to clear the screen first
+   */
+  displayModuleComplete(moduleName, clearScreen = true) {
+    if (clearScreen) {
+      console.clear();
+      this.displayLogo();
+    }
+
+    let message;
+
+    // Special messages for specific modules
+    if (moduleName.toLowerCase() === 'bmm') {
+      message = `Thank you for configuring the BMAD™ Method Module (BMM)!
+
+Your responses have been saved and will be used to configure your installation.`;
+    } else if (moduleName.toLowerCase() === 'cis') {
+      message = `Thank you for choosing the BMAD™ Creative Innovation Suite, an early beta
+release with much more planned!
+
+With this BMAD™ Creative Innovation Suite Configuration, remember that all
+paths are relative to project root, with no leading slash.`;
+    } else if (moduleName.toLowerCase() === 'core') {
+      message = `Thank you for choosing the BMAD™ Method, your gateway to dreaming, planning
+and building with real world proven techniques.
+
+All paths are relative to project root, with no leading slash.`;
+    } else {
+      message = `Thank you for configuring the BMAD™ ${moduleName.toUpperCase()} module!
+
+Your responses have been saved and will be used to configure your installation.`;
+    }
+
+    this.displayBox(message, {
+      borderColor: 'yellow',
+      borderStyle: 'double',
+      padding: 1,
+      margin: 1,
+    });
+  },
+};
+
+module.exports = { CLIUtils };

package/tools/cli/lib/config.js

@@ -0,0 +1,210 @@
+const fs = require('fs-extra');
+const yaml = require('js-yaml');
+const path = require('node:path');
+
+/**
+ * Configuration utility class
+ */
+class Config {
+  /**
+   * Load a YAML configuration file
+   * @param {string} configPath - Path to config file
+   * @returns {Object} Parsed configuration
+   */
+  async loadYaml(configPath) {
+    if (!(await fs.pathExists(configPath))) {
+      throw new Error(`Configuration file not found: ${configPath}`);
+    }
+
+    const content = await fs.readFile(configPath, 'utf8');
+    return yaml.load(content);
+  }
+
+  /**
+   * Save configuration to YAML file
+   * @param {string} configPath - Path to config file
+   * @param {Object} config - Configuration object
+   */
+  async saveYaml(configPath, config) {
+    const yamlContent = yaml.dump(config, {
+      indent: 2,
+      lineWidth: 120,
+      noRefs: true,
+    });
+
+    await fs.ensureDir(path.dirname(configPath));
+    await fs.writeFile(configPath, yamlContent, 'utf8');
+  }
+
+  /**
+   * Process configuration file (replace placeholders)
+   * @param {string} configPath - Path to config file
+   * @param {Object} replacements - Replacement values
+   */
+  async processConfig(configPath, replacements = {}) {
+    let content = await fs.readFile(configPath, 'utf8');
+
+    // Standard replacements
+    const standardReplacements = {
+      '{project-root}': replacements.root || '',
+      '{module}': replacements.module || '',
+      '{version}': replacements.version || '5.0.0',
+      '{date}': new Date().toISOString().split('T')[0],
+    };
+
+    // Apply all replacements
+    const allReplacements = { ...standardReplacements, ...replacements };
+
+    for (const [placeholder, value] of Object.entries(allReplacements)) {
+      if (typeof placeholder === 'string' && typeof value === 'string') {
+        const regex = new RegExp(placeholder.replaceAll(/[.*+?^${}()|[\]\\]/g, String.raw`\$&`), 'g');
+        content = content.replace(regex, value);
+      }
+    }
+
+    await fs.writeFile(configPath, content, 'utf8');
+  }
+
+  /**
+   * Merge configurations
+   * @param {Object} base - Base configuration
+   * @param {Object} override - Override configuration
+   * @returns {Object} Merged configuration
+   */
+  mergeConfigs(base, override) {
+    return this.deepMerge(base, override);
+  }
+
+  /**
+   * Deep merge two objects
+   * @param {Object} target - Target object
+   * @param {Object} source - Source object
+   * @returns {Object} Merged object
+   */
+  deepMerge(target, source) {
+    const output = { ...target };
+
+    if (this.isObject(target) && this.isObject(source)) {
+      for (const key of Object.keys(source)) {
+        if (this.isObject(source[key])) {
+          if (key in target) {
+            output[key] = this.deepMerge(target[key], source[key]);
+          } else {
+            output[key] = source[key];
+          }
+        } else {
+          output[key] = source[key];
+        }
+      }
+    }
+
+    return output;
+  }
+
+  /**
+   * Check if value is an object
+   * @param {*} item - Item to check
+   * @returns {boolean} True if object
+   */
+  isObject(item) {
+    return item && typeof item === 'object' && !Array.isArray(item);
+  }
+
+  /**
+   * Validate configuration against schema
+   * @param {Object} config - Configuration to validate
+   * @param {Object} schema - Validation schema
+   * @returns {Object} Validation result
+   */
+  validateConfig(config, schema) {
+    const errors = [];
+    const warnings = [];
+
+    // Check required fields
+    if (schema.required) {
+      for (const field of schema.required) {
+        if (!(field in config)) {
+          errors.push(`Missing required field: ${field}`);
+        }
+      }
+    }
+
+    // Check field types
+    if (schema.properties) {
+      for (const [field, spec] of Object.entries(schema.properties)) {
+        if (field in config) {
+          const value = config[field];
+          const expectedType = spec.type;
+
+          if (expectedType === 'array' && !Array.isArray(value)) {
+            errors.push(`Field '${field}' should be an array`);
+          } else if (expectedType === 'object' && !this.isObject(value)) {
+            errors.push(`Field '${field}' should be an object`);
+          } else if (expectedType === 'string' && typeof value !== 'string') {
+            errors.push(`Field '${field}' should be a string`);
+          } else if (expectedType === 'number' && typeof value !== 'number') {
+            errors.push(`Field '${field}' should be a number`);
+          } else if (expectedType === 'boolean' && typeof value !== 'boolean') {
+            errors.push(`Field '${field}' should be a boolean`);
+          }
+
+          // Check enum values
+          if (spec.enum && !spec.enum.includes(value)) {
+            errors.push(`Field '${field}' must be one of: ${spec.enum.join(', ')}`);
+          }
+        }
+      }
+    }
+
+    return {
+      valid: errors.length === 0,
+      errors,
+      warnings,
+    };
+  }
+
+  /**
+   * Get configuration value with fallback
+   * @param {Object} config - Configuration object
+   * @param {string} path - Dot-notation path to value
+   * @param {*} defaultValue - Default value if not found
+   * @returns {*} Configuration value
+   */
+  getValue(config, path, defaultValue = null) {
+    const keys = path.split('.');
+    let current = config;
+
+    for (const key of keys) {
+      if (current && typeof current === 'object' && key in current) {
+        current = current[key];
+      } else {
+        return defaultValue;
+      }
+    }
+
+    return current;
+  }
+
+  /**
+   * Set configuration value
+   * @param {Object} config - Configuration object
+   * @param {string} path - Dot-notation path to value
+   * @param {*} value - Value to set
+   */
+  setValue(config, path, value) {
+    const keys = path.split('.');
+    const lastKey = keys.pop();
+    let current = config;
+
+    for (const key of keys) {
+      if (!(key in current) || typeof current[key] !== 'object') {
+        current[key] = {};
+      }
+      current = current[key];
+    }
+
+    current[lastKey] = value;
+  }
+}
+
+module.exports = { Config };

package/tools/cli/lib/file-ops.js

@@ -0,0 +1,204 @@
+const fs = require('fs-extra');
+const path = require('node:path');
+const crypto = require('node:crypto');
+
+/**
+ * File operations utility class
+ */
+class FileOps {
+  /**
+   * Copy a directory recursively
+   * @param {string} source - Source directory
+   * @param {string} dest - Destination directory
+   * @param {Object} options - Copy options
+   */
+  async copyDirectory(source, dest, options = {}) {
+    const defaultOptions = {
+      overwrite: true,
+      errorOnExist: false,
+      filter: (src) => !this.shouldIgnore(src),
+    };
+
+    const copyOptions = { ...defaultOptions, ...options };
+    await fs.copy(source, dest, copyOptions);
+  }
+
+  /**
+   * Sync directory (selective copy preserving modifications)
+   * @param {string} source - Source directory
+   * @param {string} dest - Destination directory
+   */
+  async syncDirectory(source, dest) {
+    const sourceFiles = await this.getFileList(source);
+
+    for (const file of sourceFiles) {
+      const sourceFile = path.join(source, file);
+      const destFile = path.join(dest, file);
+
+      // Check if destination file exists
+      if (await fs.pathExists(destFile)) {
+        // Compare checksums to see if file has been modified
+        const sourceHash = await this.getFileHash(sourceFile);
+        const destHash = await this.getFileHash(destFile);
+
+        if (sourceHash === destHash) {
+          // Files are identical, safe to update
+          await fs.copy(sourceFile, destFile, { overwrite: true });
+        } else {
+          // File has been modified, check timestamps
+          const sourceStats = await fs.stat(sourceFile);
+          const destStats = await fs.stat(destFile);
+
+          if (sourceStats.mtime > destStats.mtime) {
+            // Source is newer, update
+            await fs.copy(sourceFile, destFile, { overwrite: true });
+          }
+          // Otherwise, preserve user modifications
+        }
+      } else {
+        // New file, copy it
+        await fs.ensureDir(path.dirname(destFile));
+        await fs.copy(sourceFile, destFile);
+      }
+    }
+
+    // Remove files that no longer exist in source
+    const destFiles = await this.getFileList(dest);
+    for (const file of destFiles) {
+      const sourceFile = path.join(source, file);
+      const destFile = path.join(dest, file);
+
+      if (!(await fs.pathExists(sourceFile))) {
+        await fs.remove(destFile);
+      }
+    }
+  }
+
+  /**
+   * Get list of all files in a directory
+   * @param {string} dir - Directory path
+   * @returns {Array} List of relative file paths
+   */
+  async getFileList(dir) {
+    const files = [];
+
+    if (!(await fs.pathExists(dir))) {
+      return files;
+    }
+
+    const walk = async (currentDir, baseDir) => {
+      const entries = await fs.readdir(currentDir, { withFileTypes: true });
+
+      for (const entry of entries) {
+        const fullPath = path.join(currentDir, entry.name);
+
+        if (entry.isDirectory() && !this.shouldIgnore(fullPath)) {
+          await walk(fullPath, baseDir);
+        } else if (entry.isFile() && !this.shouldIgnore(fullPath)) {
+          files.push(path.relative(baseDir, fullPath));
+        }
+      }
+    };
+
+    await walk(dir, dir);
+    return files;
+  }
+
+  /**
+   * Get file hash for comparison
+   * @param {string} filePath - File path
+   * @returns {string} File hash
+   */
+  async getFileHash(filePath) {
+    const hash = crypto.createHash('sha256');
+    const stream = fs.createReadStream(filePath);
+
+    return new Promise((resolve, reject) => {
+      stream.on('data', (data) => hash.update(data));
+      stream.on('end', () => resolve(hash.digest('hex')));
+      stream.on('error', reject);
+    });
+  }
+
+  /**
+   * Check if a path should be ignored
+   * @param {string} filePath - Path to check
+   * @returns {boolean} True if should be ignored
+   */
+  shouldIgnore(filePath) {
+    const ignoredPatterns = ['.git', '.DS_Store', 'node_modules', '*.swp', '*.tmp', '.idea', '.vscode', '__pycache__', '*.pyc'];
+
+    const basename = path.basename(filePath);
+
+    for (const pattern of ignoredPatterns) {
+      if (pattern.includes('*')) {
+        // Simple glob pattern matching
+        const regex = new RegExp(pattern.replace('*', '.*'));
+        if (regex.test(basename)) {
+          return true;
+        }
+      } else if (basename === pattern) {
+        return true;
+      }
+    }
+
+    return false;
+  }
+
+  /**
+   * Ensure directory exists
+   * @param {string} dir - Directory path
+   */
+  async ensureDir(dir) {
+    await fs.ensureDir(dir);
+  }
+
+  /**
+   * Remove directory or file
+   * @param {string} targetPath - Path to remove
+   */
+  async remove(targetPath) {
+    if (await fs.pathExists(targetPath)) {
+      await fs.remove(targetPath);
+    }
+  }
+
+  /**
+   * Read file content
+   * @param {string} filePath - File path
+   * @returns {string} File content
+   */
+  async readFile(filePath) {
+    return await fs.readFile(filePath, 'utf8');
+  }
+
+  /**
+   * Write file content
+   * @param {string} filePath - File path
+   * @param {string} content - File content
+   */
+  async writeFile(filePath, content) {
+    await fs.ensureDir(path.dirname(filePath));
+    await fs.writeFile(filePath, content, 'utf8');
+  }
+
+  /**
+   * Check if path exists
+   * @param {string} targetPath - Path to check
+   * @returns {boolean} True if exists
+   */
+  async exists(targetPath) {
+    return await fs.pathExists(targetPath);
+  }
+
+  /**
+   * Get file or directory stats
+   * @param {string} targetPath - Path to check
+   * @returns {Object} File stats
+   */
+  async stat(targetPath) {
+    return await fs.stat(targetPath);
+  }
+}
+
+module.exports = { FileOps };