bmad-method 6.0.0-alpha.9 → 6.0.2

package/tools/cli/installers/lib/ide/platform-codes.js

@@ -0,0 +1,100 @@
+const fs = require('fs-extra');
+const path = require('node:path');
+const yaml = require('yaml');
+
+const PLATFORM_CODES_PATH = path.join(__dirname, 'platform-codes.yaml');
+
+let _cachedPlatformCodes = null;
+
+/**
+ * Load the platform codes configuration from YAML
+ * @returns {Object} Platform codes configuration
+ */
+async function loadPlatformCodes() {
+  if (_cachedPlatformCodes) {
+    return _cachedPlatformCodes;
+  }
+
+  if (!(await fs.pathExists(PLATFORM_CODES_PATH))) {
+    throw new Error(`Platform codes configuration not found at: ${PLATFORM_CODES_PATH}`);
+  }
+
+  const content = await fs.readFile(PLATFORM_CODES_PATH, 'utf8');
+  _cachedPlatformCodes = yaml.parse(content);
+  return _cachedPlatformCodes;
+}
+
+/**
+ * Get platform information by code
+ * @param {string} platformCode - Platform code (e.g., 'claude-code', 'cursor')
+ * @returns {Object|null} Platform info or null if not found
+ */
+function getPlatformInfo(platformCode) {
+  if (!_cachedPlatformCodes) {
+    throw new Error('Platform codes not loaded. Call loadPlatformCodes() first.');
+  }
+
+  return _cachedPlatformCodes.platforms[platformCode] || null;
+}
+
+/**
+ * Get all preferred platforms
+ * @returns {Promise<Array>} Array of preferred platform codes
+ */
+async function getPreferredPlatforms() {
+  const config = await loadPlatformCodes();
+  return Object.entries(config.platforms)
+    .filter(([_, info]) => info.preferred)
+    .map(([code, _]) => code);
+}
+
+/**
+ * Get all platform codes by category
+ * @param {string} category - Category to filter by (ide, cli, tool, etc.)
+ * @returns {Promise<Array>} Array of platform codes in the category
+ */
+async function getPlatformsByCategory(category) {
+  const config = await loadPlatformCodes();
+  return Object.entries(config.platforms)
+    .filter(([_, info]) => info.category === category)
+    .map(([code, _]) => code);
+}
+
+/**
+ * Get all platforms with installer config
+ * @returns {Promise<Array>} Array of platform codes that have installer config
+ */
+async function getConfigDrivenPlatforms() {
+  const config = await loadPlatformCodes();
+  return Object.entries(config.platforms)
+    .filter(([_, info]) => info.installer)
+    .map(([code, _]) => code);
+}
+
+/**
+ * Get platforms that use custom installers (no installer config)
+ * @returns {Promise<Array>} Array of platform codes with custom installers
+ */
+async function getCustomInstallerPlatforms() {
+  const config = await loadPlatformCodes();
+  return Object.entries(config.platforms)
+    .filter(([_, info]) => !info.installer)
+    .map(([code, _]) => code);
+}
+
+/**
+ * Clear the cached platform codes (useful for testing)
+ */
+function clearCache() {
+  _cachedPlatformCodes = null;
+}
+
+module.exports = {
+  loadPlatformCodes,
+  getPlatformInfo,
+  getPreferredPlatforms,
+  getPlatformsByCategory,
+  getConfigDrivenPlatforms,
+  getCustomInstallerPlatforms,
+  clearCache,
+};

package/tools/cli/installers/lib/ide/platform-codes.yaml

