bmad-method 5.1.3 → 6.0.0-Beta.0

package/tools/cli/installers/lib/ide/rovo-dev.js

@@ -0,0 +1,290 @@
+const path = require('node:path');
+const fs = require('fs-extra');
+const chalk = require('chalk');
+const { BaseIdeSetup } = require('./_base-ide');
+const { AgentCommandGenerator } = require('./shared/agent-command-generator');
+const { WorkflowCommandGenerator } = require('./shared/workflow-command-generator');
+const { TaskToolCommandGenerator } = require('./shared/task-tool-command-generator');
+
+/**
+ * Rovo Dev IDE setup handler
+ *
+ * Installs BMAD agents as Rovo Dev subagents in .rovodev/subagents/
+ * Installs workflows and tasks/tools as reference guides in .rovodev/
+ * Rovo Dev automatically discovers agents and integrates with BMAD like other IDEs
+ */
+class RovoDevSetup extends BaseIdeSetup {
+  constructor() {
+    super('rovo-dev', 'Atlassian Rovo Dev', false);
+    this.configDir = '.rovodev';
+    this.subagentsDir = 'subagents';
+    this.workflowsDir = 'workflows';
+    this.referencesDir = 'references';
+  }
+
+  /**
+   * Cleanup old BMAD installation before reinstalling
+   * @param {string} projectDir - Project directory
+   */
+  async cleanup(projectDir) {
+    const rovoDevDir = path.join(projectDir, this.configDir);
+
+    if (!(await fs.pathExists(rovoDevDir))) {
+      return;
+    }
+
+    // Clean BMAD agents from subagents directory
+    const subagentsDir = path.join(rovoDevDir, this.subagentsDir);
+    if (await fs.pathExists(subagentsDir)) {
+      const entries = await fs.readdir(subagentsDir);
+      const bmadFiles = entries.filter((file) => file.startsWith('bmad') && file.endsWith('.md'));
+
+      for (const file of bmadFiles) {
+        await fs.remove(path.join(subagentsDir, file));
+      }
+    }
+
+    // Clean BMAD workflows from workflows directory
+    const workflowsDir = path.join(rovoDevDir, this.workflowsDir);
+    if (await fs.pathExists(workflowsDir)) {
+      const entries = await fs.readdir(workflowsDir);
+      const bmadFiles = entries.filter((file) => file.startsWith('bmad') && file.endsWith('.md'));
+
+      for (const file of bmadFiles) {
+        await fs.remove(path.join(workflowsDir, file));
+      }
+    }
+
+    // Clean BMAD tasks/tools from references directory
+    const referencesDir = path.join(rovoDevDir, this.referencesDir);
+    if (await fs.pathExists(referencesDir)) {
+      const entries = await fs.readdir(referencesDir);
+      const bmadFiles = entries.filter((file) => file.startsWith('bmad') && file.endsWith('.md'));
+
+      for (const file of bmadFiles) {
+        await fs.remove(path.join(referencesDir, file));
+      }
+    }
+  }
+
+  /**
+   * Setup Rovo Dev 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 .rovodev directory structure
+    const rovoDevDir = path.join(projectDir, this.configDir);
+    const subagentsDir = path.join(rovoDevDir, this.subagentsDir);
+    const workflowsDir = path.join(rovoDevDir, this.workflowsDir);
+    const referencesDir = path.join(rovoDevDir, this.referencesDir);
+
+    await this.ensureDir(subagentsDir);
+    await this.ensureDir(workflowsDir);
+    await this.ensureDir(referencesDir);
+
+    // Generate and install agents
+    const agentGen = new AgentCommandGenerator(this.bmadFolderName);
+    const { artifacts: agentArtifacts } = await agentGen.collectAgentArtifacts(bmadDir, options.selectedModules || []);
+
+    let agentCount = 0;
+    for (const artifact of agentArtifacts) {
+      const subagentFilename = `bmad-${artifact.module}-${artifact.name}.md`;
+      const targetPath = path.join(subagentsDir, subagentFilename);
+      const subagentContent = this.convertToRovoDevSubagent(artifact.content, artifact.name, artifact.module);
+      await this.writeFile(targetPath, subagentContent);
+      agentCount++;
+    }
+
+    // Generate and install workflows
+    const workflowGen = new WorkflowCommandGenerator(this.bmadFolderName);
+    const { artifacts: workflowArtifacts, counts: workflowCounts } = await workflowGen.collectWorkflowArtifacts(bmadDir);
+
+    let workflowCount = 0;
+    for (const artifact of workflowArtifacts) {
+      if (artifact.type === 'workflow-command') {
+        const workflowFilename = path.basename(artifact.relativePath);
+        const targetPath = path.join(workflowsDir, workflowFilename);
+        await this.writeFile(targetPath, artifact.content);
+        workflowCount++;
+      }
+    }
+
+    // Generate and install tasks and tools
+    const taskToolGen = new TaskToolCommandGenerator();
+    const { tasks: taskCount, tools: toolCount } = await this.generateTaskToolReferences(bmadDir, referencesDir, taskToolGen);
+
+    // Summary output
+    console.log(chalk.green(`✓ ${this.name} configured:`));
+    console.log(chalk.dim(`  - ${agentCount} agents installed to .rovodev/subagents/`));
+    if (workflowCount > 0) {
+      console.log(chalk.dim(`  - ${workflowCount} workflows installed to .rovodev/workflows/`));
+    }
+    if (taskCount + toolCount > 0) {
+      console.log(
+        chalk.dim(`  - ${taskCount + toolCount} tasks/tools installed to .rovodev/references/ (${taskCount} tasks, ${toolCount} tools)`),
+      );
+    }
+    console.log(chalk.yellow(`\n  Note: Agents are automatically discovered by Rovo Dev`));
+    console.log(chalk.dim(`  - Access agents by typing @ in Rovo Dev to see available options`));
+    console.log(chalk.dim(`  - Workflows and references are available in .rovodev/ directory`));
+
+    return {
+      success: true,
+      agents: agentCount,
+      workflows: workflowCount,
+      tasks: taskCount,
+      tools: toolCount,
+    };
+  }
+
+  /**
+   * Generate task and tool reference guides
+   * @param {string} bmadDir - BMAD directory
+   * @param {string} referencesDir - References directory
+   * @param {TaskToolCommandGenerator} taskToolGen - Generator instance
+   */
+  async generateTaskToolReferences(bmadDir, referencesDir, taskToolGen) {
+    const tasks = await taskToolGen.loadTaskManifest(bmadDir);
+    const tools = await taskToolGen.loadToolManifest(bmadDir);
+
+    const standaloneTasks = tasks ? tasks.filter((t) => t.standalone === 'true' || t.standalone === true) : [];
+    const standaloneTools = tools ? tools.filter((t) => t.standalone === 'true' || t.standalone === true) : [];
+
+    let taskCount = 0;
+    for (const task of standaloneTasks) {
+      const commandContent = taskToolGen.generateCommandContent(task, 'task');
+      const targetPath = path.join(referencesDir, `bmad-task-${task.module}-${task.name}.md`);
+      await this.writeFile(targetPath, commandContent);
+      taskCount++;
+    }
+
+    let toolCount = 0;
+    for (const tool of standaloneTools) {
+      const commandContent = taskToolGen.generateCommandContent(tool, 'tool');
+      const targetPath = path.join(referencesDir, `bmad-tool-${tool.module}-${tool.name}.md`);
+      await this.writeFile(targetPath, commandContent);
+      toolCount++;
+    }
+
+    return { tasks: taskCount, tools: toolCount };
+  }
+
+  /**
+   * Convert BMAD agent launcher to Rovo Dev subagent format
+   *
+   * Rovo Dev subagents use Markdown files with YAML frontmatter containing:
+   * - name: Unique identifier for the subagent
+   * - description: One-line description of the subagent's purpose
+   * - tools: Array of tools the subagent can use (optional)
+   * - model: Specific model for this subagent (optional)
+   * - load_memory: Whether to load memory files (optional, defaults to true)
+   *
+   * @param {string} launcherContent - Original agent launcher content
+   * @param {string} agentName - Name of the agent
+   * @param {string} moduleName - Name of the module
+   * @returns {string} Rovo Dev subagent-formatted content
+   */
+  convertToRovoDevSubagent(launcherContent, agentName, moduleName) {
+    // Extract metadata from the launcher XML
+    const titleMatch = launcherContent.match(/title="([^"]+)"/);
+    const title = titleMatch ? titleMatch[1] : this.formatTitle(agentName);
+
+    const descriptionMatch = launcherContent.match(/description="([^"]+)"/);
+    const description = descriptionMatch ? descriptionMatch[1] : `BMAD agent: ${title}`;
+
+    const roleDefinitionMatch = launcherContent.match(/roleDefinition="([^"]+)"/);
+    const roleDefinition = roleDefinitionMatch ? roleDefinitionMatch[1] : `You are a specialized agent for ${title.toLowerCase()} tasks.`;
+
+    // Extract the main system prompt from the launcher (content after closing tags)
+    let systemPrompt = roleDefinition;
+
+    // Try to extract additional instructions from the launcher content
+    const instructionsMatch = launcherContent.match(/<instructions>([\s\S]*?)<\/instructions>/);
+    if (instructionsMatch) {
+      systemPrompt += '\n\n' + instructionsMatch[1].trim();
+    }
+
+    // Build YAML frontmatter for Rovo Dev subagent
+    const frontmatter = {
+      name: `bmad-${moduleName}-${agentName}`,
+      description: description,
+      // Note: tools and model can be added by users in their .rovodev/subagents/*.md files
+      // We don't enforce specific tools since BMAD agents are flexible
+    };
+
+    // Create YAML frontmatter string with proper quoting for special characters
+    let yamlContent = '---\n';
+    yamlContent += `name: ${frontmatter.name}\n`;
+    // Quote description to handle colons and other special characters in YAML
+    yamlContent += `description: "${frontmatter.description.replaceAll('"', String.raw`\"`)}"\n`;
+    yamlContent += '---\n';
+
+    // Combine frontmatter with system prompt
+    const subagentContent = yamlContent + systemPrompt;
+
+    return subagentContent;
+  }
+
+  /**
+   * Detect whether Rovo Dev is already configured in the project
+   * @param {string} projectDir - Project directory
+   * @returns {boolean}
+   */
+  async detect(projectDir) {
+    const rovoDevDir = path.join(projectDir, this.configDir);
+
+    if (!(await fs.pathExists(rovoDevDir))) {
+      return false;
+    }
+
+    // Check for BMAD agents in subagents directory
+    const subagentsDir = path.join(rovoDevDir, this.subagentsDir);
+    if (await fs.pathExists(subagentsDir)) {
+      try {
+        const entries = await fs.readdir(subagentsDir);
+        if (entries.some((entry) => entry.startsWith('bmad') && entry.endsWith('.md'))) {
+          return true;
+        }
+      } catch {
+        // Continue checking other directories
+      }
+    }
+
+    // Check for BMAD workflows in workflows directory
+    const workflowsDir = path.join(rovoDevDir, this.workflowsDir);
+    if (await fs.pathExists(workflowsDir)) {
+      try {
+        const entries = await fs.readdir(workflowsDir);
+        if (entries.some((entry) => entry.startsWith('bmad') && entry.endsWith('.md'))) {
+          return true;
+        }
+      } catch {
+        // Continue checking other directories
+      }
+    }
+
+    // Check for BMAD tasks/tools in references directory
+    const referencesDir = path.join(rovoDevDir, this.referencesDir);
+    if (await fs.pathExists(referencesDir)) {
+      try {
+        const entries = await fs.readdir(referencesDir);
+        if (entries.some((entry) => entry.startsWith('bmad') && entry.endsWith('.md'))) {
+          return true;
+        }
+      } catch {
+        // Continue
+      }
+    }
+
+    return false;
+  }
+}
+
+module.exports = { RovoDevSetup };

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

@@ -0,0 +1,165 @@
+const path = require('node:path');
+const fs = require('fs-extra');
+const chalk = require('chalk');
+const { toColonPath, toDashPath, customAgentColonName, customAgentDashName } = require('./path-utils');
+
+/**
+ * Generates launcher command files for each agent
+ * Similar to WorkflowCommandGenerator but for agents
+ */
+class AgentCommandGenerator {
+  constructor(bmadFolderName = 'bmad') {
+    this.templatePath = path.join(__dirname, '../templates/agent-command-template.md');
+    this.bmadFolderName = bmadFolderName;
+  }
+
+  /**
+   * Collect agent artifacts for IDE installation
+   * @param {string} bmadDir - BMAD installation directory
+   * @param {Array} selectedModules - Modules to include
+   * @returns {Object} Artifacts array with metadata
+   */
+  async collectAgentArtifacts(bmadDir, selectedModules = []) {
+    const { getAgentsFromBmad } = require('./bmad-artifacts');
+
+    // Get agents from INSTALLED bmad/ directory
+    const agents = await getAgentsFromBmad(bmadDir, selectedModules);
+
+    const artifacts = [];
+
+    for (const agent of agents) {
+      const launcherContent = await this.generateLauncherContent(agent);
+      // Use relativePath if available (for nested agents), otherwise just name with .md
+      const agentPathInModule = agent.relativePath || `${agent.name}.md`;
+      artifacts.push({
+        type: 'agent-launcher',
+        module: agent.module,
+        name: agent.name,
+        relativePath: path.join(agent.module, 'agents', agentPathInModule),
+        content: launcherContent,
+        sourcePath: agent.path,
+      });
+    }
+
+    return {
+      artifacts,
+      counts: {
+        agents: agents.length,
+      },
+    };
+  }
+
+  /**
+   * Generate launcher content for an agent
+   * @param {Object} agent - Agent metadata
+   * @returns {string} Launcher file content
+   */
+  async generateLauncherContent(agent) {
+    // Load the template
+    const template = await fs.readFile(this.templatePath, 'utf8');
+
+    // Replace template variables
+    // Use relativePath if available (for nested agents), otherwise just name with .md
+    const agentPathInModule = agent.relativePath || `${agent.name}.md`;
+    return template
+      .replaceAll('{{name}}', agent.name)
+      .replaceAll('{{module}}', agent.module)
+      .replaceAll('{{path}}', agentPathInModule)
+      .replaceAll('{{description}}', agent.description || `${agent.name} agent`)
+      .replaceAll('_bmad', this.bmadFolderName)
+      .replaceAll('_bmad', '_bmad');
+  }
+
+  /**
+   * Write agent launcher artifacts to IDE commands directory
+   * @param {string} baseCommandsDir - Base commands directory for the IDE
+   * @param {Array} artifacts - Agent launcher artifacts
+   * @returns {number} Count of launchers written
+   */
+  async writeAgentLaunchers(baseCommandsDir, artifacts) {
+    let writtenCount = 0;
+
+    for (const artifact of artifacts) {
+      if (artifact.type === 'agent-launcher') {
+        const moduleAgentsDir = path.join(baseCommandsDir, artifact.module, 'agents');
+        await fs.ensureDir(moduleAgentsDir);
+
+        const launcherPath = path.join(moduleAgentsDir, `${artifact.name}.md`);
+        await fs.writeFile(launcherPath, artifact.content);
+        writtenCount++;
+      }
+    }
+
+    return writtenCount;
+  }
+
+  /**
+   * Write agent launcher artifacts using underscore format (Windows-compatible)
+   * Creates flat files like: bmad_bmm_pm.md
+   *
+   * @param {string} baseCommandsDir - Base commands directory for the IDE
+   * @param {Array} artifacts - Agent launcher artifacts
+   * @returns {number} Count of launchers written
+   */
+  async writeColonArtifacts(baseCommandsDir, artifacts) {
+    let writtenCount = 0;
+
+    for (const artifact of artifacts) {
+      if (artifact.type === 'agent-launcher') {
+        // Convert relativePath to underscore format: bmm/agents/pm.md → bmad_bmm_pm.md
+        const flatName = toColonPath(artifact.relativePath);
+        const launcherPath = path.join(baseCommandsDir, flatName);
+        await fs.ensureDir(path.dirname(launcherPath));
+        await fs.writeFile(launcherPath, artifact.content);
+        writtenCount++;
+      }
+    }
+
+    return writtenCount;
+  }
+
+  /**
+   * Write agent launcher artifacts using underscore format (Windows-compatible)
+   * Creates flat files like: bmad_bmm_pm.md
+   *
+   * @param {string} baseCommandsDir - Base commands directory for the IDE
+   * @param {Array} artifacts - Agent launcher artifacts
+   * @returns {number} Count of launchers written
+   */
+  async writeDashArtifacts(baseCommandsDir, artifacts) {
+    let writtenCount = 0;
+
+    for (const artifact of artifacts) {
+      if (artifact.type === 'agent-launcher') {
+        // Convert relativePath to underscore format: bmm/agents/pm.md → bmad_bmm_pm.md
+        const flatName = toDashPath(artifact.relativePath);
+        const launcherPath = path.join(baseCommandsDir, flatName);
+        await fs.ensureDir(path.dirname(launcherPath));
+        await fs.writeFile(launcherPath, artifact.content);
+        writtenCount++;
+      }
+    }
+
+    return writtenCount;
+  }
+
+  /**
+   * Get the custom agent name in underscore format (Windows-compatible)
+   * @param {string} agentName - Custom agent name
+   * @returns {string} Underscore-formatted filename
+   */
+  getCustomAgentColonName(agentName) {
+    return customAgentColonName(agentName);
+  }
+
+  /**
+   * Get the custom agent name in underscore format (Windows-compatible)
+   * @param {string} agentName - Custom agent name
+   * @returns {string} Underscore-formatted filename
+   */
+  getCustomAgentDashName(agentName) {
+    return customAgentDashName(agentName);
+  }
+}
+
+module.exports = { AgentCommandGenerator };

package/tools/cli/installers/lib/ide/shared/bmad-artifacts.js

@@ -0,0 +1,158 @@
+const path = require('node:path');
+const fs = require('fs-extra');
+
+/**
+ * Helpers for gathering BMAD agents/tasks from the installed tree.
+ * Shared by installers that need Claude-style exports.
+ */
+async function getAgentsFromBmad(bmadDir, selectedModules = []) {
+  const agents = [];
+
+  // Get core agents
+  if (await fs.pathExists(path.join(bmadDir, 'core', 'agents'))) {
+    const coreAgents = await getAgentsFromDir(path.join(bmadDir, 'core', 'agents'), 'core');
+    agents.push(...coreAgents);
+  }
+
+  // Get module agents
+  for (const moduleName of selectedModules) {
+    const agentsPath = path.join(bmadDir, moduleName, 'agents');
+
+    if (await fs.pathExists(agentsPath)) {
+      const moduleAgents = await getAgentsFromDir(agentsPath, moduleName);
+      agents.push(...moduleAgents);
+    }
+  }
+
+  // Get standalone agents from bmad/agents/ directory
+  const standaloneAgentsDir = path.join(bmadDir, 'agents');
+  if (await fs.pathExists(standaloneAgentsDir)) {
+    const agentDirs = await fs.readdir(standaloneAgentsDir, { withFileTypes: true });
+
+    for (const agentDir of agentDirs) {
+      if (!agentDir.isDirectory()) continue;
+
+      const agentDirPath = path.join(standaloneAgentsDir, agentDir.name);
+      const agentFiles = await fs.readdir(agentDirPath);
+
+      for (const file of agentFiles) {
+        if (!file.endsWith('.md')) continue;
+        if (file.includes('.customize.')) continue;
+
+        const filePath = path.join(agentDirPath, file);
+        const content = await fs.readFile(filePath, 'utf8');
+
+        if (content.includes('localskip="true"')) continue;
+
+        agents.push({
+          path: filePath,
+          name: file.replace('.md', ''),
+          module: 'standalone', // Mark as standalone agent
+        });
+      }
+    }
+  }
+
+  return agents;
+}
+
+async function getTasksFromBmad(bmadDir, selectedModules = []) {
+  const tasks = [];
+
+  if (await fs.pathExists(path.join(bmadDir, 'core', 'tasks'))) {
+    const coreTasks = await getTasksFromDir(path.join(bmadDir, 'core', 'tasks'), 'core');
+    tasks.push(...coreTasks);
+  }
+
+  for (const moduleName of selectedModules) {
+    const tasksPath = path.join(bmadDir, moduleName, 'tasks');
+
+    if (await fs.pathExists(tasksPath)) {
+      const moduleTasks = await getTasksFromDir(tasksPath, moduleName);
+      tasks.push(...moduleTasks);
+    }
+  }
+
+  return tasks;
+}
+
+async function getAgentsFromDir(dirPath, moduleName, relativePath = '') {
+  const agents = [];
+
+  if (!(await fs.pathExists(dirPath))) {
+    return agents;
+  }
+
+  const entries = await fs.readdir(dirPath, { withFileTypes: true });
+
+  for (const entry of entries) {
+    const fullPath = path.join(dirPath, entry.name);
+    const newRelativePath = relativePath ? `${relativePath}/${entry.name}` : entry.name;
+
+    if (entry.isDirectory()) {
+      // Recurse into subdirectories
+      const subDirAgents = await getAgentsFromDir(fullPath, moduleName, newRelativePath);
+      agents.push(...subDirAgents);
+    } else if (entry.name.endsWith('.md')) {
+      // Skip README files and other non-agent files
+      if (entry.name.toLowerCase() === 'readme.md' || entry.name.toLowerCase().startsWith('readme-')) {
+        continue;
+      }
+
+      if (entry.name.includes('.customize.')) {
+        continue;
+      }
+
+      const content = await fs.readFile(fullPath, 'utf8');
+
+      if (content.includes('localskip="true"')) {
+        continue;
+      }
+
+      // Only include files that have agent-specific content (compiled agents have <agent> tag)
+      if (!content.includes('<agent')) {
+        continue;
+      }
+
+      agents.push({
+        path: fullPath,
+        name: entry.name.replace('.md', ''),
+        module: moduleName,
+        relativePath: newRelativePath, // Keep the .md extension for the full path
+      });
+    }
+  }
+
+  return agents;
+}
+
+async function getTasksFromDir(dirPath, moduleName) {
+  const tasks = [];
+
+  if (!(await fs.pathExists(dirPath))) {
+    return tasks;
+  }
+
+  const files = await fs.readdir(dirPath);
+
+  for (const file of files) {
+    if (!file.endsWith('.md')) {
+      continue;
+    }
+
+    tasks.push({
+      path: path.join(dirPath, file),
+      name: file.replace('.md', ''),
+      module: moduleName,
+    });
+  }
+
+  return tasks;
+}
+
+module.exports = {
+  getAgentsFromBmad,
+  getTasksFromBmad,
+  getAgentsFromDir,
+  getTasksFromDir,
+};