bmad-fh 6.0.0-alpha.23

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

@@ -0,0 +1,300 @@
+const path = require('node:path');
+const fs = require('fs-extra');
+const { BaseIdeSetup } = require('./_base-ide');
+const chalk = require('chalk');
+const { AgentCommandGenerator } = require('./shared/agent-command-generator');
+const { WorkflowCommandGenerator } = require('./shared/workflow-command-generator');
+
+/**
+ * Crush IDE setup handler
+ * Creates commands in .crush/commands/ directory structure
+ */
+class CrushSetup extends BaseIdeSetup {
+  constructor() {
+    super('crush', 'Crush');
+    this.configDir = '.crush';
+    this.commandsDir = 'commands';
+  }
+
+  /**
+   * Setup Crush 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 .crush/commands/bmad directory structure
+    const crushDir = path.join(projectDir, this.configDir);
+    const commandsDir = path.join(crushDir, this.commandsDir, 'bmad');
+
+    await this.ensureDir(commandsDir);
+
+    // Generate agent launchers
+    const agentGen = new AgentCommandGenerator(this.bmadFolderName);
+    const { artifacts: agentArtifacts } = await agentGen.collectAgentArtifacts(bmadDir, options.selectedModules || []);
+
+    // Get tasks, tools, and workflows (ALL workflows now generate commands)
+    const tasks = await this.getTasks(bmadDir, true);
+    const tools = await this.getTools(bmadDir, true);
+
+    // Get ALL workflows using the new workflow command generator
+    const workflowGenerator = new WorkflowCommandGenerator(this.bmadFolderName);
+    const { artifacts: workflowArtifacts, counts: workflowCounts } = await workflowGenerator.collectWorkflowArtifacts(bmadDir);
+
+    // Convert workflow artifacts to expected format for organizeByModule
+    const workflows = workflowArtifacts
+      .filter((artifact) => artifact.type === 'workflow-command')
+      .map((artifact) => ({
+        module: artifact.module,
+        name: path.basename(artifact.relativePath, '.md'),
+        path: artifact.sourcePath,
+        content: artifact.content,
+      }));
+
+    // Organize by module
+    const agentCount = await this.organizeByModule(commandsDir, agentArtifacts, tasks, tools, workflows, projectDir);
+
+    console.log(chalk.green(`✓ ${this.name} configured:`));
+    console.log(chalk.dim(`  - ${agentCount.agents} agent commands created`));
+    console.log(chalk.dim(`  - ${agentCount.tasks} task commands created`));
+    console.log(chalk.dim(`  - ${agentCount.tools} tool commands created`));
+    console.log(chalk.dim(`  - ${agentCount.workflows} workflow commands created`));
+    console.log(chalk.dim(`  - Commands directory: ${path.relative(projectDir, commandsDir)}`));
+    console.log(chalk.dim('\n  Commands can be accessed via Crush command palette'));
+
+    return {
+      success: true,
+      ...agentCount,
+    };
+  }
+
+  /**
+   * Organize commands by module
+   */
+  async organizeByModule(commandsDir, agentArtifacts, tasks, tools, workflows, projectDir) {
+    // Get unique modules
+    const modules = new Set();
+    for (const artifact of agentArtifacts) modules.add(artifact.module);
+    for (const task of tasks) modules.add(task.module);
+    for (const tool of tools) modules.add(tool.module);
+    for (const workflow of workflows) modules.add(workflow.module);
+
+    let agentCount = 0;
+    let taskCount = 0;
+    let toolCount = 0;
+    let workflowCount = 0;
+
+    // Create module directories
+    for (const module of modules) {
+      const moduleDir = path.join(commandsDir, module);
+      const moduleAgentsDir = path.join(moduleDir, 'agents');
+      const moduleTasksDir = path.join(moduleDir, 'tasks');
+      const moduleToolsDir = path.join(moduleDir, 'tools');
+      const moduleWorkflowsDir = path.join(moduleDir, 'workflows');
+
+      await this.ensureDir(moduleAgentsDir);
+      await this.ensureDir(moduleTasksDir);
+      await this.ensureDir(moduleToolsDir);
+      await this.ensureDir(moduleWorkflowsDir);
+
+      // Write module-specific agent launchers
+      const moduleAgents = agentArtifacts.filter((a) => a.module === module);
+      for (const artifact of moduleAgents) {
+        const targetPath = path.join(moduleAgentsDir, `${artifact.name}.md`);
+        await this.writeFile(targetPath, artifact.content);
+        agentCount++;
+      }
+
+      // Copy module-specific tasks
+      const moduleTasks = tasks.filter((t) => t.module === module);
+      for (const task of moduleTasks) {
+        const content = await this.readFile(task.path);
+        const commandContent = this.createTaskCommand(task, content);
+        const targetPath = path.join(moduleTasksDir, `${task.name}.md`);
+        await this.writeFile(targetPath, commandContent);
+        taskCount++;
+      }
+
+      // Copy module-specific tools
+      const moduleTools = tools.filter((t) => t.module === module);
+      for (const tool of moduleTools) {
+        const content = await this.readFile(tool.path);
+        const commandContent = this.createToolCommand(tool, content);
+        const targetPath = path.join(moduleToolsDir, `${tool.name}.md`);
+        await this.writeFile(targetPath, commandContent);
+        toolCount++;
+      }
+
+      // Copy module-specific workflow commands (already generated)
+      const moduleWorkflows = workflows.filter((w) => w.module === module);
+      for (const workflow of moduleWorkflows) {
+        // Use the pre-generated workflow command content
+        const targetPath = path.join(moduleWorkflowsDir, `${workflow.name}.md`);
+        await this.writeFile(targetPath, workflow.content);
+        workflowCount++;
+      }
+    }
+
+    return {
+      agents: agentCount,
+      tasks: taskCount,
+      tools: toolCount,
+      workflows: workflowCount,
+    };
+  }
+
+  /**
+   * Create task command content
+   */
+  createTaskCommand(task, content) {
+    // Extract task name
+    const nameMatch = content.match(/name="([^"]+)"/);
+    const taskName = nameMatch ? nameMatch[1] : this.formatTitle(task.name);
+
+    let commandContent = `# /task-${task.name} Command
+
+When this command is used, execute the following task:
+
+## ${taskName} Task
+
+${content}
+
+## Command Usage
+
+This command executes the ${taskName} task from the BMAD ${task.module.toUpperCase()} module.
+
+## Module
+
+Part of the BMAD ${task.module.toUpperCase()} module.
+`;
+
+    return commandContent;
+  }
+
+  /**
+   * Create tool command content
+   */
+  createToolCommand(tool, content) {
+    // Extract tool name
+    const nameMatch = content.match(/name="([^"]+)"/);
+    const toolName = nameMatch ? nameMatch[1] : this.formatTitle(tool.name);
+
+    let commandContent = `# /tool-${tool.name} Command
+
+When this command is used, execute the following tool:
+
+## ${toolName} Tool
+
+${content}
+
+## Command Usage
+
+This command executes the ${toolName} tool from the BMAD ${tool.module.toUpperCase()} module.
+
+## Module
+
+Part of the BMAD ${tool.module.toUpperCase()} module.
+`;
+
+    return commandContent;
+  }
+
+  /**
+   * Create workflow command content
+   */
+  createWorkflowCommand(workflow, content) {
+    const workflowName = workflow.name ? this.formatTitle(workflow.name) : 'Workflow';
+
+    let commandContent = `# /${workflow.name} Command
+
+When this command is used, execute the following workflow:
+
+## ${workflowName} Workflow
+
+${content}
+
+## Command Usage
+
+This command executes the ${workflowName} workflow from the BMAD ${workflow.module.toUpperCase()} module.
+
+## Module
+
+Part of the BMAD ${workflow.module.toUpperCase()} module.
+`;
+
+    return commandContent;
+  }
+
+  /**
+   * Format name as title
+   */
+  formatTitle(name) {
+    return name
+      .split('-')
+      .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+      .join(' ');
+  }
+
+  /**
+   * Cleanup Crush configuration
+   */
+  async cleanup(projectDir) {
+    const fs = require('fs-extra');
+    const bmadCommandsDir = path.join(projectDir, this.configDir, this.commandsDir, 'bmad');
+
+    if (await fs.pathExists(bmadCommandsDir)) {
+      await fs.remove(bmadCommandsDir);
+      console.log(chalk.dim(`Removed BMAD commands from Crush`));
+    }
+  }
+
+  /**
+   * Install a custom agent launcher for Crush
+   * @param {string} projectDir - Project directory
+   * @param {string} agentName - Agent name (e.g., "fred-commit-poet")
+   * @param {string} agentPath - Path to compiled agent (relative to project root)
+   * @param {Object} metadata - Agent metadata
+   * @returns {Object} Installation result
+   */
+  async installCustomAgentLauncher(projectDir, agentName, agentPath, metadata) {
+    const crushDir = path.join(projectDir, this.configDir);
+    const bmadCommandsDir = path.join(crushDir, this.commandsDir, 'bmad');
+
+    // Create .crush/commands/bmad directory if it doesn't exist
+    await fs.ensureDir(bmadCommandsDir);
+
+    // Create custom agent launcher
+    const launcherContent = `# ${agentName} Custom Agent
+
+**⚠️ IMPORTANT**: Run @${agentPath} first to load the complete agent!
+
+This is a launcher for the custom BMAD agent "${agentName}".
+
+## Usage
+1. First run: \`${agentPath}\` to load the complete agent
+2. Then use this command to activate ${agentName}
+
+The agent will follow the persona and instructions from the main agent file.
+
+---
+
+*Generated by BMAD Method*`;
+
+    const fileName = `custom-${agentName.toLowerCase()}.md`;
+    const launcherPath = path.join(bmadCommandsDir, fileName);
+
+    // Write the launcher file
+    await fs.writeFile(launcherPath, launcherContent, 'utf8');
+
+    return {
+      ide: 'crush',
+      path: path.relative(projectDir, launcherPath),
+      command: agentName,
+      type: 'custom-agent-launcher',
+    };
+  }
+}
+
+module.exports = { CrushSetup };

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

