Compare commits

...

9 Commits

Author SHA1 Message Date
Jonah Schulte 0655f3fe1d
Merge 8927e207e8 into 819d373e2e 2026-03-26 17:23:41 -04:00
Jonah Schulte 8927e207e8 fix(cli): extract core-config-defaults module and centralize fallback logic
- Extract getDefaultCoreConfig, applyDefaultCoreConfig, and
  isMissingOrUnresolvedCoreConfigValue into core-config-defaults.js
- Memoize YAML parsing with clearable cache for testing
- Use prompts.log.warn instead of console.warn for error logging
- Guard process.cwd() with try/catch in --yes path
- Centralize handler.js placeholder replacement via shared defaults
- Add tests for backfill logic and custom handler shared defaults
2026-03-25 00:34:10 -04:00
Jonah Schulte 1571a3cff4
Merge branch 'main' into fix/non-interactive-install-defaults 2026-03-25 00:27:48 -04:00
Jonah Schulte 5c0dfd85ad
Merge branch 'main' into fix/non-interactive-install-defaults 2026-03-13 20:18:01 -04:00
Jonah Schulte 7422d3a0a3 fix(cli): address PR review feedback for non-interactive install defaults
- Validate cwd with validateDirectorySync in --yes path
- Fix JSDoc placement: move collectCoreConfig docs above its method
- Read user_name default from module.yaml, fall back to OS username
- Harden YAML defaults with type/empty-string normalization
- Log warning on module.yaml load failure instead of silent catch
- Fix backfill predicate to detect unresolved placeholders like {output_folder}
- Always merge defaults into existing config in --yes mode
2026-03-13 16:53:45 -04:00
Jonah Schulte d2e7158c72 Merge branch 'fix/non-interactive-install-defaults' of github.com:jschulte/BMAD-METHOD into fix/non-interactive-install-defaults 2026-03-13 16:49:15 -04:00
Jonah Schulte ac04378a1a Merge remote-tracking branch 'upstream/main' into fix/non-interactive-install-defaults 2026-03-13 16:48:46 -04:00
Jonah Schulte fe2cbe9a78
Merge branch 'main' into fix/non-interactive-install-defaults 2026-03-13 16:29:57 -04:00
Jonah Schulte 1cdc7f4a48 fix(cli): resolve non-interactive install defaults for directory and output_folder
When using --yes with partial CLI options (e.g. --user-name without
--output-folder), the installer had two bugs:

1. Still prompted for directory instead of defaulting to cwd
2. Left {output_folder} unresolved in module configs, creating a literal
   "{output_folder}" directory instead of "_bmad-output"

Extract getDefaultCoreConfig() that reads defaults from
src/core/module.yaml (single source of truth) and use it to backfill
missing fields when --yes skips interactive prompts.
2026-03-13 16:27:26 -04:00
3 changed files with 157 additions and 17 deletions

View File

@ -15,6 +15,7 @@ const path = require('node:path');
const os = require('node:os');
const fs = require('fs-extra');
const { ConfigCollector } = require('../tools/cli/installers/lib/core/config-collector');
const { applyDefaultCoreConfig, clearCoreConfigDefaultsCache, getDefaultCoreConfig } = require('../tools/cli/lib/core-config-defaults');
const { ManifestGenerator } = require('../tools/cli/installers/lib/core/manifest-generator');
const { IdeManager } = require('../tools/cli/installers/lib/ide/manager');
const { clearCache, loadPlatformCodes } = require('../tools/cli/installers/lib/ide/platform-codes');
@ -2028,6 +2029,38 @@ async function runTests() {
console.log('');
// ============================================================
// Test Suite 34: Core Config Default Backfill
// ============================================================
console.log(`${colors.yellow}Test Suite 34: Core Config Default Backfill${colors.reset}\n`);
try {
clearCoreConfigDefaultsCache();
const defaults = await getDefaultCoreConfig();
const normalized = applyDefaultCoreConfig(
{
user_name: '{user_name}',
communication_language: 'Spanish',
document_output_language: '',
output_folder: '{output_folder}',
},
defaults,
);
assert(normalized.appliedDefaults === true, 'Core config backfill reports when defaults were applied');
assert(normalized.coreConfig.user_name === defaults.user_name, 'Core config backfill replaces unresolved user_name placeholder');
assert(normalized.coreConfig.communication_language === 'Spanish', 'Core config backfill preserves existing valid values');
assert(
normalized.coreConfig.document_output_language === defaults.document_output_language,
'Core config backfill replaces blank document output language',
);
assert(normalized.coreConfig.output_folder === defaults.output_folder, 'Core config backfill replaces unresolved output_folder');
} catch (error) {
assert(false, 'Core config default backfill test succeeds', error.message);
}
console.log('');
// ============================================================
// Summary
// ============================================================

View File

@ -0,0 +1,89 @@
const os = require('node:os');
const fs = require('fs-extra');
const yaml = require('yaml');
const prompts = require('./prompts');
const { getModulePath } = require('./project-root');
let cachedCoreConfigDefaults = null;
function getFallbackUsername() {
let safeUsername;
try {
safeUsername = os.userInfo().username;
} catch {
safeUsername = process.env.USER || process.env.USERNAME || 'User';
}
if (typeof safeUsername !== 'string' || safeUsername.trim() === '') {
return 'User';
}
const normalizedUsername = safeUsername.trim();
return normalizedUsername.charAt(0).toUpperCase() + normalizedUsername.slice(1);
}
function normalizeDefaultString(value, fallback) {
return typeof value === 'string' && value.trim() !== '' ? value.trim() : fallback;
}
function isMissingOrUnresolvedCoreConfigValue(value) {
return value == null || (typeof value === 'string' && (value.trim() === '' || /^\{[^}]+\}$/.test(value.trim())));
}
function applyDefaultCoreConfig(coreConfig = {}, defaults = {}) {
const normalizedConfig = { ...coreConfig };
let appliedDefaults = false;
for (const [key, value] of Object.entries(defaults)) {
if (isMissingOrUnresolvedCoreConfigValue(normalizedConfig[key])) {
normalizedConfig[key] = value;
appliedDefaults = true;
}
}
return { coreConfig: normalizedConfig, appliedDefaults };
}
async function getDefaultCoreConfig() {
if (cachedCoreConfigDefaults) {
return { ...cachedCoreConfigDefaults };
}
const fallbackDefaults = {
user_name: getFallbackUsername(),
communication_language: 'English',
document_output_language: 'English',
output_folder: '_bmad-output',
};
try {
const moduleYamlPath = getModulePath('core', 'module.yaml');
const moduleConfig = yaml.parse(await fs.readFile(moduleYamlPath, 'utf8')) || {};
cachedCoreConfigDefaults = {
user_name: normalizeDefaultString(moduleConfig.user_name?.default, fallbackDefaults.user_name),
communication_language: normalizeDefaultString(moduleConfig.communication_language?.default, fallbackDefaults.communication_language),
document_output_language: normalizeDefaultString(
moduleConfig.document_output_language?.default,
fallbackDefaults.document_output_language,
),
output_folder: normalizeDefaultString(moduleConfig.output_folder?.default, fallbackDefaults.output_folder),
};
} catch (error) {
await prompts.log.warn(`Failed to load module.yaml, falling back to defaults: ${error.message}`);
cachedCoreConfigDefaults = fallbackDefaults;
}
return { ...cachedCoreConfigDefaults };
}
function clearCoreConfigDefaultsCache() {
cachedCoreConfigDefaults = null;
}
module.exports = {
applyDefaultCoreConfig,
clearCoreConfigDefaultsCache,
getDefaultCoreConfig,
isMissingOrUnresolvedCoreConfigValue,
};

