bmad-method 5.1.2 → 6.0.0-alpha.0

package/tools/cli/installers/lib/ide/trae.js

@@ -0,0 +1,182 @@
+const path = require('node:path');
+const { BaseIdeSetup } = require('./_base-ide');
+const chalk = require('chalk');
+
+/**
+ * Trae IDE setup handler
+ */
+class TraeSetup extends BaseIdeSetup {
+  constructor() {
+    super('trae', 'Trae');
+    this.configDir = '.trae';
+    this.rulesDir = 'rules';
+  }
+
+  /**
+   * Setup Trae IDE configuration
+   * @param {string} projectDir - Project directory
+   * @param {string} bmadDir - BMAD installation directory
+   * @param {Object} options - Setup options
+   */
+  async setup(projectDir, bmadDir, options = {}) {
+    console.log(chalk.cyan(`Setting up ${this.name}...`));
+
+    // Create .trae/rules directory
+    const traeDir = path.join(projectDir, this.configDir);
+    const rulesDir = path.join(traeDir, this.rulesDir);
+
+    await this.ensureDir(rulesDir);
+
+    // Get agents and tasks
+    const agents = await this.getAgents(bmadDir);
+    const tasks = await this.getTasks(bmadDir);
+
+    // Process agents as rules
+    let ruleCount = 0;
+    for (const agent of agents) {
+      const content = await this.readFile(agent.path);
+      const processedContent = this.createAgentRule(agent, content, bmadDir, projectDir);
+
+      const targetPath = path.join(rulesDir, `${agent.module}-${agent.name}.md`);
+      await this.writeFile(targetPath, processedContent);
+      ruleCount++;
+    }
+
+    // Process tasks as rules
+    for (const task of tasks) {
+      const content = await this.readFile(task.path);
+      const processedContent = this.createTaskRule(task, content);
+
+      const targetPath = path.join(rulesDir, `task-${task.module}-${task.name}.md`);
+      await this.writeFile(targetPath, processedContent);
+      ruleCount++;
+    }
+
+    console.log(chalk.green(`✓ ${this.name} configured:`));
+    console.log(chalk.dim(`  - ${ruleCount} rules created`));
+    console.log(chalk.dim(`  - Rules directory: ${path.relative(projectDir, rulesDir)}`));
+    console.log(chalk.dim(`  - Agents can be activated with @{agent-name}`));
+
+    return {
+      success: true,
+      rules: ruleCount,
+    };
+  }
+
+  /**
+   * Create rule content for an agent
+   */
+  createAgentRule(agent, content, bmadDir, projectDir) {
+    // Extract metadata from agent content
+    const titleMatch = content.match(/title="([^"]+)"/);
+    const title = titleMatch ? titleMatch[1] : this.formatTitle(agent.name);
+
+    const iconMatch = content.match(/icon="([^"]+)"/);
+    const icon = iconMatch ? iconMatch[1] : '🤖';
+
+    // Extract YAML content if available
+    const yamlMatch = content.match(/```ya?ml\r?\n([\s\S]*?)```/);
+    const yamlContent = yamlMatch ? yamlMatch[1] : content;
+
+    // Calculate relative path for reference
+    const relativePath = path.relative(projectDir, agent.path).replaceAll('\\', '/');
+
+    let ruleContent = `# ${title} Agent Rule
+
+This rule is triggered when the user types \`@${agent.name}\` and activates the ${title} agent persona.
+
+## Agent Activation
+
+CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
+
+\`\`\`yaml
+${yamlContent}
+\`\`\`
+
+## File Reference
+
+The complete agent definition is available in [${relativePath}](${relativePath}).
+
+## Usage
+
+When the user types \`@${agent.name}\`, activate this ${title} persona and follow all instructions defined in the YAML configuration above.
+
+## Module
+
+Part of the BMAD ${agent.module.toUpperCase()} module.
+`;
+
+    return ruleContent;
+  }
+
+  /**
+   * Create rule content for a task
+   */
+  createTaskRule(task, content) {
+    // Extract task name from content
+    const nameMatch = content.match(/<name>([^<]+)<\/name>/);
+    const taskName = nameMatch ? nameMatch[1] : this.formatTitle(task.name);
+
+    let ruleContent = `# ${taskName} Task Rule
+
+This rule defines the ${taskName} task workflow.
+
+## Task Definition
+
+When this task is triggered, execute the following workflow:
+
+${content}
+
+## Usage
+
+Reference this task with \`@task-${task.name}\` to execute the defined workflow.
+
+## Module
+
+Part of the BMAD ${task.module.toUpperCase()} module.
+`;
+
+    return ruleContent;
+  }
+
+  /**
+   * Format agent/task name as title
+   */
+  formatTitle(name) {
+    return name
+      .split('-')
+      .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+      .join(' ');
+  }
+
+  /**
+   * Cleanup Trae configuration
+   */
+  async cleanup(projectDir) {
+    const fs = require('fs-extra');
+    const rulesPath = path.join(projectDir, this.configDir, this.rulesDir);
+
+    if (await fs.pathExists(rulesPath)) {
+      // Only remove BMAD rules
+      const files = await fs.readdir(rulesPath);
+      let removed = 0;
+
+      for (const file of files) {
+        if (file.endsWith('.md')) {
+          const filePath = path.join(rulesPath, file);
+          const content = await fs.readFile(filePath, 'utf8');
+
+          // Check if it's a BMAD rule
+          if (content.includes('BMAD') && content.includes('module')) {
+            await fs.remove(filePath);
+            removed++;
+          }
+        }
+      }
+
+      console.log(chalk.dim(`Removed ${removed} BMAD rules from Trae`));
+    }
+  }
+}
+
+module.exports = { TraeSetup };