@@ -0,0 +1,169 @@
+const path = require('node:path');
+const { BaseIdeSetup } = require('./_base-ide');
+const chalk = require('chalk');
+const { AgentCommandGenerator } = require('./shared/agent-command-generator');
+const { WorkflowCommandGenerator } = require('./shared/workflow-command-generator');
+const { TaskToolCommandGenerator } = require('./shared/task-tool-command-generator');
+
+/**
+ * Cursor IDE setup handler
+ */
+class CursorSetup extends BaseIdeSetup {
+  constructor() {
+    super('cursor', 'Cursor', true); // preferred IDE
+    this.configDir = '.cursor';
+    this.rulesDir = 'rules';
+    this.commandsDir = 'commands';
+  }
+
+  /**
+   * Cleanup old BMAD installation before reinstalling
+   * @param {string} projectDir - Project directory
+   */
+  async cleanup(projectDir) {
+    const fs = require('fs-extra');
+    const bmadRulesDir = path.join(projectDir, this.configDir, this.rulesDir, 'bmad');
+    const bmadCommandsDir = path.join(projectDir, this.configDir, this.commandsDir, 'bmad');
+
+    if (await fs.pathExists(bmadRulesDir)) {
+      await fs.remove(bmadRulesDir);
+      console.log(chalk.dim(`  Removed old BMAD rules from ${this.name}`));
+    }
+
+    if (await fs.pathExists(bmadCommandsDir)) {
+      await fs.remove(bmadCommandsDir);
+      console.log(chalk.dim(`  Removed old BMAD commands from ${this.name}`));
+    }
+  }
+
+  /**
+   * Setup Cursor 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}...`));
+
+    // Clean up old BMAD installation first
+    await this.cleanup(projectDir);
+
+    // Create .cursor/commands directory structure
+    const cursorDir = path.join(projectDir, this.configDir);
+    const commandsDir = path.join(cursorDir, this.commandsDir);
+    const bmadCommandsDir = path.join(commandsDir, 'bmad');
+
+    await this.ensureDir(bmadCommandsDir);
+
+    // Generate agent launchers using AgentCommandGenerator
+    // This creates small launcher files that reference the actual agents in _bmad/
+    const agentGen = new AgentCommandGenerator(this.bmadFolderName);
+    const { artifacts: agentArtifacts, counts: agentCounts } = await agentGen.collectAgentArtifacts(bmadDir, options.selectedModules || []);
+
+    // Create directories for each module
+    const modules = new Set();
+    for (const artifact of agentArtifacts) {
+      modules.add(artifact.module);
+    }
+
+    for (const module of modules) {
+      await this.ensureDir(path.join(bmadCommandsDir, module));
+      await this.ensureDir(path.join(bmadCommandsDir, module, 'agents'));
+    }
+
+    // Write agent launcher files
+    const agentCount = await agentGen.writeAgentLaunchers(bmadCommandsDir, agentArtifacts);
+
+    // Generate workflow commands from manifest (if it exists)
+    const workflowGen = new WorkflowCommandGenerator(this.bmadFolderName);
+    const { artifacts: workflowArtifacts } = await workflowGen.collectWorkflowArtifacts(bmadDir);
+
+    // Write only workflow-command artifacts, skip workflow-launcher READMEs
+    let workflowCommandCount = 0;
+    for (const artifact of workflowArtifacts) {
+      if (artifact.type === 'workflow-command') {
+        const moduleWorkflowsDir = path.join(bmadCommandsDir, artifact.module, 'workflows');
+        await this.ensureDir(moduleWorkflowsDir);
+        const commandPath = path.join(moduleWorkflowsDir, path.basename(artifact.relativePath));
+        await this.writeFile(commandPath, artifact.content);
+        workflowCommandCount++;
+      }
+      // Skip workflow-launcher READMEs as they would be treated as slash commands
+    }
+
+    // Generate task and tool commands from manifests (if they exist)
+    const taskToolGen = new TaskToolCommandGenerator();
+    const taskToolResult = await taskToolGen.generateTaskToolCommands(projectDir, bmadDir, bmadCommandsDir);
+
+    console.log(chalk.green(`✓ ${this.name} configured:`));
+    console.log(chalk.dim(`  - ${agentCount} agents installed`));
+    if (workflowCommandCount > 0) {
+      console.log(chalk.dim(`  - ${workflowCommandCount} workflow commands generated`));
+    }
+    if (taskToolResult.generated > 0) {
+      console.log(
+        chalk.dim(
+          `  - ${taskToolResult.generated} task/tool commands generated (${taskToolResult.tasks} tasks, ${taskToolResult.tools} tools)`,
+        ),
+      );
+    }
+    console.log(chalk.dim(`  - Commands directory: ${path.relative(projectDir, bmadCommandsDir)}`));
+
+    return {
+      success: true,
+      agents: agentCount,
+      tasks: taskToolResult.tasks || 0,
+      tools: taskToolResult.tools || 0,
+      workflows: workflowCommandCount,
+    };
+  }
+
+  /**
+   * Install a custom agent launcher for Cursor
+   * @param {string} projectDir - Project directory
+   * @param {string} agentName - Agent name (e.g., "fred-commit-poet")
+   * @param {string} agentPath - Path to compiled agent (relative to project root)
+   * @param {Object} metadata - Agent metadata
+   * @returns {Object|null} Info about created command
+   */
+  async installCustomAgentLauncher(projectDir, agentName, agentPath, metadata) {
+    const customAgentsDir = path.join(projectDir, this.configDir, this.commandsDir, 'bmad', 'custom', 'agents');
+
+    if (!(await this.exists(path.join(projectDir, this.configDir)))) {
+      return null; // IDE not configured for this project
+    }
+
+    await this.ensureDir(customAgentsDir);
+
+    const launcherContent = `You must fully embody this agent's persona and follow all activation instructions exactly as specified. NEVER break character until given an exit command.
+
+<agent-activation CRITICAL="TRUE">
+1. LOAD the FULL agent file from @${agentPath}
+2. READ its entire contents - this contains the complete agent persona, menu, and instructions
+3. FOLLOW every step in the <activation> section precisely
+4. DISPLAY the welcome/greeting as instructed
+5. PRESENT the numbered menu
+6. WAIT for user input before proceeding
+</agent-activation>
+`;
+
+    // Cursor uses YAML frontmatter matching Claude Code format
+    const commandContent = `---
+name: '${agentName}'
+description: '${agentName} agent'
+---
+
+${launcherContent}
+`;
+
+    const launcherPath = path.join(customAgentsDir, `${agentName}.md`);
+    await this.writeFile(launcherPath, commandContent);
+
+    return {
+      path: launcherPath,
+      command: `/bmad/custom/agents/${agentName}`,
+    };
+  }
+}
+
+module.exports = { CursorSetup };