@@ -0,0 +1,234 @@
+# BMAD Platform Codes Configuration
+# Central configuration for all platform/IDE codes used in the BMAD system
+#
+# This file defines:
+# 1. Platform metadata (name, preferred status, category, description)
+# 2. Installer configuration (target directories, templates, artifact types)
+#
+# Format:
+#   code: Platform identifier used internally
+#   name: Display name shown to users
+#   preferred: Whether this platform is shown as a recommended option on install
+#   category: Type of platform (ide, cli, tool, service)
+#   description: Brief description of the platform
+#   installer: Installation configuration (optional - omit for custom installers)
+
+platforms:
+  antigravity:
+    name: "Google Antigravity"
+    preferred: false
+    category: ide
+    description: "Google's AI development environment"
+    installer:
+      target_dir: .agent/workflows
+      template_type: antigravity
+
+  auggie:
+    name: "Auggie"
+    preferred: false
+    category: cli
+    description: "AI development tool"
+    installer:
+      target_dir: .augment/commands
+      template_type: default
+
+  claude-code:
+    name: "Claude Code"
+    preferred: true
+    category: cli
+    description: "Anthropic's official CLI for Claude"
+    installer:
+      target_dir: .claude/commands
+      template_type: default
+
+  cline:
+    name: "Cline"
+    preferred: false
+    category: ide
+    description: "AI coding assistant"
+    installer:
+      target_dir: .clinerules/workflows
+      template_type: windsurf
+
+  codex:
+    name: "Codex"
+    preferred: false
+    category: cli
+    description: "OpenAI Codex integration"
+    # No installer config - uses custom codex.js
+
+  codebuddy:
+    name: "CodeBuddy"
+    preferred: false
+    category: ide
+    description: "Tencent Cloud Code Assistant - AI-powered coding companion"
+    installer:
+      target_dir: .codebuddy/commands
+      template_type: default
+
+  crush:
+    name: "Crush"
+    preferred: false
+    category: ide
+    description: "AI development assistant"
+    installer:
+      target_dir: .crush/commands
+      template_type: default
+
+  cursor:
+    name: "Cursor"
+    preferred: true
+    category: ide
+    description: "AI-first code editor"
+    installer:
+      target_dir: .cursor/commands
+      template_type: default
+
+  gemini:
+    name: "Gemini CLI"
+    preferred: false
+    category: cli
+    description: "Google's CLI for Gemini"
+    installer:
+      target_dir: .gemini/commands
+      template_type: gemini
+
+  github-copilot:
+    name: "GitHub Copilot"
+    preferred: false
+    category: ide
+    description: "GitHub's AI pair programmer"
+    # No installer config - uses custom github-copilot.js
+
+  iflow:
+    name: "iFlow"
+    preferred: false
+    category: ide
+    description: "AI workflow automation"
+    installer:
+      target_dir: .iflow/commands
+      template_type: default
+
+  kilo:
+    name: "KiloCoder"
+    preferred: false
+    category: ide
+    description: "AI coding platform"
+    # No installer config - uses custom kilo.js (creates .kilocodemodes file)
+
+  kiro:
+    name: "Kiro"
+    preferred: false
+    category: ide
+    description: "Amazon's AI-powered IDE"
+    installer:
+      target_dir: .kiro/steering
+      template_type: kiro
+
+  opencode:
+    name: "OpenCode"
+    preferred: false
+    category: ide
+    description: "OpenCode terminal coding assistant"
+    installer:
+      targets:
+        - target_dir: .opencode/agent
+          template_type: opencode
+          artifact_types: [agents]
+        - target_dir: .opencode/command
+          template_type: opencode
+          artifact_types: [workflows, tasks, tools]
+
+  qwen:
+    name: "QwenCoder"
+    preferred: false
+    category: ide
+    description: "Qwen AI coding assistant"
+    installer:
+      target_dir: .qwen/commands
+      template_type: default
+
+  roo:
+    name: "Roo Cline"
+    preferred: false
+    category: ide
+    description: "Enhanced Cline fork"
+    installer:
+      target_dir: .roo/commands
+      template_type: default
+
+  rovo-dev:
+    name: "Rovo Dev"
+    preferred: false
+    category: ide
+    description: "Atlassian's Rovo development environment"
+    # No installer config - uses custom rovodev.js (generates prompts.yml manifest)
+
+  trae:
+    name: "Trae"
+    preferred: false
+    category: ide
+    description: "AI coding tool"
+    installer:
+      target_dir: .trae/rules
+      template_type: trae
+
+  windsurf:
+    name: "Windsurf"
+    preferred: false
+    category: ide
+    description: "AI-powered IDE with cascade flows"
+    installer:
+      target_dir: .windsurf/workflows
+      template_type: windsurf
+
+# ============================================================================
+# Installer Config Schema
+# ============================================================================
+#
+# installer:
+#   target_dir: string                    # Directory where artifacts are installed
+#   template_type: string                 # Default template type to use
+#   header_template: string (optional)    # Override for header/frontmatter template
+#   body_template: string (optional)      # Override for body/content template
+#   targets: array (optional)             # For multi-target installations
+#     - target_dir: string
+#       template_type: string
+#       artifact_types: [agents, workflows, tasks, tools]
+#   artifact_types: array (optional)      # Filter which artifacts to install (default: all)
+#   skip_existing: boolean (optional)     # Skip files that already exist (default: false)
+
+# ============================================================================
+# Platform Categories
+# ============================================================================
+
+categories:
+  ide:
+    name: "Integrated Development Environment"
+    description: "Full-featured code editors with AI assistance"
+
+  cli:
+    name: "Command Line Interface"
+    description: "Terminal-based tools"
+
+  tool:
+    name: "Development Tool"
+    description: "Standalone development utilities"
+
+  service:
+    name: "Cloud Service"
+    description: "Cloud-based development platforms"
+
+  extension:
+    name: "Editor Extension"
+    description: "Plugins for existing editors"
+
+# ============================================================================
+# Naming Conventions and Rules
+# ============================================================================
+
+conventions:
+  code_format: "lowercase-kebab-case"
+  name_format: "Title Case"
+  max_code_length: 20
+  allowed_characters: "a-z0-9-"

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

