mirror of
https://github.com/bmadcode/BMAD-METHOD.git
synced 2025-12-17 17:55:34 +00:00
- Installation path is now fully configurable, allowing users to specify custom installation directories during setup
- Default installation location changed to .bmad (hidden directory) for cleaner project root organization
Web Bundle Improvements:
- All web bundles (single agent and team) now include party mode support for multi-agent collaboration!
- Advanced elicitation capabilities integrated into standalone agents
- All bundles enhanced with party mode agent manifests
- Added default-party.csv files to bmm, bmgd, and cis module teams
- The default party file is what will be used with single agent bundles. teams can customize for different party configurations before web bundling through a setting in the team yaml file
- New web bundle outputs for all agents (analyst, architect, dev, pm, sm, tea, tech-writer, ux-designer, game-*, creative-squad)
Phase 4 Workflow Updates (In Progress):
- Initiated shift to separate phase 4 implementation artifacts from documentation
- Phase 4 implementation artifacts (stories, code review, sprint plan, context files) will move to dedicated location outside docs folder
- Installer questions and configuration added for artifact path selection
- Updated workflow.yaml files for code-review, sprint-planning, story-context, epic-tech-context, and retrospective workflows to support this, but still might require some udpates
Additional Changes:
- New agent and action command header models for standardization
- Enhanced web-bundle-activation-steps fragment
- Updated web-bundler.js to support new structure
- VS Code settings updated for new .bmad directory
- Party mode instructions and workflow enhanced for better orchestration
IDE Installer Updates:
- Show version number of installer in cli
- improved Installer UX
- Gemini TOML Improved to have clear loading instructions with @ commands
- All tools agent launcher mds improved to use a central file template critical indication isntead of hardcoding in 2 different locations.
217 lines
7.5 KiB
JavaScript
217 lines
7.5 KiB
JavaScript
const path = require('node:path');
|
|
const fs = require('fs-extra');
|
|
const os = require('node:os');
|
|
const chalk = require('chalk');
|
|
const yaml = require('js-yaml');
|
|
const { BaseIdeSetup } = require('./_base-ide');
|
|
const { WorkflowCommandGenerator } = require('./shared/workflow-command-generator');
|
|
const { TaskToolCommandGenerator } = require('./shared/task-tool-command-generator');
|
|
|
|
const { getAgentsFromBmad } = require('./shared/bmad-artifacts');
|
|
|
|
/**
|
|
* OpenCode IDE setup handler
|
|
*/
|
|
class OpenCodeSetup extends BaseIdeSetup {
|
|
constructor() {
|
|
super('opencode', 'OpenCode', true); // Mark as preferred/recommended
|
|
this.configDir = '.opencode';
|
|
this.commandsDir = 'command';
|
|
this.agentsDir = 'agent';
|
|
}
|
|
|
|
async setup(projectDir, bmadDir, options = {}) {
|
|
console.log(chalk.cyan(`Setting up ${this.name}...`));
|
|
|
|
const baseDir = path.join(projectDir, this.configDir);
|
|
const commandsBaseDir = path.join(baseDir, this.commandsDir);
|
|
const agentsBaseDir = path.join(baseDir, this.agentsDir);
|
|
|
|
await this.ensureDir(commandsBaseDir);
|
|
await this.ensureDir(agentsBaseDir);
|
|
|
|
// Clean up any existing BMAD files before reinstalling
|
|
await this.cleanup(projectDir);
|
|
|
|
// Install primary agents with flat naming: bmad-agent-{module}-{name}.md
|
|
// OpenCode agents go in the agent folder (not command folder)
|
|
const agents = await getAgentsFromBmad(bmadDir, options.selectedModules || []);
|
|
|
|
let agentCount = 0;
|
|
for (const agent of agents) {
|
|
const processed = await this.readAndProcess(agent.path, {
|
|
module: agent.module,
|
|
name: agent.name,
|
|
});
|
|
|
|
const agentContent = await this.createAgentContent(processed, agent);
|
|
// Flat structure in agent folder: bmad-agent-{module}-{name}.md
|
|
const targetPath = path.join(agentsBaseDir, `bmad-agent-${agent.module}-${agent.name}.md`);
|
|
await this.writeFile(targetPath, agentContent);
|
|
agentCount++;
|
|
}
|
|
|
|
// Install workflow commands with flat naming: bmad-workflow-{module}-{name}.md
|
|
const workflowGenerator = new WorkflowCommandGenerator(this.bmadFolderName);
|
|
const { artifacts: workflowArtifacts, counts: workflowCounts } = await workflowGenerator.collectWorkflowArtifacts(bmadDir);
|
|
|
|
let workflowCommandCount = 0;
|
|
for (const artifact of workflowArtifacts) {
|
|
if (artifact.type === 'workflow-command') {
|
|
const commandContent = artifact.content;
|
|
// Flat structure: bmad-workflow-{module}-{name}.md
|
|
// artifact.relativePath is like: bmm/workflows/plan-project.md
|
|
const workflowName = path.basename(artifact.relativePath, '.md');
|
|
const targetPath = path.join(commandsBaseDir, `bmad-workflow-${artifact.module}-${workflowName}.md`);
|
|
await this.writeFile(targetPath, commandContent);
|
|
workflowCommandCount++;
|
|
}
|
|
// Skip workflow launcher READMEs as they're not needed in flat structure
|
|
}
|
|
|
|
// Install task and tool commands with flat naming
|
|
const { tasks, tools } = await this.generateFlatTaskToolCommands(bmadDir, commandsBaseDir);
|
|
|
|
console.log(chalk.green(`✓ ${this.name} configured:`));
|
|
console.log(chalk.dim(` - ${agentCount} agents installed to .opencode/agent/`));
|
|
if (workflowCommandCount > 0) {
|
|
console.log(chalk.dim(` - ${workflowCommandCount} workflows installed to .opencode/command/`));
|
|
}
|
|
if (tasks + tools > 0) {
|
|
console.log(chalk.dim(` - ${tasks + tools} tasks/tools installed to .opencode/command/ (${tasks} tasks, ${tools} tools)`));
|
|
}
|
|
|
|
return {
|
|
success: true,
|
|
agents: agentCount,
|
|
workflows: workflowCommandCount,
|
|
workflowCounts,
|
|
};
|
|
}
|
|
|
|
/**
|
|
* Generate flat task and tool commands for OpenCode
|
|
* OpenCode doesn't support nested command directories
|
|
*/
|
|
async generateFlatTaskToolCommands(bmadDir, commandsBaseDir) {
|
|
const taskToolGen = new TaskToolCommandGenerator();
|
|
const tasks = await taskToolGen.loadTaskManifest(bmadDir);
|
|
const tools = await taskToolGen.loadToolManifest(bmadDir);
|
|
|
|
// Filter to only standalone items
|
|
const standaloneTasks = tasks ? tasks.filter((t) => t.standalone === 'true' || t.standalone === true) : [];
|
|
const standaloneTools = tools ? tools.filter((t) => t.standalone === 'true' || t.standalone === true) : [];
|
|
|
|
// Generate command files for tasks with flat naming: bmad-task-{module}-{name}.md
|
|
for (const task of standaloneTasks) {
|
|
const commandContent = taskToolGen.generateCommandContent(task, 'task');
|
|
const targetPath = path.join(commandsBaseDir, `bmad-task-${task.module}-${task.name}.md`);
|
|
await this.writeFile(targetPath, commandContent);
|
|
}
|
|
|
|
// Generate command files for tools with flat naming: bmad-tool-{module}-{name}.md
|
|
for (const tool of standaloneTools) {
|
|
const commandContent = taskToolGen.generateCommandContent(tool, 'tool');
|
|
const targetPath = path.join(commandsBaseDir, `bmad-tool-${tool.module}-${tool.name}.md`);
|
|
await this.writeFile(targetPath, commandContent);
|
|
}
|
|
|
|
return {
|
|
tasks: standaloneTasks.length,
|
|
tools: standaloneTools.length,
|
|
};
|
|
}
|
|
|
|
async readAndProcess(filePath, metadata) {
|
|
const content = await fs.readFile(filePath, 'utf8');
|
|
return this.processContent(content, metadata);
|
|
}
|
|
|
|
async createAgentContent(content, metadata) {
|
|
const { frontmatter = {}, body } = this.parseFrontmatter(content);
|
|
|
|
frontmatter.description =
|
|
frontmatter.description && String(frontmatter.description).trim().length > 0
|
|
? frontmatter.description
|
|
: `BMAD ${metadata.module} agent: ${metadata.name}`;
|
|
|
|
// OpenCode agents use: 'primary' mode for main agents
|
|
frontmatter.mode = 'primary';
|
|
|
|
const frontmatterString = this.stringifyFrontmatter(frontmatter);
|
|
|
|
// Get the activation header from central template
|
|
const activationHeader = await this.getAgentCommandHeader();
|
|
|
|
return `${frontmatterString}\n\n${activationHeader}\n\n${body}`;
|
|
}
|
|
|
|
parseFrontmatter(content) {
|
|
const match = content.match(/^---\s*\n([\s\S]*?)\n---\s*\n?/);
|
|
if (!match) {
|
|
return { data: {}, body: content };
|
|
}
|
|
|
|
const body = content.slice(match[0].length);
|
|
|
|
let frontmatter = {};
|
|
try {
|
|
frontmatter = yaml.load(match[1]) || {};
|
|
} catch {
|
|
frontmatter = {};
|
|
}
|
|
|
|
return { frontmatter, body };
|
|
}
|
|
|
|
stringifyFrontmatter(frontmatter) {
|
|
const yamlText = yaml
|
|
.dump(frontmatter, {
|
|
indent: 2,
|
|
lineWidth: -1,
|
|
noRefs: true,
|
|
sortKeys: false,
|
|
})
|
|
.trimEnd();
|
|
|
|
return `---\n${yamlText}\n---`;
|
|
}
|
|
|
|
/**
|
|
* Cleanup OpenCode configuration - surgically remove only BMAD files
|
|
*/
|
|
async cleanup(projectDir) {
|
|
const agentsDir = path.join(projectDir, this.configDir, this.agentsDir);
|
|
const commandsDir = path.join(projectDir, this.configDir, this.commandsDir);
|
|
let removed = 0;
|
|
|
|
// Clean up agent folder
|
|
if (await fs.pathExists(agentsDir)) {
|
|
const files = await fs.readdir(agentsDir);
|
|
for (const file of files) {
|
|
if (file.startsWith('bmad-') && file.endsWith('.md')) {
|
|
await fs.remove(path.join(agentsDir, file));
|
|
removed++;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Clean up command folder
|
|
if (await fs.pathExists(commandsDir)) {
|
|
const files = await fs.readdir(commandsDir);
|
|
for (const file of files) {
|
|
if (file.startsWith('bmad-') && file.endsWith('.md')) {
|
|
await fs.remove(path.join(commandsDir, file));
|
|
removed++;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (removed > 0) {
|
|
console.log(chalk.dim(` Cleaned up ${removed} existing BMAD files`));
|
|
}
|
|
}
|
|
}
|
|
|
|
module.exports = { OpenCodeSetup };
|