package/tools/cli/installers/lib/ide/windsurf.js

@@ -0,0 +1,149 @@
+const path = require('node:path');
+const { BaseIdeSetup } = require('./_base-ide');
+const chalk = require('chalk');
+
+/**
+ * Windsurf IDE setup handler
+ */
+class WindsurfSetup extends BaseIdeSetup {
+  constructor() {
+    super('windsurf', 'Windsurf', true); // preferred IDE
+    this.configDir = '.windsurf';
+    this.workflowsDir = 'workflows';
+  }
+
+  /**
+   * Setup Windsurf IDE configuration
+   * @param {string} projectDir - Project directory
+   * @param {string} bmadDir - BMAD installation directory
+   * @param {Object} options - Setup options
+   */
+  async setup(projectDir, bmadDir, options = {}) {
+    console.log(chalk.cyan(`Setting up ${this.name}...`));
+
+    // Create .windsurf/workflows directory structure
+    const windsurfDir = path.join(projectDir, this.configDir);
+    const workflowsDir = path.join(windsurfDir, this.workflowsDir);
+
+    await this.ensureDir(workflowsDir);
+
+    // Get agents and tasks
+    const agents = await this.getAgents(bmadDir);
+    const tasks = await this.getTasks(bmadDir);
+
+    // Create directories for each module
+    const modules = new Set();
+    for (const item of [...agents, ...tasks]) modules.add(item.module);
+
+    for (const module of modules) {
+      await this.ensureDir(path.join(workflowsDir, module));
+      await this.ensureDir(path.join(workflowsDir, module, 'agents'));
+      await this.ensureDir(path.join(workflowsDir, module, 'tasks'));
+    }
+
+    // Process agents as workflows with organized structure
+    let agentCount = 0;
+    for (const agent of agents) {
+      const content = await this.readFile(agent.path);
+      const processedContent = this.createWorkflowContent(agent, content);
+
+      // Organized path: module/agents/agent-name.md
+      const targetPath = path.join(workflowsDir, agent.module, 'agents', `${agent.name}.md`);
+      await this.writeFile(targetPath, processedContent);
+      agentCount++;
+    }
+
+    // Process tasks as workflows with organized structure
+    let taskCount = 0;
+    for (const task of tasks) {
+      const content = await this.readFile(task.path);
+      const processedContent = this.createTaskWorkflowContent(task, content);
+
+      // Organized path: module/tasks/task-name.md
+      const targetPath = path.join(workflowsDir, task.module, 'tasks', `${task.name}.md`);
+      await this.writeFile(targetPath, processedContent);
+      taskCount++;
+    }
+
+    console.log(chalk.green(`✓ ${this.name} configured:`));
+    console.log(chalk.dim(`  - ${agentCount} agents installed`));
+    console.log(chalk.dim(`  - ${taskCount} tasks installed`));
+    console.log(chalk.dim(`  - Organized in modules: ${[...modules].join(', ')}`));
+    console.log(chalk.dim(`  - Workflows directory: ${path.relative(projectDir, workflowsDir)}`));
+
+    // Provide additional configuration hints
+    if (options.showHints !== false) {
+      console.log(chalk.dim('\n  Windsurf workflow settings:'));
+      console.log(chalk.dim('  - auto_execution_mode: 3 (recommended for agents)'));
+      console.log(chalk.dim('  - auto_execution_mode: 2 (recommended for tasks)'));
+      console.log(chalk.dim('  - Workflows can be triggered via the Windsurf menu'));
+    }
+
+    return {
+      success: true,
+      agents: agentCount,
+      tasks: taskCount,
+    };
+  }
+
+  /**
+   * Create workflow content for an agent
+   */
+  createWorkflowContent(agent, content) {
+    // Create simple Windsurf frontmatter matching original format
+    let workflowContent = `---
+description: ${agent.name}
+auto_execution_mode: 3
+---
+
+${content}`;
+
+    return workflowContent;
+  }
+
+  /**
+   * Create workflow content for a task
+   */
+  createTaskWorkflowContent(task, content) {
+    // Create simple Windsurf frontmatter matching original format
+    let workflowContent = `---
+description: task-${task.name}
+auto_execution_mode: 2
+---
+
+${content}`;
+
+    return workflowContent;
+  }
+
+  /**
+   * Cleanup Windsurf configuration
+   */
+  async cleanup(projectDir) {
+    const fs = require('fs-extra');
+    const windsurfPath = path.join(projectDir, this.configDir, this.workflowsDir);
+
+    if (await fs.pathExists(windsurfPath)) {
+      // Only remove BMAD workflows, not all workflows
+      const files = await fs.readdir(windsurfPath);
+      let removed = 0;
+
+      for (const file of files) {
+        if (file.includes('-') && file.endsWith('.md')) {
+          const filePath = path.join(windsurfPath, file);
+          const content = await fs.readFile(filePath, 'utf8');
+
+          // Check if it's a BMAD workflow
+          if (content.includes('tags: [bmad')) {
+            await fs.remove(filePath);
+            removed++;
+          }
+        }
+      }
+
+      console.log(chalk.dim(`Removed ${removed} BMAD workflows from Windsurf`));
+    }
+  }
+}
+
+module.exports = { WindsurfSetup };