@@ -0,0 +1,257 @@
+const path = require('node:path');
+const fs = require('fs-extra');
+const yaml = require('yaml');
+const { BaseIdeSetup } = require('./_base-ide');
+const prompts = require('../../../lib/prompts');
+const { AgentCommandGenerator } = require('./shared/agent-command-generator');
+const { WorkflowCommandGenerator } = require('./shared/workflow-command-generator');
+const { TaskToolCommandGenerator } = require('./shared/task-tool-command-generator');
+const { toDashPath } = require('./shared/path-utils');
+
+/**
+ * Rovo Dev IDE setup handler
+ *
+ * Custom installer that writes .md workflow files to .rovodev/workflows/
+ * and generates .rovodev/prompts.yml to register them with Rovo Dev's /prompts feature.
+ *
+ * prompts.yml format (per Rovo Dev docs):
+ *   prompts:
+ *     - name: bmad-bmm-create-prd
+ *       description: "PRD workflow..."
+ *       content_file: workflows/bmad-bmm-create-prd.md
+ */
+class RovoDevSetup extends BaseIdeSetup {
+  constructor() {
+    super('rovo-dev', 'Rovo Dev', false);
+    this.rovoDir = '.rovodev';
+    this.workflowsDir = 'workflows';
+    this.promptsFile = 'prompts.yml';
+  }
+
+  /**
+   * Setup Rovo Dev configuration
+   * @param {string} projectDir - Project directory
+   * @param {string} bmadDir - BMAD installation directory
+   * @param {Object} options - Setup options
+   * @returns {Promise<Object>} Setup result with { success, results: { agents, workflows, tasks, tools } }
+   */
+  async setup(projectDir, bmadDir, options = {}) {
+    if (!options.silent) await prompts.log.info(`Setting up ${this.name}...`);
+
+    // Clean up any old BMAD installation first
+    await this.cleanup(projectDir, options);
+
+    const workflowsPath = path.join(projectDir, this.rovoDir, this.workflowsDir);
+    await this.ensureDir(workflowsPath);
+
+    const selectedModules = options.selectedModules || [];
+    const writtenFiles = [];
+
+    // Generate and write agent launchers
+    const agentGen = new AgentCommandGenerator(this.bmadFolderName);
+    const { artifacts: agentArtifacts } = await agentGen.collectAgentArtifacts(bmadDir, selectedModules);
+    const agentCount = await agentGen.writeDashArtifacts(workflowsPath, agentArtifacts);
+    this._collectPromptEntries(writtenFiles, agentArtifacts, ['agent-launcher'], 'agent');
+
+    // Generate and write workflow commands
+    const workflowGen = new WorkflowCommandGenerator(this.bmadFolderName);
+    const { artifacts: workflowArtifacts } = await workflowGen.collectWorkflowArtifacts(bmadDir);
+    const workflowCount = await workflowGen.writeDashArtifacts(workflowsPath, workflowArtifacts);
+    this._collectPromptEntries(writtenFiles, workflowArtifacts, ['workflow-command'], 'workflow');
+
+    // Generate and write task/tool commands
+    const taskToolGen = new TaskToolCommandGenerator(this.bmadFolderName);
+    const { artifacts: taskToolArtifacts, counts: taskToolCounts } = await taskToolGen.collectTaskToolArtifacts(bmadDir);
+    await taskToolGen.writeDashArtifacts(workflowsPath, taskToolArtifacts);
+    const taskCount = taskToolCounts.tasks || 0;
+    const toolCount = taskToolCounts.tools || 0;
+    this._collectPromptEntries(writtenFiles, taskToolArtifacts, ['task', 'tool']);
+
+    // Generate prompts.yml manifest (only if we have entries to write)
+    if (writtenFiles.length > 0) {
+      await this.generatePromptsYml(projectDir, writtenFiles);
+    }
+
+    if (!options.silent) {
+      await prompts.log.success(
+        `${this.name} configured: ${agentCount} agents, ${workflowCount} workflows, ${taskCount} tasks, ${toolCount} tools`,
+      );
+    }
+
+    return {
+      success: true,
+      results: {
+        agents: agentCount,
+        workflows: workflowCount,
+        tasks: taskCount,
+        tools: toolCount,
+      },
+    };
+  }
+
+  /**
+   * Collect prompt entries from artifacts into writtenFiles array
+   * @param {Array} writtenFiles - Target array to push entries into
+   * @param {Array} artifacts - Artifacts from a generator's collect method
+   * @param {string[]} acceptedTypes - Artifact types to include (e.g., ['agent-launcher'])
+   * @param {string} [fallbackSuffix] - Suffix for fallback description; defaults to artifact.type
+   */
+  _collectPromptEntries(writtenFiles, artifacts, acceptedTypes, fallbackSuffix) {
+    for (const artifact of artifacts) {
+      if (!acceptedTypes.includes(artifact.type)) continue;
+      const flatName = toDashPath(artifact.relativePath);
+      writtenFiles.push({
+        name: path.basename(flatName, '.md'),
+        description: artifact.description || `${artifact.name} ${fallbackSuffix || artifact.type}`,
+        contentFile: `${this.workflowsDir}/${flatName}`,
+      });
+    }
+  }
+
+  /**
+   * Generate .rovodev/prompts.yml manifest
+   * Merges with existing user entries -- strips entries with names starting 'bmad-',
+   * appends new BMAD entries, and writes back.
+   *
+   * @param {string} projectDir - Project directory
+   * @param {Array<Object>} writtenFiles - Array of { name, description, contentFile }
+   */
+  async generatePromptsYml(projectDir, writtenFiles) {
+    const promptsPath = path.join(projectDir, this.rovoDir, this.promptsFile);
+    let existingPrompts = [];
+
+    // Read existing prompts.yml and preserve non-BMAD entries
+    if (await this.pathExists(promptsPath)) {
+      try {
+        const content = await this.readFile(promptsPath);
+        const parsed = yaml.parse(content);
+        if (parsed && Array.isArray(parsed.prompts)) {
+          // Keep only non-BMAD entries (entries whose name does NOT start with bmad-)
+          existingPrompts = parsed.prompts.filter((entry) => !entry.name || !entry.name.startsWith('bmad-'));
+        }
+      } catch {
+        // If parsing fails, start fresh but preserve file safety
+        existingPrompts = [];
+      }
+    }
+
+    // Build new BMAD entries (prefix description with name so /prompts list is scannable)
+    const bmadEntries = writtenFiles.map((file) => ({
+      name: file.name,
+      description: `${file.name} - ${file.description}`,
+      content_file: file.contentFile,
+    }));
+
+    // Merge: user entries first, then BMAD entries
+    const allPrompts = [...existingPrompts, ...bmadEntries];
+
+    const config = { prompts: allPrompts };
+    const yamlContent = yaml.stringify(config, { lineWidth: 0 });
+    await this.writeFile(promptsPath, yamlContent);
+  }
+
+  /**
+   * Cleanup Rovo Dev configuration
+   * Removes bmad-* files from .rovodev/workflows/ and strips BMAD entries from prompts.yml
+   * @param {string} projectDir - Project directory
+   * @param {Object} options - Cleanup options
+   */
+  async cleanup(projectDir, options = {}) {
+    const workflowsPath = path.join(projectDir, this.rovoDir, this.workflowsDir);
+
+    // Remove all bmad-* entries from workflows dir (aligned with detect() predicate)
+    if (await this.pathExists(workflowsPath)) {
+      const entries = await fs.readdir(workflowsPath);
+      for (const entry of entries) {
+        if (entry.startsWith('bmad-')) {
+          await fs.remove(path.join(workflowsPath, entry));
+        }
+      }
+    }
+
+    // Clean BMAD entries from prompts.yml (preserve user entries)
+    const promptsPath = path.join(projectDir, this.rovoDir, this.promptsFile);
+    if (await this.pathExists(promptsPath)) {
+      try {
+        const content = await this.readFile(promptsPath);
+        const parsed = yaml.parse(content) || {};
+
+        if (Array.isArray(parsed.prompts)) {
+          const originalCount = parsed.prompts.length;
+          parsed.prompts = parsed.prompts.filter((entry) => !entry.name || !entry.name.startsWith('bmad-'));
+          const removedCount = originalCount - parsed.prompts.length;
+
+          if (removedCount > 0) {
+            if (parsed.prompts.length === 0) {
+              // If no entries remain, remove the file entirely
+              await fs.remove(promptsPath);
+            } else {
+              await this.writeFile(promptsPath, yaml.stringify(parsed, { lineWidth: 0 }));
+            }
+            if (!options.silent) {
+              await prompts.log.message(`Removed ${removedCount} BMAD entries from ${this.promptsFile}`);
+            }
+          }
+        }
+      } catch {
+        // If parsing fails, leave file as-is
+        if (!options.silent) {
+          await prompts.log.warn(`Warning: Could not parse ${this.promptsFile} for cleanup`);
+        }
+      }
+    }
+
+    // Remove empty .rovodev directories
+    if (await this.pathExists(workflowsPath)) {
+      const remaining = await fs.readdir(workflowsPath);
+      if (remaining.length === 0) {
+        await fs.remove(workflowsPath);
+      }
+    }
+
+    const rovoDirPath = path.join(projectDir, this.rovoDir);
+    if (await this.pathExists(rovoDirPath)) {
+      const remaining = await fs.readdir(rovoDirPath);
+      if (remaining.length === 0) {
+        await fs.remove(rovoDirPath);
+      }
+    }
+  }
+
+  /**
+   * Detect whether Rovo Dev configuration exists in the project
+   * Checks for .rovodev/ dir with bmad files or bmad entries in prompts.yml
+   * @param {string} projectDir - Project directory
+   * @returns {boolean}
+   */
+  async detect(projectDir) {
+    const workflowsPath = path.join(projectDir, this.rovoDir, this.workflowsDir);
+
+    // Check for bmad files in workflows dir
+    if (await fs.pathExists(workflowsPath)) {
+      const entries = await fs.readdir(workflowsPath);
+      if (entries.some((entry) => entry.startsWith('bmad-'))) {
+        return true;
+      }
+    }
+
+    // Check for bmad entries in prompts.yml
+    const promptsPath = path.join(projectDir, this.rovoDir, this.promptsFile);
+    if (await fs.pathExists(promptsPath)) {
+      try {
+        const content = await fs.readFile(promptsPath, 'utf8');
+        const parsed = yaml.parse(content);
+        if (parsed && Array.isArray(parsed.prompts)) {
+          return parsed.prompts.some((entry) => entry.name && entry.name.startsWith('bmad-'));
+        }
+      } catch {
+        // If parsing fails, check raw content
+        return false;
+      }
+    }
+
+    return false;
+  }
+}
+
+module.exports = { RovoDevSetup };