bmad-method 6.2.2 → 6.2.3-next.1

package/tools/{cli/lib → installer}/ui.js

@@ -2,8 +2,8 @@ const path = require('node:path');
 const os = require('node:os');
 const fs = require('fs-extra');
 const { CLIUtils } = require('./cli-utils');
-const { CustomHandler } = require('../installers/lib/custom/handler');
-const { ExternalModuleManager } = require('../installers/lib/modules/external-manager');
+const { CustomHandler } = require('./custom-handler');
+const { ExternalModuleManager } = require('./modules/external-manager');
 const prompts = require('./prompts');
 
 // Separator class for visual grouping in select/multiselect prompts
@@ -32,7 +32,7 @@ class UI {
     await CLIUtils.displayLogo();
 
     // Display version-specific start message from install-messages.yaml
-    const { MessageLoader } = require('../installers/lib/message-loader');
+    const { MessageLoader } = require('./message-loader');
     const messageLoader = new MessageLoader();
     await messageLoader.displayStartMessage();
 
@@ -51,125 +51,11 @@ class UI {
       confirmedDirectory = await this.getConfirmedDirectory();
     }
 
-    // Preflight: Check for legacy BMAD v4 footprints immediately after getting directory
-    const { Detector } = require('../installers/lib/core/detector');
-    const { Installer } = require('../installers/lib/core/installer');
-    const detector = new Detector();
+    const { Installer } = require('./core/installer');
     const installer = new Installer();
-    const legacyV4 = await detector.detectLegacyV4(confirmedDirectory);
-    if (legacyV4.hasLegacyV4) {
-      await installer.handleLegacyV4Migration(confirmedDirectory, legacyV4);
-    }
-
-    // Check for legacy folders and prompt for rename before showing any menus
-    let hasLegacyCfg = false;
-    let hasLegacyBmadFolder = false;
-    let bmadDir = null;
-    let legacyBmadPath = null;
-
-    // First check for legacy .bmad folder (instead of _bmad)
-    // Only check if directory exists
-    if (await fs.pathExists(confirmedDirectory)) {
-      const entries = await fs.readdir(confirmedDirectory, { withFileTypes: true });
-      for (const entry of entries) {
-        if (entry.isDirectory() && (entry.name === '.bmad' || entry.name === 'bmad')) {
-          hasLegacyBmadFolder = true;
-          legacyBmadPath = path.join(confirmedDirectory, entry.name);
-          bmadDir = legacyBmadPath;
-
-          // Check if it has _cfg folder
-          const cfgPath = path.join(legacyBmadPath, '_cfg');
-          if (await fs.pathExists(cfgPath)) {
-            hasLegacyCfg = true;
-          }
-          break;
-        }
-      }
-    }
-
-    // If no .bmad or bmad found, check for current installations _bmad
-    if (!hasLegacyBmadFolder) {
-      const bmadResult = await installer.findBmadDir(confirmedDirectory);
-      bmadDir = bmadResult.bmadDir;
-      hasLegacyCfg = bmadResult.hasLegacyCfg;
-    }
+    const { bmadDir } = await installer.findBmadDir(confirmedDirectory);
 
-    // Handle legacy .bmad or _cfg folder - these are very old (v4 or alpha)
-    // Show version warning instead of offering conversion
-    if (hasLegacyBmadFolder || hasLegacyCfg) {
-      await prompts.log.warn('LEGACY INSTALLATION DETECTED');
-      await prompts.note(
-        'Found a ".bmad"/"bmad" folder, or a legacy "_cfg" folder under the bmad folder -\n' +
-          'this is from an old BMAD version that is out of date for automatic upgrade,\n' +
-          'manual intervention required.\n\n' +
-          'You have a legacy version installed (v4 or alpha).\n' +
-          'Legacy installations may have compatibility issues.\n\n' +
-          'For the best experience, we strongly recommend:\n' +
-          '  1. Delete your current BMAD installation folder (.bmad or bmad)\n' +
-          '  2. Run a fresh installation\n\n' +
-          'If you do not want to start fresh, you can attempt to proceed beyond this\n' +
-          'point IF you have ensured the bmad folder is named _bmad, and under it there\n' +
-          'is a _config folder. If you have a folder under your bmad folder named _cfg,\n' +
-          'you would need to rename it _config, and then restart the installer.\n\n' +
-          'Benefits of a fresh install:\n' +
-          '  \u2022 Cleaner configuration without legacy artifacts\n' +
-          '  \u2022 All new features properly configured\n' +
-          '  \u2022 Fewer potential conflicts\n\n' +
-          'If you have already produced output from an earlier alpha version, you can\n' +
-          'still retain those artifacts. After installation, ensure you configured during\n' +
-          'install the proper file locations for artifacts depending on the module you\n' +
-          'are using, or move the files to the proper locations.',
-        'Legacy Installation Detected',
-      );
-
-      const proceed = await prompts.select({
-        message: 'How would you like to proceed?',
-        choices: [
-          {
-            name: 'Cancel and do a fresh install (recommended)',
-            value: 'cancel',
-          },
-          {
-            name: 'Proceed anyway (will attempt update, potentially may fail or have unstable behavior)',
-            value: 'proceed',
-          },
-        ],
-        default: 'cancel',
-      });
-
-      if (proceed === 'cancel') {
-        await prompts.note('1. Delete the existing bmad folder in your project\n' + "2. Run 'bmad install' again", 'To do a fresh install');
-        process.exit(0);
-        return;
-      }
-
-      const s = await prompts.spinner();
-      s.start('Updating folder structure...');
-      try {
-        // Handle .bmad folder
-        if (hasLegacyBmadFolder) {
-          const newBmadPath = path.join(confirmedDirectory, '_bmad');
-          await fs.move(legacyBmadPath, newBmadPath);
-          bmadDir = newBmadPath;
-          s.stop(`Renamed "${path.basename(legacyBmadPath)}" to "_bmad"`);
-        }
-
-        // Handle _cfg folder (either from .bmad or standalone)
-        const cfgPath = path.join(bmadDir, '_cfg');
-        if (await fs.pathExists(cfgPath)) {
-          s.start('Renaming configuration folder...');
-          const newCfgPath = path.join(bmadDir, '_config');
-          await fs.move(cfgPath, newCfgPath);
-          s.stop('Renamed "_cfg" to "_config"');
-        }
-      } catch (error) {
-        s.stop('Failed to update folder structure');
-        await prompts.log.error(`Error: ${error.message}`);
-        process.exit(1);
-      }
-    }
-
-    // Check if there's an existing BMAD installation (after any folder renames)
+    // Check if there's an existing BMAD installation
     const hasExistingInstall = await fs.pathExists(bmadDir);
 
     let customContentConfig = { hasCustomContent: false };
@@ -184,18 +70,9 @@ class UI {
     if (hasExistingInstall) {
       // Get version information
       const { existingInstall, bmadDir } = await this.getExistingInstallation(confirmedDirectory);
-      const packageJsonPath = path.join(__dirname, '../../../package.json');
+      const packageJsonPath = path.join(__dirname, '../../package.json');
       const currentVersion = require(packageJsonPath).version;
-      const installedVersion = existingInstall.version || 'unknown';
-
-      // Check if version is pre beta
-      const shouldProceed = await this.showLegacyVersionWarning(installedVersion, currentVersion, path.basename(bmadDir), options);
-
-      // If user chose to cancel, exit the installer
-      if (!shouldProceed) {
-        process.exit(0);
-        return;
-      }
+      const installedVersion = existingInstall.installed ? existingInstall.version || 'unknown' : 'unknown';
 
       // Build menu choices dynamically
       const choices = [];
@@ -402,7 +279,7 @@ class UI {
             customModuleResult = await this.handleCustomModulesInModifyFlow(confirmedDirectory, selectedModules);
           } else {
             // Preserve existing custom modules if user doesn't want to modify them
-            const { Installer } = require('../installers/lib/core/installer');
+            const { Installer } = require('./core/installer');
             const installer = new Installer();
             const { bmadDir } = await installer.findBmadDir(confirmedDirectory);
 
@@ -423,22 +300,24 @@ class UI {
           selectedModules.push(...customModuleResult.selectedCustomModules);
         }
 
-        // Filter out core - it's always installed via installCore flag
-        selectedModules = selectedModules.filter((m) => m !== 'core');
+        // Ensure core is in the modules list
+        if (!selectedModules.includes('core')) {
+          selectedModules.unshift('core');
+        }
 
         // Get tool selection
         const toolSelection = await this.promptToolSelection(confirmedDirectory, options);
 
-        const coreConfig = await this.collectCoreConfig(confirmedDirectory, options);
+        const moduleConfigs = await this.collectModuleConfigs(confirmedDirectory, selectedModules, options);
 
         return {
           actionType: 'update',
           directory: confirmedDirectory,
-          installCore: true,
           modules: selectedModules,
           ides: toolSelection.ides,
           skipIde: toolSelection.skipIde,
-          coreConfig: coreConfig,
+          coreConfig: moduleConfigs.core || {},
+          moduleConfigs: moduleConfigs,
           customContent: customModuleResult.customContentConfig,
           skipPrompts: options.yes || false,
         };
@@ -543,18 +422,21 @@ class UI {
       selectedModules.push(...customContentConfig.selectedModuleIds);
     }
 
-    selectedModules = selectedModules.filter((m) => m !== 'core');
+    // Ensure core is in the modules list
+    if (!selectedModules.includes('core')) {
+      selectedModules.unshift('core');
+    }
     let toolSelection = await this.promptToolSelection(confirmedDirectory, options);
-    const coreConfig = await this.collectCoreConfig(confirmedDirectory, options);
+    const moduleConfigs = await this.collectModuleConfigs(confirmedDirectory, selectedModules, options);
 
     return {
       actionType: 'install',
       directory: confirmedDirectory,
-      installCore: true,
       modules: selectedModules,
       ides: toolSelection.ides,
       skipIde: toolSelection.skipIde,
-      coreConfig: coreConfig,
+      coreConfig: moduleConfigs.core || {},
+      moduleConfigs: moduleConfigs,
       customContent: customContentConfig,
       skipPrompts: options.yes || false,
     };
@@ -570,18 +452,15 @@ class UI {
    * @returns {Object} Tool configuration
    */
   async promptToolSelection(projectDir, options = {}) {
-    // Check for existing configured IDEs - use findBmadDir to detect custom folder names
-    const { Detector } = require('../installers/lib/core/detector');
-    const { Installer } = require('../installers/lib/core/installer');
-    const detector = new Detector();
+    const { ExistingInstall } = require('./core/existing-install');
+    const { Installer } = require('./core/installer');
     const installer = new Installer();
-    const bmadResult = await installer.findBmadDir(projectDir || process.cwd());
-    const bmadDir = bmadResult.bmadDir;
-    const existingInstall = await detector.detect(bmadDir);
-    const configuredIdes = existingInstall.ides || [];
+    const { bmadDir } = await installer.findBmadDir(projectDir || process.cwd());
+    const existingInstall = await ExistingInstall.detect(bmadDir);
+    const configuredIdes = existingInstall.ides;
 
     // Get IDE manager to fetch available IDEs dynamically
-    const { IdeManager } = require('../installers/lib/ide/manager');
+    const { IdeManager } = require('./ide/manager');
     const ideManager = new IdeManager();
     await ideManager.ensureInitialized(); // IMPORTANT: Must initialize before getting IDEs
 
@@ -811,29 +690,29 @@ class UI {
    * @returns {Object} Object with existingInstall, installedModuleIds, and bmadDir
    */
   async getExistingInstallation(directory) {
-    const { Detector } = require('../installers/lib/core/detector');
-    const { Installer } = require('../installers/lib/core/installer');
-    const detector = new Detector();
+    const { ExistingInstall } = require('./core/existing-install');
+    const { Installer } = require('./core/installer');
     const installer = new Installer();
-    const bmadDirResult = await installer.findBmadDir(directory);
-    const bmadDir = bmadDirResult.bmadDir;
-    const existingInstall = await detector.detect(bmadDir);
-    const installedModuleIds = new Set(existingInstall.modules.map((mod) => mod.id));
+    const { bmadDir } = await installer.findBmadDir(directory);
+    const existingInstall = await ExistingInstall.detect(bmadDir);
+    const installedModuleIds = new Set(existingInstall.moduleIds);
 
     return { existingInstall, installedModuleIds, bmadDir };
   }
 
   /**
-   * Collect core configuration
+   * Collect all module configurations (core + selected modules).
+   * All interactive prompting happens here in the UI layer.
    * @param {string} directory - Installation directory
+   * @param {string[]} modules - Modules to configure (including 'core')
    * @param {Object} options - Command-line options
-   * @returns {Object} Core configuration
+   * @returns {Object} Collected module configurations keyed by module name
    */
-  async collectCoreConfig(directory, options = {}) {
-    const { ConfigCollector } = require('../installers/lib/core/config-collector');
-    const configCollector = new ConfigCollector();
+  async collectModuleConfigs(directory, modules, options = {}) {
+    const { OfficialModules } = require('./modules/official-modules');
+    const configCollector = new OfficialModules();
 
-    // If options are provided, set them directly
+    // Seed core config from CLI options if provided
     if (options.userName || options.communicationLanguage || options.documentOutputLanguage || options.outputFolder) {
       const coreConfig = {};
       if (options.userName) {
@@ -855,8 +734,6 @@ class UI {
 
       // Load existing config to merge with provided options
       await configCollector.loadExistingConfig(directory);
-
-      // Merge provided options with existing config (or defaults)
       const existingConfig = configCollector.collectedConfig.core || {};
       configCollector.collectedConfig.core = { ...existingConfig, ...coreConfig };
 
@@ -872,7 +749,6 @@ class UI {
       await configCollector.loadExistingConfig(directory);
       const existingConfig = configCollector.collectedConfig.core || {};
 
-      // If no existing config, use defaults
       if (Object.keys(existingConfig).length === 0) {
         let safeUsername;
         try {
@@ -889,16 +765,14 @@ class UI {
         };
         await prompts.log.info('Using default configuration (--yes flag)');
       }
-    } else {
-      // Load existing configs first if they exist
-      await configCollector.loadExistingConfig(directory);
-      // Now collect with existing values as defaults (false = don't skip loading, true = skip completion message)
-      await configCollector.collectModuleConfig('core', directory, false, true);
     }
 
-    const coreConfig = configCollector.collectedConfig.core;
-    // Ensure we always have a core config object, even if empty
-    return coreConfig || {};
+    // Collect all module configs — core is skipped if already seeded above
+    await configCollector.collectAllConfigurations(modules, directory, {
+      skipPrompts: options.yes || false,
+    });
+
+    return configCollector.collectedConfig;
   }
 
   /**
@@ -935,9 +809,9 @@ class UI {
     }
 
     // Add official modules
-    const { ModuleManager } = require('../installers/lib/modules/manager');
-    const moduleManager = new ModuleManager();
-    const { modules: availableModules, customModules: customModulesFromCache } = await moduleManager.listAvailable();
+    const { OfficialModules } = require('./modules/official-modules');
+    const officialModules = new OfficialModules();
+    const { modules: availableModules, customModules: customModulesFromCache } = await officialModules.listAvailable();
 
     // First, add all items to appropriate sections
     const allCustomModules = [];
@@ -992,9 +866,9 @@ class UI {
    * @returns {Array} Selected module codes (excluding core)
    */
   async selectAllModules(installedModuleIds = new Set()) {
-    const { ModuleManager } = require('../installers/lib/modules/manager');
-    const moduleManager = new ModuleManager();
-    const { modules: localModules } = await moduleManager.listAvailable();
+    const { OfficialModules } = require('./modules/official-modules');
+    const officialModulesSource = new OfficialModules();
+    const { modules: localModules } = await officialModulesSource.listAvailable();
 
     // Get external modules
     const externalManager = new ExternalModuleManager();
@@ -1069,7 +943,7 @@ class UI {
       maxItems: allOptions.length,
     });
 
-    const result = selected ? selected.filter((m) => m !== 'core') : [];
+    const result = selected ? [...selected] : [];
 
     // Display selected modules as bulleted list
     if (result.length > 0) {
@@ -1089,9 +963,9 @@ class UI {
    * @returns {Array} Default module codes
    */
   async getDefaultModules(installedModuleIds = new Set()) {
-    const { ModuleManager } = require('../installers/lib/modules/manager');
-    const moduleManager = new ModuleManager();
-    const { modules: localModules } = await moduleManager.listAvailable();
+    const { OfficialModules } = require('./modules/official-modules');
+    const officialModules = new OfficialModules();
+    const { modules: localModules } = await officialModules.listAvailable();
 
     const defaultModules = [];
 
@@ -1149,7 +1023,7 @@ class UI {
         const files = await fs.readdir(directory);
         if (files.length > 0) {
           // Check for any bmad installation (any folder with _config/manifest.yaml)
-          const { Installer } = require('../installers/lib/core/installer');
+          const { Installer } = require('./core/installer');
           const installer = new Installer();
           const bmadResult = await installer.findBmadDir(directory);
           const hasBmadInstall =
@@ -1385,50 +1259,18 @@ class UI {
     return path.resolve(expanded);
   }
 
-  /**
-   * Load existing configurations to use as defaults
-   * @param {string} directory - Installation directory
-   * @returns {Object} Existing configurations
-   */
-  async loadExistingConfigurations(directory) {
-    const configs = {
-      hasCustomContent: false,
-      coreConfig: {},
-      ideConfig: { ides: [], skipIde: false },
-    };
-
-    try {
-      // Load core config
-      configs.coreConfig = await this.collectCoreConfig(directory);
-
-      // Load IDE configuration
-      const configuredIdes = await this.getConfiguredIdes(directory);
-      if (configuredIdes.length > 0) {
-        configs.ideConfig.ides = configuredIdes;
-        configs.ideConfig.skipIde = false;
-      }
-
-      return configs;
-    } catch {
-      // If loading fails, return empty configs
-      await prompts.log.warn('Could not load existing configurations');
-      return configs;
-    }
-  }
-
   /**
    * Get configured IDEs from existing installation
    * @param {string} directory - Installation directory
    * @returns {Array} List of configured IDEs
    */
   async getConfiguredIdes(directory) {
-    const { Detector } = require('../installers/lib/core/detector');
-    const { Installer } = require('../installers/lib/core/installer');
-    const detector = new Detector();
+    const { ExistingInstall } = require('./core/existing-install');
+    const { Installer } = require('./core/installer');
     const installer = new Installer();
-    const bmadResult = await installer.findBmadDir(directory);
-    const existingInstall = await detector.detect(bmadResult.bmadDir);
-    return existingInstall.ides || [];
+    const { bmadDir } = await installer.findBmadDir(directory);
+    const existingInstall = await ExistingInstall.detect(bmadDir);
+    return existingInstall.ides;
   }
 
   /**
@@ -1573,7 +1415,7 @@ class UI {
     const { existingInstall } = await this.getExistingInstallation(directory);
 
     // Check if there are any custom modules in cache
-    const { Installer } = require('../installers/lib/core/installer');
+    const { Installer } = require('./core/installer');
     const installer = new Installer();
     const { bmadDir } = await installer.findBmadDir(directory);
 
@@ -1707,82 +1549,6 @@ class UI {
     return result;
   }
 
-  /**
-   * Check if installed version is a legacy version that needs fresh install
-   * @param {string} installedVersion - The installed version
-   * @returns {boolean} True if legacy (v4 or any alpha)
-   */
-  isLegacyVersion(installedVersion) {
-    if (!installedVersion || installedVersion === 'unknown') {
-      return true; // Treat unknown as legacy for safety
-    }
-    // Check if version string contains -alpha or -Alpha (any v6 alpha)
-    return /-alpha\./i.test(installedVersion);
-  }
-
-  /**
-   * Show warning for legacy version (v4 or alpha) and ask if user wants to proceed
-   * @param {string} installedVersion - The installed version
-   * @param {string} currentVersion - The current version
-   * @param {string} bmadFolderName - Name of the BMAD folder
-   * @returns {Promise<boolean>} True if user wants to proceed, false if they cancel
-   */
-  async showLegacyVersionWarning(installedVersion, currentVersion, bmadFolderName, options = {}) {
-    if (!this.isLegacyVersion(installedVersion)) {
-      return true; // Not legacy, proceed
-    }
-
-    let warningContent;
-    if (installedVersion === 'unknown') {
-      warningContent = 'Unable to detect your installed BMAD version.\n' + 'This appears to be a legacy or unsupported installation.';
-    } else {
-      warningContent =
-        `You are updating from ${installedVersion} to ${currentVersion}.\n` + 'You have a legacy version installed (v4 or alpha).';
-    }
-
-    warningContent +=
-      '\n\nFor the best experience, we recommend:\n' +
-      '  1. Delete your current BMAD installation folder\n' +
-      `     (the "${bmadFolderName}/" folder in your project)\n` +
-      '  2. Run a fresh installation\n\n' +
-      'Benefits of a fresh install:\n' +
-      '  \u2022 Cleaner configuration without legacy artifacts\n' +
-      '  \u2022 All new features properly configured\n' +
-      '  \u2022 Fewer potential conflicts';
-
-    await prompts.log.warn('VERSION WARNING');
-    await prompts.note(warningContent, 'Version Warning');
-
-    if (options.yes) {
-      await prompts.log.warn('Non-interactive mode (--yes): auto-proceeding with legacy update');
-      return true;
-    }
-
-    const proceed = await prompts.select({
-      message: 'How would you like to proceed?',
-      choices: [
-        {
-          name: 'Proceed with update anyway (may have issues)',
-          value: 'proceed',
-        },
-        {
-          name: 'Cancel (recommended - do a fresh install instead)',
-          value: 'cancel',
-        },
-      ],
-      default: 'cancel',
-    });
-
-    if (proceed === 'cancel') {
-      await prompts.note(
-        `1. Delete the "${bmadFolderName}/" folder in your project\n` + "2. Run 'bmad install' again",
-        'To do a fresh install',
-      );
-    }
-
-    return proceed === 'proceed';
-  }
-
   /**
    * Display module versions with update availability
    * @param {Array} modules - Array of module info objects with version info

package/tools/javascript-conventions.md

@@ -0,0 +1,5 @@
+# JavaScript Conventions
+
+## Function ordering
+
+Define functions top-to-bottom in call order: callers above callees. If `install()` calls `_initPaths()`, then `install` appears first and `_initPaths` appears after it.

package/tools/bmad-npx-wrapper.js

@@ -1,38 +0,0 @@
-#!/usr/bin/env node
-
-/**
- * BMad Method CLI - Direct execution wrapper for npx
- * This file ensures proper execution when run via npx from GitHub or npm registry
- */
-
-const { execFileSync } = require('node:child_process');
-const path = require('node:path');
-const fs = require('node:fs');
-
-// Check if we're running in an npx temporary directory
-const isNpxExecution = __dirname.includes('_npx') || __dirname.includes('.npm');
-
-if (isNpxExecution) {
-  // Running via npx - spawn child process to preserve user's working directory
-  const args = process.argv.slice(2);
-  const bmadCliPath = path.join(__dirname, 'cli', 'bmad-cli.js');
-
-  if (!fs.existsSync(bmadCliPath)) {
-    console.error('Error: Could not find bmad-cli.js at', bmadCliPath);
-    console.error('Current directory:', __dirname);
-    process.exit(1);
-  }
-
-  try {
-    // Execute CLI from user's working directory (process.cwd()), not npm cache
-    execFileSync('node', [bmadCliPath, ...args], {
-      stdio: 'inherit',
-      cwd: process.cwd(), // This preserves the user's working directory
-    });
-  } catch (error) {
-    process.exit(error.status || 1);
-  }
-} else {
-  // Local execution - use require
-  require('./cli/bmad-cli.js');
-}