View File

@ -2,6 +2,7 @@ const path = require('node:path');
const os = require('node:os');
const fs = require('fs-extra');
const { CLIUtils } = require('./cli-utils');
const { applyDefaultCoreConfig, getDefaultCoreConfig: loadDefaultCoreConfig } = require('./core-config-defaults');
const { CustomHandler } = require('../installers/lib/custom/handler');
const { ExternalModuleManager } = require('../installers/lib/modules/external-manager');
const prompts = require('./prompts');
@ -47,6 +48,21 @@ class UI {
}
confirmedDirectory = expandedDir;
await prompts.log.info(`Using directory from command-line: ${confirmedDirectory}`);
} else if (options.yes) {
// Default to current directory when --yes flag is set
let cwd;
try {
cwd = process.cwd();
} catch (error) {
await prompts.log.error(`Failed to resolve current directory (--yes flag): ${error.message}`);
throw new Error(`Unable to determine current directory: ${error.message}`);
}
const validation = this.validateDirectorySync(cwd);
if (validation) {
throw new Error(`Invalid current directory: ${validation}`);
}
confirmedDirectory = cwd;
await prompts.log.info(`Using current directory (--yes flag): ${confirmedDirectory}`);
} else {
confirmedDirectory = await this.getConfirmedDirectory();
}
@ -823,6 +839,14 @@ class UI {
return { existingInstall, installedModuleIds, bmadDir };
}
/**
* Get default core config values by reading from src/core/module.yaml
* @returns {Object} Default core config with user_name, communication_language, document_output_language, output_folder
*/
async getDefaultCoreConfig() {
return loadDefaultCoreConfig();
}
/**
* Collect core configuration
* @param {string} directory - Installation directory
@ -866,27 +890,21 @@ class UI {
(!options.userName || !options.communicationLanguage || !options.documentOutputLanguage || !options.outputFolder)
) {
await configCollector.collectModuleConfig('core', directory, false, true);
} else if (options.yes) {
const defaults = await this.getDefaultCoreConfig();
const normalizedConfig = applyDefaultCoreConfig(configCollector.collectedConfig.core, defaults);
configCollector.collectedConfig.core = normalizedConfig.coreConfig;
if (normalizedConfig.appliedDefaults) {
await prompts.log.info('Using default configuration (--yes flag)');
}
}
} else if (options.yes) {
// Use all defaults when --yes flag is set
await configCollector.loadExistingConfig(directory);
const existingConfig = configCollector.collectedConfig.core || {};
// If no existing config, use defaults
if (Object.keys(existingConfig).length === 0) {
let safeUsername;
try {
safeUsername = os.userInfo().username;
} catch {
safeUsername = process.env.USER || process.env.USERNAME || 'User';
}
const defaultUsername = safeUsername.charAt(0).toUpperCase() + safeUsername.slice(1);
configCollector.collectedConfig.core = {
user_name: defaultUsername,
communication_language: 'English',
document_output_language: 'English',
output_folder: '_bmad-output',
};
const defaults = await this.getDefaultCoreConfig();
const normalizedConfig = applyDefaultCoreConfig(existingConfig, defaults);
configCollector.collectedConfig.core = normalizedConfig.coreConfig;
if (normalizedConfig.appliedDefaults) {
await prompts.log.info('Using default configuration (--yes flag)');
}
} else {