Compare commits

...

10 Commits

Author SHA1 Message Date
Curtis Ide 9cfb97b41a
Merge caff2fb815 into 2d134314c9 2026-02-15 09:24:16 -07:00
Curtis Ide caff2fb815
fix: custom-content quick-update ENOENT, pass --custom-content through, add PR#1624 improvements to allow update installs to work using non-interactive mode 2026-02-15 09:24:08 -07:00
Curtis Ide 589f65a654
From PR #1624: added empty module.yaml handling (skip + warn) and removed paths from the config to match promptCustomContentSource() 2026-02-15 09:24:07 -07:00
Curtis Ide 2ab713de36
Merge branch 'main' into main 2026-02-15 08:58:04 -07:00
Davor Racic 2d134314c9
feat(cli): add uninstall command with selective component removal (#1650)
* feat(cli): add uninstall command with selective component removal

Add `bmad uninstall` CLI command for clean removal of BMAD installations.
Interactive mode with directory router and component multiselect; non-interactive
`--yes` flag preserves user artifacts by default. Three-phase spinner UX,
manifest-scoped IDE cleanup, GitHub Copilot marker stripping, recursive empty
directory cleanup, and chalk-to-clack migration in copilot handler.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* fix(cli): address code review findings for uninstall command

- Add path traversal guard in uninstallOutputFolder (resolve + startsWith)
- Thread silent flag through to cleanupCopilotInstructions
- Trim text input before path.resolve in directory prompt
- DRY uninstall() by delegating to extracted helper methods
- Validate projectDir existence before probing for BMAD
- Use fs.rmdir instead of fs.remove in removeEmptyParents (race safety)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

* feat(cli): add destructive action warning and confirm before uninstall

Move warning box after component selection and add a confirmation prompt
defaulting to No, so users see the irreversibility warning right before
the point of no return. Non-interactive --yes mode skips both.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: Brian <bmadcode@gmail.com>
2026-02-15 08:13:03 -06:00
Ankit Gupta a5e2b1c63a
docs: fix changelog URL in installer start message (#1660)
Co-authored-by: Ankit Gupta <ankit.gupta@intercom.io>
2026-02-15 07:59:11 -06:00
Curtis Ide 3c2d14b215
Merge branch 'bmad-code-org:main' into main 2026-02-14 10:06:17 -07:00
Curtis Ide e2f702a7d0
fix manager.js 2026-02-14 10:05:05 -07:00
Curtis Ide a89aef674d
Merge branch 'main' of github.com:bmad-code-org/BMAD-METHOD 2026-02-14 09:26:17 -07:00
Curtis Ide e3d672d561
fix custom install bug 2026-02-14 09:22:24 -07:00
9 changed files with 624 additions and 108 deletions

View File

@ -25,6 +25,7 @@
}, },
"scripts": { "scripts": {
"bmad:install": "node tools/cli/bmad-cli.js install", "bmad:install": "node tools/cli/bmad-cli.js install",
"bmad:uninstall": "node tools/cli/bmad-cli.js uninstall",
"docs:build": "node tools/build-docs.mjs", "docs:build": "node tools/build-docs.mjs",
"docs:dev": "astro dev --root website", "docs:dev": "astro dev --root website",
"docs:fix-links": "node tools/fix-doc-links.js", "docs:fix-links": "node tools/fix-doc-links.js",

View File

@ -0,0 +1,167 @@
const path = require('node:path');
const fs = require('fs-extra');
const prompts = require('../lib/prompts');
const { Installer } = require('../installers/lib/core/installer');
const installer = new Installer();
module.exports = {
command: 'uninstall',
description: 'Remove BMAD installation from the current project',
options: [
['-y, --yes', 'Remove all BMAD components without prompting (preserves user artifacts)'],
['--directory <path>', 'Project directory (default: current directory)'],
],
action: async (options) => {
try {
let projectDir;
if (options.directory) {
// Explicit --directory flag takes precedence
projectDir = path.resolve(options.directory);
} else if (options.yes) {
// Non-interactive mode: use current directory
projectDir = process.cwd();
} else {
// Interactive: ask user which directory to uninstall from
// select() handles cancellation internally (exits process)
const dirChoice = await prompts.select({
message: 'Where do you want to uninstall BMAD from?',
choices: [
{ value: 'cwd', name: `Current directory (${process.cwd()})` },
{ value: 'other', name: 'Another directory...' },
],
});
if (dirChoice === 'other') {
// text() handles cancellation internally (exits process)
const customDir = await prompts.text({
message: 'Enter the project directory path:',
placeholder: process.cwd(),
validate: (value) => {
if (!value || value.trim().length === 0) return 'Directory path is required';
},
});
projectDir = path.resolve(customDir.trim());
} else {
projectDir = process.cwd();
}
}
if (!(await fs.pathExists(projectDir))) {
await prompts.log.error(`Directory does not exist: ${projectDir}`);
process.exit(1);
}
const { bmadDir } = await installer.findBmadDir(projectDir);
if (!(await fs.pathExists(bmadDir))) {
await prompts.log.warn('No BMAD installation found.');
process.exit(0);
}
const existingInstall = await installer.getStatus(projectDir);
const version = existingInstall.version || 'unknown';
const modules = (existingInstall.modules || []).map((m) => m.id || m.name).join(', ');
const ides = (existingInstall.ides || []).join(', ');
const outputFolder = await installer.getOutputFolder(projectDir);
await prompts.intro('BMAD Uninstall');
await prompts.note(`Version: ${version}\nModules: ${modules}\nIDE integrations: ${ides}`, 'Current Installation');
let removeModules = true;
let removeIdeConfigs = true;
let removeOutputFolder = false;
if (!options.yes) {
// multiselect() handles cancellation internally (exits process)
const selected = await prompts.multiselect({
message: 'Select components to remove:',
options: [
{
value: 'modules',
label: `BMAD Modules & data (${installer.bmadFolderName}/)`,
hint: 'Core installation, agents, workflows, config',
},
{ value: 'ide', label: 'IDE integrations', hint: ides || 'No IDEs configured' },
{ value: 'output', label: `User artifacts (${outputFolder}/)`, hint: 'WARNING: Contains your work products' },
],
initialValues: ['modules', 'ide'],
required: true,
});
removeModules = selected.includes('modules');
removeIdeConfigs = selected.includes('ide');
removeOutputFolder = selected.includes('output');
const red = (s) => `\u001B[31m${s}\u001B[0m`;
await prompts.note(
red('💀 This action is IRREVERSIBLE! Removed files cannot be recovered!') +
'\n' +
red('💀 IDE configurations and modules will need to be reinstalled.') +
'\n' +
red('💀 User artifacts are preserved unless explicitly selected.'),
'!! DESTRUCTIVE ACTION !!',
);
const confirmed = await prompts.confirm({
message: 'Proceed with uninstall?',
default: false,
});
if (!confirmed) {
await prompts.outro('Uninstall cancelled.');
process.exit(0);
}
}
// Phase 1: IDE integrations
if (removeIdeConfigs) {
const s = await prompts.spinner();
s.start('Removing IDE integrations...');
await installer.uninstallIdeConfigs(projectDir, existingInstall, { silent: true });
s.stop(`Removed IDE integrations (${ides || 'none'})`);
}
// Phase 2: User artifacts
if (removeOutputFolder) {
const s = await prompts.spinner();
s.start(`Removing user artifacts (${outputFolder}/)...`);
await installer.uninstallOutputFolder(projectDir, outputFolder);
s.stop('User artifacts removed');
}
// Phase 3: BMAD modules & data (last — other phases may need _bmad/)
if (removeModules) {
const s = await prompts.spinner();
s.start(`Removing BMAD modules & data (${installer.bmadFolderName}/)...`);
await installer.uninstallModules(projectDir);
s.stop('Modules & data removed');
}
const summary = [];
if (removeIdeConfigs) summary.push('IDE integrations cleaned');
if (removeModules) summary.push('Modules & data removed');
if (removeOutputFolder) summary.push('User artifacts removed');
if (!removeOutputFolder) summary.push(`User artifacts preserved in ${outputFolder}/`);
await prompts.note(summary.join('\n'), 'Summary');
await prompts.outro('To reinstall, run: npx bmad-method install');
process.exit(0);
} catch (error) {
try {
const errorMessage = error instanceof Error ? error.message : String(error);
await prompts.log.error(`Uninstall failed: ${errorMessage}`);
if (error instanceof Error && error.stack) {
await prompts.log.message(error.stack);
}
} catch {
console.error(error instanceof Error ? error.message : error);
}
process.exit(1);
}
},
};

View File

@ -34,7 +34,7 @@ startMessage: |
- Subscribe on YouTube: https://www.youtube.com/@BMadCode - Subscribe on YouTube: https://www.youtube.com/@BMadCode
- Every star & sub helps us reach more developers! - Every star & sub helps us reach more developers!
Latest updates: https://github.com/bmad-code-org/BMAD-METHOD/CHANGELOG.md Latest updates: https://github.com/bmad-code-org/BMAD-METHOD/blob/main/CHANGELOG.md
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

View File

@ -527,8 +527,13 @@ class Installer {
const cachedModules = await fs.readdir(cacheDir, { withFileTypes: true }); const cachedModules = await fs.readdir(cacheDir, { withFileTypes: true });
for (const cachedModule of cachedModules) { for (const cachedModule of cachedModules) {
if (cachedModule.isDirectory()) {
const moduleId = cachedModule.name; const moduleId = cachedModule.name;
const cachedPath = path.join(cacheDir, moduleId);
// Skip if path doesn't exist (broken symlink, deleted dir) - avoids lstat ENOENT
if (!(await fs.pathExists(cachedPath)) || !cachedModule.isDirectory()) {
continue;
}
// Skip if we already have this module from manifest // Skip if we already have this module from manifest
if (customModulePaths.has(moduleId)) { if (customModulePaths.has(moduleId)) {
@ -542,15 +547,12 @@ class Installer {
continue; continue;
} }
const cachedPath = path.join(cacheDir, moduleId);
// Check if this is actually a custom module (has module.yaml) // Check if this is actually a custom module (has module.yaml)
const moduleYamlPath = path.join(cachedPath, 'module.yaml'); const moduleYamlPath = path.join(cachedPath, 'module.yaml');
if (await fs.pathExists(moduleYamlPath)) { if (await fs.pathExists(moduleYamlPath)) {
customModulePaths.set(moduleId, cachedPath); customModulePaths.set(moduleId, cachedPath);
} }
} }
}
// Update module manager with the new custom module paths from cache // Update module manager with the new custom module paths from cache
this.moduleManager.setCustomModulePaths(customModulePaths); this.moduleManager.setCustomModulePaths(customModulePaths);
@ -609,8 +611,13 @@ class Installer {
const cachedModules = await fs.readdir(cacheDir, { withFileTypes: true }); const cachedModules = await fs.readdir(cacheDir, { withFileTypes: true });
for (const cachedModule of cachedModules) { for (const cachedModule of cachedModules) {
if (cachedModule.isDirectory()) {
const moduleId = cachedModule.name; const moduleId = cachedModule.name;
const cachedPath = path.join(cacheDir, moduleId);
// Skip if path doesn't exist (broken symlink, deleted dir) - avoids lstat ENOENT
if (!(await fs.pathExists(cachedPath)) || !cachedModule.isDirectory()) {
continue;
}
// Skip if we already have this module from manifest // Skip if we already have this module from manifest
if (customModulePaths.has(moduleId)) { if (customModulePaths.has(moduleId)) {
@ -624,15 +631,12 @@ class Installer {
continue; continue;
} }
const cachedPath = path.join(cacheDir, moduleId);
// Check if this is actually a custom module (has module.yaml) // Check if this is actually a custom module (has module.yaml)
const moduleYamlPath = path.join(cachedPath, 'module.yaml'); const moduleYamlPath = path.join(cachedPath, 'module.yaml');
if (await fs.pathExists(moduleYamlPath)) { if (await fs.pathExists(moduleYamlPath)) {
customModulePaths.set(moduleId, cachedPath); customModulePaths.set(moduleId, cachedPath);
} }
} }
}
// Update module manager with the new custom module paths from cache // Update module manager with the new custom module paths from cache
this.moduleManager.setCustomModulePaths(customModulePaths); this.moduleManager.setCustomModulePaths(customModulePaths);
@ -949,12 +953,11 @@ class Installer {
if (!isCustomModule && config._customModuleSources && config._customModuleSources.has(moduleName)) { if (!isCustomModule && config._customModuleSources && config._customModuleSources.has(moduleName)) {
customInfo = config._customModuleSources.get(moduleName); customInfo = config._customModuleSources.get(moduleName);
isCustomModule = true; isCustomModule = true;
if ( if (customInfo.sourcePath && !customInfo.path) {
customInfo.sourcePath && customInfo.path = path.isAbsolute(customInfo.sourcePath)
(customInfo.sourcePath.startsWith('_config') || customInfo.sourcePath.includes('_config/custom')) && ? customInfo.sourcePath
!customInfo.path : path.join(bmadDir, customInfo.sourcePath);
) }
customInfo.path = customInfo.sourcePath;
} }
// Finally check regular custom content // Finally check regular custom content
@ -1528,20 +1531,157 @@ class Installer {
} }
/** /**
* Uninstall BMAD * Uninstall BMAD with selective removal options
* @param {string} directory - Project directory
* @param {Object} options - Uninstall options
* @param {boolean} [options.removeModules=true] - Remove _bmad/ directory
* @param {boolean} [options.removeIdeConfigs=true] - Remove IDE configurations
* @param {boolean} [options.removeOutputFolder=false] - Remove user artifacts output folder
* @returns {Object} Result with success status and removed components
*/ */
async uninstall(directory) { async uninstall(directory, options = {}) {
const projectDir = path.resolve(directory); const projectDir = path.resolve(directory);
const { bmadDir } = await this.findBmadDir(projectDir); const { bmadDir } = await this.findBmadDir(projectDir);
if (await fs.pathExists(bmadDir)) { if (!(await fs.pathExists(bmadDir))) {
await fs.remove(bmadDir); return { success: false, reason: 'not-installed' };
} }
// Clean up IDE configurations // 1. DETECT: Read state BEFORE deleting anything
await this.ideManager.cleanup(projectDir); const existingInstall = await this.detector.detect(bmadDir);
const outputFolder = await this._readOutputFolder(bmadDir);
return { success: true }; const removed = { modules: false, ideConfigs: false, outputFolder: false };
// 2. IDE CLEANUP (before _bmad/ deletion so configs are accessible)
if (options.removeIdeConfigs !== false) {
await this.uninstallIdeConfigs(projectDir, existingInstall, { silent: options.silent });
removed.ideConfigs = true;
}
// 3. OUTPUT FOLDER (only if explicitly requested)
if (options.removeOutputFolder === true && outputFolder) {
removed.outputFolder = await this.uninstallOutputFolder(projectDir, outputFolder);
}
// 4. BMAD DIRECTORY (last, after everything that needs it)
if (options.removeModules !== false) {
removed.modules = await this.uninstallModules(projectDir);
}
return { success: true, removed, version: existingInstall.version };
}
/**
* Uninstall IDE configurations only
* @param {string} projectDir - Project directory
* @param {Object} existingInstall - Detection result from detector.detect()
* @param {Object} [options] - Options (e.g. { silent: true })
* @returns {Promise<Object>} Results from IDE cleanup
*/
async uninstallIdeConfigs(projectDir, existingInstall, options = {}) {
await this.ideManager.ensureInitialized();
const cleanupOptions = { isUninstall: true, silent: options.silent };
const ideList = existingInstall.ides || [];
if (ideList.length > 0) {
return this.ideManager.cleanupByList(projectDir, ideList, cleanupOptions);
}
return this.ideManager.cleanup(projectDir, cleanupOptions);
}
/**
* Remove user artifacts output folder
* @param {string} projectDir - Project directory
* @param {string} outputFolder - Output folder name (relative)
* @returns {Promise<boolean>} Whether the folder was removed
*/
async uninstallOutputFolder(projectDir, outputFolder) {
if (!outputFolder) return false;
const resolvedProject = path.resolve(projectDir);
const outputPath = path.resolve(resolvedProject, outputFolder);
if (!outputPath.startsWith(resolvedProject + path.sep)) {
return false;
}
if (await fs.pathExists(outputPath)) {
await fs.remove(outputPath);
return true;
}
return false;
}
/**
* Remove the _bmad/ directory
* @param {string} projectDir - Project directory
* @returns {Promise<boolean>} Whether the directory was removed
*/
async uninstallModules(projectDir) {
const { bmadDir } = await this.findBmadDir(projectDir);
if (await fs.pathExists(bmadDir)) {
await fs.remove(bmadDir);
return true;
}
return false;
}
/**
* Get the configured output folder name for a project
* Resolves bmadDir internally from projectDir
* @param {string} projectDir - Project directory
* @returns {string} Output folder name (relative, default: '_bmad-output')
*/
async getOutputFolder(projectDir) {
const { bmadDir } = await this.findBmadDir(projectDir);
return this._readOutputFolder(bmadDir);
}
/**
* Read the output_folder setting from module config files
* Checks bmm/config.yaml first, then other module configs
* @param {string} bmadDir - BMAD installation directory
* @returns {string} Output folder path or default
*/
async _readOutputFolder(bmadDir) {
const yaml = require('yaml');
// Check bmm/config.yaml first (most common)
const bmmConfigPath = path.join(bmadDir, 'bmm', 'config.yaml');
if (await fs.pathExists(bmmConfigPath)) {
try {
const content = await fs.readFile(bmmConfigPath, 'utf8');
const config = yaml.parse(content);
if (config && config.output_folder) {
// Strip {project-root}/ prefix if present
return config.output_folder.replace(/^\{project-root\}[/\\]/, '');
}
} catch {
// Fall through to other modules
}
}
// Scan other module config.yaml files
try {
const entries = await fs.readdir(bmadDir, { withFileTypes: true });
for (const entry of entries) {
if (!entry.isDirectory() || entry.name === 'bmm' || entry.name.startsWith('_')) continue;
const configPath = path.join(bmadDir, entry.name, 'config.yaml');
if (await fs.pathExists(configPath)) {
try {
const content = await fs.readFile(configPath, 'utf8');
const config = yaml.parse(content);
if (config && config.output_folder) {
return config.output_folder.replace(/^\{project-root\}[/\\]/, '');
}
} catch {
// Continue scanning
}
}
}
} catch {
// Directory scan failed
}
// Default fallback
return '_bmad-output';
} }
/** /**
@ -2236,15 +2376,35 @@ class Installer {
const configuredIdes = existingInstall.ides || []; const configuredIdes = existingInstall.ides || [];
const projectRoot = path.dirname(bmadDir); const projectRoot = path.dirname(bmadDir);
// Get custom module sources from cache // Get custom module sources: first from --custom-content (re-cache from source), then from cache
const customModuleSources = new Map(); const customModuleSources = new Map();
if (config.customContent?.sources?.length > 0) {
for (const source of config.customContent.sources) {
if (source.id && source.path && (await fs.pathExists(source.path))) {
customModuleSources.set(source.id, {
id: source.id,
name: source.name || source.id,
sourcePath: source.path,
cached: false, // From CLI, will be re-cached
});
}
}
}
const cacheDir = path.join(bmadDir, '_config', 'custom'); const cacheDir = path.join(bmadDir, '_config', 'custom');
if (await fs.pathExists(cacheDir)) { if (await fs.pathExists(cacheDir)) {
const cachedModules = await fs.readdir(cacheDir, { withFileTypes: true }); const cachedModules = await fs.readdir(cacheDir, { withFileTypes: true });
for (const cachedModule of cachedModules) { for (const cachedModule of cachedModules) {
if (cachedModule.isDirectory()) {
const moduleId = cachedModule.name; const moduleId = cachedModule.name;
const cachedPath = path.join(cacheDir, moduleId);
// Skip if path doesn't exist (broken symlink, deleted dir) - avoids lstat ENOENT
if (!(await fs.pathExists(cachedPath))) {
continue;
}
if (!cachedModule.isDirectory()) {
continue;
}
// Skip if we already have this module from manifest // Skip if we already have this module from manifest
if (customModuleSources.has(moduleId)) { if (customModuleSources.has(moduleId)) {
@ -2258,8 +2418,6 @@ class Installer {
continue; continue;
} }
const cachedPath = path.join(cacheDir, moduleId);
// Check if this is actually a custom module (has module.yaml) // Check if this is actually a custom module (has module.yaml)
const moduleYamlPath = path.join(cachedPath, 'module.yaml'); const moduleYamlPath = path.join(cachedPath, 'module.yaml');
if (await fs.pathExists(moduleYamlPath)) { if (await fs.pathExists(moduleYamlPath)) {
@ -2273,7 +2431,6 @@ class Installer {
} }
} }
} }
}
// Load saved IDE configurations // Load saved IDE configurations
const savedIdeConfigs = await this.ideConfigManager.loadAllIdeConfigs(bmadDir); const savedIdeConfigs = await this.ideConfigManager.loadAllIdeConfigs(bmadDir);
@ -2407,6 +2564,7 @@ class Installer {
_savedIdeConfigs: savedIdeConfigs, // Pass saved IDE configs to installer _savedIdeConfigs: savedIdeConfigs, // Pass saved IDE configs to installer
_customModuleSources: customModuleSources, // Pass custom module sources for updates _customModuleSources: customModuleSources, // Pass custom module sources for updates
_existingModules: installedModules, // Pass all installed modules for manifest generation _existingModules: installedModules, // Pass all installed modules for manifest generation
customContent: config.customContent, // Pass through for re-caching from source
}; };
// Call the standard install method // Call the standard install method

View File

@ -456,8 +456,18 @@ LOAD and execute from: {project-root}/{{bmadFolderName}}/{{path}}
async cleanup(projectDir, options = {}) { async cleanup(projectDir, options = {}) {
// Clean all target directories // Clean all target directories
if (this.installerConfig?.targets) { if (this.installerConfig?.targets) {
const parentDirs = new Set();
for (const target of this.installerConfig.targets) { for (const target of this.installerConfig.targets) {
await this.cleanupTarget(projectDir, target.target_dir, options); await this.cleanupTarget(projectDir, target.target_dir, options);
// Track parent directories for empty-dir cleanup
const parentDir = path.dirname(target.target_dir);
if (parentDir && parentDir !== '.') {
parentDirs.add(parentDir);
}
}
// After all targets cleaned, remove empty parent directories (recursive up to projectDir)
for (const parentDir of parentDirs) {
await this.removeEmptyParents(projectDir, parentDir);
} }
} else if (this.installerConfig?.target_dir) { } else if (this.installerConfig?.target_dir) {
await this.cleanupTarget(projectDir, this.installerConfig.target_dir, options); await this.cleanupTarget(projectDir, this.installerConfig.target_dir, options);
@ -509,6 +519,41 @@ LOAD and execute from: {project-root}/{{bmadFolderName}}/{{path}}
if (removedCount > 0 && !options.silent) { if (removedCount > 0 && !options.silent) {
await prompts.log.message(` Cleaned ${removedCount} BMAD files from ${targetDir}`); await prompts.log.message(` Cleaned ${removedCount} BMAD files from ${targetDir}`);
} }
// Remove empty directory after cleanup
if (removedCount > 0) {
try {
const remaining = await fs.readdir(targetPath);
if (remaining.length === 0) {
await fs.remove(targetPath);
}
} catch {
// Directory may already be gone or in use — skip
}
}
}
/**
* Recursively remove empty directories walking up from dir toward projectDir
* Stops at projectDir boundary never removes projectDir itself
* @param {string} projectDir - Project root (boundary)
* @param {string} relativeDir - Relative directory to start from
*/
async removeEmptyParents(projectDir, relativeDir) {
let current = relativeDir;
let last = null;
while (current && current !== '.' && current !== last) {
last = current;
const fullPath = path.join(projectDir, current);
try {
if (!(await fs.pathExists(fullPath))) break;
const remaining = await fs.readdir(fullPath);
if (remaining.length > 0) break;
await fs.rmdir(fullPath);
} catch {
break;
}
current = path.dirname(current);
}
} }
} }

View File

@ -1,6 +1,6 @@
const path = require('node:path'); const path = require('node:path');
const { BaseIdeSetup } = require('./_base-ide'); const { BaseIdeSetup } = require('./_base-ide');
const chalk = require('chalk'); const prompts = require('../../../lib/prompts');
const { AgentCommandGenerator } = require('./shared/agent-command-generator'); const { AgentCommandGenerator } = require('./shared/agent-command-generator');
const { BMAD_FOLDER_NAME, toDashPath } = require('./shared/path-utils'); const { BMAD_FOLDER_NAME, toDashPath } = require('./shared/path-utils');
const fs = require('fs-extra'); const fs = require('fs-extra');
@ -31,7 +31,7 @@ class GitHubCopilotSetup extends BaseIdeSetup {
* @param {Object} options - Setup options * @param {Object} options - Setup options
*/ */
async setup(projectDir, bmadDir, options = {}) { async setup(projectDir, bmadDir, options = {}) {
console.log(chalk.cyan(`Setting up ${this.name}...`)); if (!options.silent) await prompts.log.info(`Setting up ${this.name}...`);
// Create .github/agents and .github/prompts directories // Create .github/agents and .github/prompts directories
const githubDir = path.join(projectDir, this.githubDir); const githubDir = path.join(projectDir, this.githubDir);
@ -66,21 +66,15 @@ class GitHubCopilotSetup extends BaseIdeSetup {
const targetPath = path.join(agentsDir, fileName); const targetPath = path.join(agentsDir, fileName);
await this.writeFile(targetPath, agentContent); await this.writeFile(targetPath, agentContent);
agentCount++; agentCount++;
console.log(chalk.green(` ✓ Created agent: ${fileName}`));
} }
// Generate prompt files from bmad-help.csv // Generate prompt files from bmad-help.csv
const promptCount = await this.generatePromptFiles(projectDir, bmadDir, agentArtifacts, agentManifest); const promptCount = await this.generatePromptFiles(projectDir, bmadDir, agentArtifacts, agentManifest);
// Generate copilot-instructions.md // Generate copilot-instructions.md
await this.generateCopilotInstructions(projectDir, bmadDir, agentManifest); await this.generateCopilotInstructions(projectDir, bmadDir, agentManifest, options);
console.log(chalk.green(`\n${this.name} configured:`)); if (!options.silent) await prompts.log.success(`${this.name} configured: ${agentCount} agents, ${promptCount} prompts → .github/`);
console.log(chalk.dim(` - ${agentCount} agents created in .github/agents/`));
console.log(chalk.dim(` - ${promptCount} prompts created in .github/prompts/`));
console.log(chalk.dim(` - copilot-instructions.md generated`));
console.log(chalk.dim(` - Destination: .github/`));
return { return {
success: true, success: true,
@ -406,7 +400,7 @@ tools: ${toolsStr}
* @param {string} bmadDir - BMAD installation directory * @param {string} bmadDir - BMAD installation directory
* @param {Map} agentManifest - Agent manifest data * @param {Map} agentManifest - Agent manifest data
*/ */
async generateCopilotInstructions(projectDir, bmadDir, agentManifest) { async generateCopilotInstructions(projectDir, bmadDir, agentManifest, options = {}) {
const configVars = await this.loadModuleConfig(bmadDir); const configVars = await this.loadModuleConfig(bmadDir);
// Build the agents table from the manifest // Build the agents table from the manifest
@ -495,19 +489,16 @@ Type \`/bmad-\` in Copilot Chat to see all available BMAD workflows and agent ac
const after = existing.slice(endIdx + markerEnd.length); const after = existing.slice(endIdx + markerEnd.length);
const merged = `${before}${markedContent}${after}`; const merged = `${before}${markedContent}${after}`;
await this.writeFile(instructionsPath, merged); await this.writeFile(instructionsPath, merged);
console.log(chalk.green(' ✓ Updated BMAD section in copilot-instructions.md'));
} else { } else {
// Existing file without markers — back it up before overwriting // Existing file without markers — back it up before overwriting
const backupPath = `${instructionsPath}.bak`; const backupPath = `${instructionsPath}.bak`;
await fs.copy(instructionsPath, backupPath); await fs.copy(instructionsPath, backupPath);
console.log(chalk.yellow(` ⚠ Backed up existing copilot-instructions.md → copilot-instructions.md.bak`)); if (!options.silent) await prompts.log.warn(` Backed up copilot-instructions.md → .bak`);
await this.writeFile(instructionsPath, `${markedContent}\n`); await this.writeFile(instructionsPath, `${markedContent}\n`);
console.log(chalk.green(' ✓ Generated copilot-instructions.md (with BMAD markers)'));
} }
} else { } else {
// No existing file — create fresh with markers // No existing file — create fresh with markers
await this.writeFile(instructionsPath, `${markedContent}\n`); await this.writeFile(instructionsPath, `${markedContent}\n`);
console.log(chalk.green(' ✓ Generated copilot-instructions.md'));
} }
} }
@ -607,7 +598,7 @@ Type \`/bmad-\` in Copilot Chat to see all available BMAD workflows and agent ac
/** /**
* Cleanup GitHub Copilot configuration - surgically remove only BMAD files * Cleanup GitHub Copilot configuration - surgically remove only BMAD files
*/ */
async cleanup(projectDir) { async cleanup(projectDir, options = {}) {
// Clean up agents directory // Clean up agents directory
const agentsDir = path.join(projectDir, this.githubDir, this.agentsDir); const agentsDir = path.join(projectDir, this.githubDir, this.agentsDir);
if (await fs.pathExists(agentsDir)) { if (await fs.pathExists(agentsDir)) {
@ -621,8 +612,8 @@ Type \`/bmad-\` in Copilot Chat to see all available BMAD workflows and agent ac
} }
} }
if (removed > 0) { if (removed > 0 && !options.silent) {
console.log(chalk.dim(` Cleaned up ${removed} existing BMAD agents`)); await prompts.log.message(` Cleaned up ${removed} existing BMAD agents`);
} }
} }
@ -639,16 +630,70 @@ Type \`/bmad-\` in Copilot Chat to see all available BMAD workflows and agent ac
} }
} }
if (removed > 0) { if (removed > 0 && !options.silent) {
console.log(chalk.dim(` Cleaned up ${removed} existing BMAD prompts`)); await prompts.log.message(` Cleaned up ${removed} existing BMAD prompts`);
} }
} }
// Note: copilot-instructions.md is NOT cleaned up here. // During uninstall, also strip BMAD markers from copilot-instructions.md.
// generateCopilotInstructions() handles marker-based replacement in a single // During reinstall (default), this is skipped because generateCopilotInstructions()
// read-modify-write pass, which correctly preserves user content outside the markers. // handles marker-based replacement in a single read-modify-write pass,
// Stripping markers here would cause generation to treat the file as legacy (no markers) // which correctly preserves user content outside the markers.
// and overwrite user content. if (options.isUninstall) {
await this.cleanupCopilotInstructions(projectDir, options);
}
}
/**
* Strip BMAD marker section from copilot-instructions.md
* If file becomes empty after stripping, delete it.
* If a .bak backup exists and the main file was deleted, restore the backup.
* @param {string} projectDir - Project directory
* @param {Object} [options] - Options (e.g. { silent: true })
*/
async cleanupCopilotInstructions(projectDir, options = {}) {
const instructionsPath = path.join(projectDir, this.githubDir, 'copilot-instructions.md');
const backupPath = `${instructionsPath}.bak`;
if (!(await fs.pathExists(instructionsPath))) {
return;
}
const content = await fs.readFile(instructionsPath, 'utf8');
const markerStart = '<!-- BMAD:START -->';
const markerEnd = '<!-- BMAD:END -->';
const startIdx = content.indexOf(markerStart);
const endIdx = content.indexOf(markerEnd);
if (startIdx === -1 || endIdx === -1 || endIdx <= startIdx) {
return; // No valid markers found
}
// Strip the marker section (including markers)
const before = content.slice(0, startIdx);
const after = content.slice(endIdx + markerEnd.length);
const cleaned = before + after;
if (cleaned.trim().length === 0) {
// File is empty after stripping — delete it
await fs.remove(instructionsPath);
// If backup exists, restore it
if (await fs.pathExists(backupPath)) {
await fs.rename(backupPath, instructionsPath);
if (!options.silent) {
await prompts.log.message(' Restored copilot-instructions.md from backup');
}
}
} else {
// Write cleaned content back (preserve original whitespace)
await fs.writeFile(instructionsPath, cleaned, 'utf8');
// If backup exists, it's stale now — remove it
if (await fs.pathExists(backupPath)) {
await fs.remove(backupPath);
}
}
} }
} }

View File

@ -216,13 +216,14 @@ class IdeManager {
/** /**
* Cleanup IDE configurations * Cleanup IDE configurations
* @param {string} projectDir - Project directory * @param {string} projectDir - Project directory
* @param {Object} [options] - Cleanup options passed through to handlers
*/ */
async cleanup(projectDir) { async cleanup(projectDir, options = {}) {
const results = []; const results = [];
for (const [name, handler] of this.handlers) { for (const [name, handler] of this.handlers) {
try { try {
await handler.cleanup(projectDir); await handler.cleanup(projectDir, options);
results.push({ ide: name, success: true }); results.push({ ide: name, success: true });
} catch (error) { } catch (error) {
results.push({ ide: name, success: false, error: error.message }); results.push({ ide: name, success: false, error: error.message });
@ -232,6 +233,40 @@ class IdeManager {
return results; return results;
} }
/**
* Cleanup only the IDEs in the provided list
* Falls back to cleanup() (all handlers) if ideList is empty or undefined
* @param {string} projectDir - Project directory
* @param {Array<string>} ideList - List of IDE names to clean up
* @param {Object} [options] - Cleanup options passed through to handlers
* @returns {Array} Results array
*/
async cleanupByList(projectDir, ideList, options = {}) {
if (!ideList || ideList.length === 0) {
return this.cleanup(projectDir, options);
}
await this.ensureInitialized();
const results = [];
// Build lowercase lookup for case-insensitive matching
const lowercaseHandlers = new Map([...this.handlers.entries()].map(([k, v]) => [k.toLowerCase(), v]));
for (const ideName of ideList) {
const handler = lowercaseHandlers.get(ideName.toLowerCase());
if (!handler) continue;
try {
await handler.cleanup(projectDir, options);
results.push({ ide: ideName, success: true });
} catch (error) {
results.push({ ide: ideName, success: false, error: error.message });
}
}
return results;
}
/** /**
* Get list of supported IDEs * Get list of supported IDEs
* @returns {Array} List of supported IDE names * @returns {Array} List of supported IDE names

View File

@ -734,8 +734,10 @@ class ModuleManager {
continue; continue;
} }
// Skip config.yaml templates - we'll generate clean ones with actual values // Skip module root config.yaml only - generated by config collector with actual values
if (file === 'config.yaml' || file.endsWith('/config.yaml')) { // Workflow-level config.yaml (e.g. workflows/orchestrate-story/config.yaml) must be copied
// for custom modules that use workflow-specific configuration
if (file === 'config.yaml') {
continue; continue;
} }

View File

@ -245,11 +245,48 @@ class UI {
// Handle quick update separately // Handle quick update separately
if (actionType === 'quick-update') { if (actionType === 'quick-update') {
// Quick update doesn't install custom content - just updates existing modules // Pass --custom-content through so installer can re-cache if cache is missing
let customContentForQuickUpdate = { hasCustomContent: false };
if (options.customContent) {
const paths = options.customContent
.split(',')
.map((p) => p.trim())
.filter(Boolean);
if (paths.length > 0) {
const customPaths = [];
const selectedModuleIds = [];
const sources = [];
for (const customPath of paths) {
const expandedPath = this.expandUserPath(customPath);
const validation = this.validateCustomContentPathSync(expandedPath);
if (validation) continue;
let moduleMeta;
try {
const moduleYamlPath = path.join(expandedPath, 'module.yaml');
moduleMeta = require('yaml').parse(await fs.readFile(moduleYamlPath, 'utf-8'));
} catch {
continue;
}
if (!moduleMeta?.code) continue;
customPaths.push(expandedPath);
selectedModuleIds.push(moduleMeta.code);
sources.push({ path: expandedPath, id: moduleMeta.code, name: moduleMeta.name || moduleMeta.code });
}
if (customPaths.length > 0) {
customContentForQuickUpdate = {
hasCustomContent: true,
selected: true,
sources,
selectedFiles: customPaths.map((p) => path.join(p, 'module.yaml')),
selectedModuleIds,
};
}
}
}
return { return {
actionType: 'quick-update', actionType: 'quick-update',
directory: confirmedDirectory, directory: confirmedDirectory,
customContent: { hasCustomContent: false }, customContent: customContentForQuickUpdate,
skipPrompts: options.yes || false, skipPrompts: options.yes || false,
}; };
} }
@ -305,6 +342,7 @@ class UI {
// Build custom content config similar to promptCustomContentSource // Build custom content config similar to promptCustomContentSource
const customPaths = []; const customPaths = [];
const selectedModuleIds = []; const selectedModuleIds = [];
const sources = [];
for (const customPath of paths) { for (const customPath of paths) {
const expandedPath = this.expandUserPath(customPath); const expandedPath = this.expandUserPath(customPath);
@ -326,6 +364,11 @@ class UI {
continue; continue;
} }
if (!moduleMeta) {
await prompts.log.warn(`Skipping custom content path: ${customPath} - module.yaml is empty`);
continue;
}
if (!moduleMeta.code) { if (!moduleMeta.code) {
await prompts.log.warn(`Skipping custom content path: ${customPath} - module.yaml missing 'code' field`); await prompts.log.warn(`Skipping custom content path: ${customPath} - module.yaml missing 'code' field`);
continue; continue;
@ -333,6 +376,11 @@ class UI {
customPaths.push(expandedPath); customPaths.push(expandedPath);
selectedModuleIds.push(moduleMeta.code); selectedModuleIds.push(moduleMeta.code);
sources.push({
path: expandedPath,
id: moduleMeta.code,
name: moduleMeta.name || moduleMeta.code,
});
} }
if (customPaths.length > 0) { if (customPaths.length > 0) {
@ -340,7 +388,9 @@ class UI {
selectedCustomModules: selectedModuleIds, selectedCustomModules: selectedModuleIds,
customContentConfig: { customContentConfig: {
hasCustomContent: true, hasCustomContent: true,
paths: customPaths, selected: true,
sources,
selectedFiles: customPaths.map((p) => path.join(p, 'module.yaml')),
selectedModuleIds: selectedModuleIds, selectedModuleIds: selectedModuleIds,
}, },
}; };
@ -446,6 +496,7 @@ class UI {
// Build custom content config similar to promptCustomContentSource // Build custom content config similar to promptCustomContentSource
const customPaths = []; const customPaths = [];
const selectedModuleIds = []; const selectedModuleIds = [];
const sources = [];
for (const customPath of paths) { for (const customPath of paths) {
const expandedPath = this.expandUserPath(customPath); const expandedPath = this.expandUserPath(customPath);
@ -467,6 +518,11 @@ class UI {
continue; continue;
} }
if (!moduleMeta) {
await prompts.log.warn(`Skipping custom content path: ${customPath} - module.yaml is empty`);
continue;
}
if (!moduleMeta.code) { if (!moduleMeta.code) {
await prompts.log.warn(`Skipping custom content path: ${customPath} - module.yaml missing 'code' field`); await prompts.log.warn(`Skipping custom content path: ${customPath} - module.yaml missing 'code' field`);
continue; continue;
@ -474,12 +530,19 @@ class UI {
customPaths.push(expandedPath); customPaths.push(expandedPath);
selectedModuleIds.push(moduleMeta.code); selectedModuleIds.push(moduleMeta.code);
sources.push({
path: expandedPath,
id: moduleMeta.code,
name: moduleMeta.name || moduleMeta.code,
});
} }
if (customPaths.length > 0) { if (customPaths.length > 0) {
customContentConfig = { customContentConfig = {
hasCustomContent: true, hasCustomContent: true,
paths: customPaths, selected: true,
sources,
selectedFiles: customPaths.map((p) => path.join(p, 'module.yaml')),
selectedModuleIds: selectedModuleIds, selectedModuleIds: selectedModuleIds,
}; };
} }