package/tools/cli/installers/lib/ide/workflow-command-generator.js

@@ -0,0 +1,162 @@
+const path = require('node:path');
+const fs = require('fs-extra');
+const csv = require('csv-parse/sync');
+const chalk = require('chalk');
+
+/**
+ * Generates Claude Code command files for each workflow in the manifest
+ */
+class WorkflowCommandGenerator {
+  constructor() {
+    this.templatePath = path.join(__dirname, 'workflow-command-template.md');
+  }
+
+  /**
+   * Generate workflow commands from the manifest CSV
+   * @param {string} projectDir - Project directory
+   * @param {string} bmadDir - BMAD installation directory
+   */
+  async generateWorkflowCommands(projectDir, bmadDir) {
+    const manifestPath = path.join(bmadDir, '_cfg', 'workflow-manifest.csv');
+
+    if (!(await fs.pathExists(manifestPath))) {
+      console.log(chalk.yellow('Workflow manifest not found. Skipping command generation.'));
+      return { generated: 0 };
+    }
+
+    // Read and parse the CSV manifest
+    const csvContent = await fs.readFile(manifestPath, 'utf8');
+    const workflows = csv.parse(csvContent, {
+      columns: true,
+      skip_empty_lines: true,
+    });
+
+    // Base commands directory
+    const baseCommandsDir = path.join(projectDir, '.claude', 'commands', 'bmad');
+
+    let generatedCount = 0;
+
+    // Generate a command file for each workflow, organized by module
+    for (const workflow of workflows) {
+      // Create module directory structure: commands/bmad/{module}/workflows/
+      const moduleWorkflowsDir = path.join(baseCommandsDir, workflow.module, 'workflows');
+      await fs.ensureDir(moduleWorkflowsDir);
+
+      // Use just the workflow name as filename (no prefix)
+      const commandContent = await this.generateCommandContent(workflow, bmadDir);
+      const commandPath = path.join(moduleWorkflowsDir, `${workflow.name}.md`);
+
+      await fs.writeFile(commandPath, commandContent);
+      generatedCount++;
+    }
+
+    // Also create a workflow launcher README in each module
+    await this.createModuleWorkflowLaunchers(baseCommandsDir, workflows, bmadDir);
+
+    return { generated: generatedCount };
+  }
+
+  /**
+   * Generate command content for a workflow
+   */
+  async generateCommandContent(workflow, bmadDir) {
+    // Load the template
+    const template = await fs.readFile(this.templatePath, 'utf8');
+
+    // Convert source path to installed path
+    // From: /Users/.../src/modules/bmm/workflows/.../workflow.yaml
+    // To: {project-root}/bmad/bmm/workflows/.../workflow.yaml
+    let workflowPath = workflow.path;
+
+    // Extract the relative path from source
+    if (workflowPath.includes('/src/modules/')) {
+      const match = workflowPath.match(/\/src\/modules\/(.+)/);
+      if (match) {
+        workflowPath = `{project-root}/bmad/${match[1]}`;
+      }
+    } else if (workflowPath.includes('/src/core/')) {
+      const match = workflowPath.match(/\/src\/core\/(.+)/);
+      if (match) {
+        workflowPath = `{project-root}/bmad/core/${match[1]}`;
+      }
+    }
+
+    // Replace template variables
+    return template
+      .replaceAll('{{name}}', workflow.name)
+      .replaceAll('{{module}}', workflow.module)
+      .replaceAll('{{description}}', workflow.description)
+      .replaceAll('{{workflow_path}}', workflowPath)
+      .replaceAll('{{interactive}}', workflow.interactive)
+      .replaceAll('{{author}}', workflow.author || 'BMAD');
+  }
+
+  /**
+   * Create workflow launcher files for each module
+   */
+  async createModuleWorkflowLaunchers(baseCommandsDir, workflows, bmadDir) {
+    // Group workflows by module
+    const workflowsByModule = {};
+    for (const workflow of workflows) {
+      if (!workflowsByModule[workflow.module]) {
+        workflowsByModule[workflow.module] = [];
+      }
+
+      // Convert path for display
+      let workflowPath = workflow.path;
+      if (workflowPath.includes('/src/modules/')) {
+        const match = workflowPath.match(/\/src\/modules\/(.+)/);
+        if (match) {
+          workflowPath = `{project-root}/bmad/${match[1]}`;
+        }
+      } else if (workflowPath.includes('/src/core/')) {
+        const match = workflowPath.match(/\/src\/core\/(.+)/);
+        if (match) {
+          workflowPath = `{project-root}/bmad/core/${match[1]}`;
+        }
+      }
+
+      workflowsByModule[workflow.module].push({
+        ...workflow,
+        displayPath: workflowPath,
+      });
+    }
+
+    // Create a launcher file for each module
+    for (const [module, moduleWorkflows] of Object.entries(workflowsByModule)) {
+      let content = `# ${module.toUpperCase()} Workflows
+
+## Available Workflows in ${module}
+
+`;
+
+      for (const workflow of moduleWorkflows) {
+        content += `**${workflow.name}**\n`;
+        content += `- Path: \`${workflow.displayPath}\`\n`;
+        content += `- ${workflow.description}\n\n`;
+      }
+
+      content += `
+## Execution
+
+When running any workflow:
+1. LOAD {project-root}/bmad/core/tasks/workflow.md
+2. Pass the workflow path as 'workflow-config' parameter
+3. Follow workflow.md instructions EXACTLY
+4. Save outputs after EACH section
+
+## Modes
+- Normal: Full interaction
+- #yolo: Skip optional steps
+`;
+
+      // Write module-specific launcher
+      const moduleWorkflowsDir = path.join(baseCommandsDir, module, 'workflows');
+      await fs.ensureDir(moduleWorkflowsDir);
+      const launcherPath = path.join(moduleWorkflowsDir, 'README.md');
+      await fs.writeFile(launcherPath, content);
+    }
+  }
+}
+
+module.exports = { WorkflowCommandGenerator };

package/tools/cli/installers/lib/ide/workflow-command-template.md

@@ -0,0 +1,11 @@
+# {{name}}
+
+IT IS CRITICAL THAT YOU FOLLOW THESE STEPS - while staying in character as the current agent persona you may have loaded:
+
+<steps CRITICAL="TRUE">
+1. Always LOAD the FULL {project-root}/bmad/core/tasks/workflow.md
+2. READ its entire contents - this is the CORE OS for EXECUTING the specific workflow-config {{workflow_path}}
+3. Pass the yaml path {{workflow_path}} as 'workflow-config' parameter to the workflow.md instructions
+4. Follow workflow.md instructions EXACTLY as written
+5. Save outputs after EACH section when generating any documents from templates
+</steps>