@superkou/openspec 1.4.1

package/dist/commands/config.js

@@ -0,0 +1,611 @@
+import { spawn, execSync } from 'node:child_process';
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import { getGlobalConfigPath, getGlobalConfig, saveGlobalConfig, } from '../core/global-config.js';
+import { getNestedValue, setNestedValue, deleteNestedValue, coerceValue, formatValueYaml, validateConfigKeyPath, validateConfig, DEFAULT_CONFIG, } from '../core/config-schema.js';
+import { CORE_WORKFLOWS, ALL_WORKFLOWS, getProfileWorkflows } from '../core/profiles.js';
+import { OPENSPEC_DIR_NAME } from '../core/config.js';
+import { hasProjectConfigDrift } from '../core/profile-sync-drift.js';
+import { findWorkspaceRoot, hasWorkspaceSkillProfileDrift, readOptionalWorkspaceViewState, } from '../core/workspace/index.js';
+const WORKFLOW_PROMPT_META = {
+    propose: {
+        name: '提出变更',
+        description: '根据需求创建提案、设计和任务',
+    },
+    explore: {
+        name: '探索构思',
+        description: '实现前调查分析问题',
+    },
+    new: {
+        name: '新建变更',
+        description: '快速创建新的变更脚手架',
+    },
+    continue: {
+        name: '继续变更',
+        description: '继续处理现有变更',
+    },
+    apply: {
+        name: '执行任务',
+        description: '实现当前变更中的任务',
+    },
+    ff: {
+        name: '快速推进',
+        description: '运行更快的实施工作流',
+    },
+    sync: {
+        name: '同步规格',
+        description: '同步变更制品与规格',
+    },
+    archive: {
+        name: '归档变更',
+        description: '定稿并归档已完成的变更',
+    },
+    'bulk-archive': {
+        name: '批量归档',
+        description: '批量归档多个已完成变更',
+    },
+    verify: {
+        name: '验证变更',
+        description: '对变更运行验证检查',
+    },
+    onboard: {
+        name: '引导上手',
+        description: 'OpenSpec 引导式上手流程',
+    },
+};
+function isPromptCancellationError(error) {
+    return (error instanceof Error &&
+        (error.name === 'ExitPromptError' || error.message.includes('force closed the prompt with SIGINT')));
+}
+/**
+ * Resolve the effective current profile state from global config defaults.
+ */
+export function resolveCurrentProfileState(config) {
+    const profile = config.profile || 'core';
+    const delivery = config.delivery || 'both';
+    const workflows = [
+        ...getProfileWorkflows(profile, config.workflows ? [...config.workflows] : undefined),
+    ];
+    return { profile, delivery, workflows };
+}
+/**
+ * Derive profile type from selected workflows.
+ */
+export function deriveProfileFromWorkflowSelection(selectedWorkflows) {
+    const isCoreMatch = selectedWorkflows.length === CORE_WORKFLOWS.length &&
+        CORE_WORKFLOWS.every((w) => selectedWorkflows.includes(w));
+    return isCoreMatch ? 'core' : 'custom';
+}
+/**
+ * Format a compact workflow summary for the profile header.
+ */
+export function formatWorkflowSummary(workflows, profile) {
+    return `${workflows.length} 个已选 (${profile})`;
+}
+function stableWorkflowOrder(workflows) {
+    const seen = new Set();
+    const ordered = [];
+    for (const workflow of ALL_WORKFLOWS) {
+        if (workflows.includes(workflow) && !seen.has(workflow)) {
+            ordered.push(workflow);
+            seen.add(workflow);
+        }
+    }
+    const extras = workflows.filter((w) => !ALL_WORKFLOWS.includes(w));
+    extras.sort();
+    for (const extra of extras) {
+        if (!seen.has(extra)) {
+            ordered.push(extra);
+            seen.add(extra);
+        }
+    }
+    return ordered;
+}
+/**
+ * Build a user-facing diff summary between two profile states.
+ */
+export function diffProfileState(before, after) {
+    const lines = [];
+    if (before.delivery !== after.delivery) {
+        lines.push(`交付方式: ${before.delivery} -> ${after.delivery}`);
+    }
+    if (before.profile !== after.profile) {
+        lines.push(`配置文件: ${before.profile} -> ${after.profile}`);
+    }
+    const beforeOrdered = stableWorkflowOrder(before.workflows);
+    const afterOrdered = stableWorkflowOrder(after.workflows);
+    const beforeSet = new Set(beforeOrdered);
+    const afterSet = new Set(afterOrdered);
+    const added = afterOrdered.filter((w) => !beforeSet.has(w));
+    const removed = beforeOrdered.filter((w) => !afterSet.has(w));
+    if (added.length > 0 || removed.length > 0) {
+        const tokens = [];
+        if (added.length > 0) {
+            tokens.push(`新增 ${added.join(', ')}`);
+        }
+        if (removed.length > 0) {
+            tokens.push(`移除 ${removed.join(', ')}`);
+        }
+        lines.push(`工作流: ${tokens.join('; ')}`);
+    }
+    return {
+        hasChanges: lines.length > 0,
+        lines,
+    };
+}
+async function resolveWorkspaceConfigProfileContext(cwd = process.cwd()) {
+    const workspaceRoot = await findWorkspaceRoot(cwd);
+    if (!workspaceRoot) {
+        return null;
+    }
+    return {
+        root: workspaceRoot,
+        commandCwd: cwd,
+    };
+}
+function maybeWarnProjectConfigDrift(projectDir, state, colorize) {
+    const openspecDir = path.join(projectDir, OPENSPEC_DIR_NAME);
+    if (!fs.existsSync(openspecDir)) {
+        return;
+    }
+    if (!hasProjectConfigDrift(projectDir, state.workflows, state.delivery)) {
+        return;
+    }
+    console.log(colorize('警告：全局配置尚未应用到该项目。请运行 `openspec update` 同步。'));
+}
+async function maybeWarnConfigDrift(state, colorize) {
+    const workspaceContext = await resolveWorkspaceConfigProfileContext();
+    if (workspaceContext) {
+        let viewState = null;
+        try {
+            viewState = await readOptionalWorkspaceViewState(workspaceContext.root);
+        }
+        catch {
+            return;
+        }
+        if (hasWorkspaceSkillProfileDrift(viewState)) {
+            console.log(colorize('警告：工作区本地 Agent 技能与当前全局配置文件不同步。请运行 `openspec workspace update` 同步。'));
+        }
+        return;
+    }
+    maybeWarnProjectConfigDrift(process.cwd(), state, colorize);
+}
+function printConfigProfileApplyGuidance(workspaceContext) {
+    if (workspaceContext) {
+        console.log('配置已更新。运行 `openspec workspace update` 将其应用到工作区本地技能。');
+        return;
+    }
+    console.log('配置已更新。在项目中运行 `openspec update` 以应用。');
+}
+/**
+ * Register the config command and all its subcommands.
+ *
+ * @param program - The Commander program instance
+ */
+export function registerConfigCommand(program) {
+    const configCmd = program
+        .command('config')
+        .description('查看和修改全局 OpenSpec 配置')
+        .option('--scope <scope>', '配置作用域（目前仅支持 "global"）')
+        .hook('preAction', (thisCommand) => {
+        const opts = thisCommand.opts();
+        if (opts.scope && opts.scope !== 'global') {
+            console.error('错误：项目级配置尚未实现');
+            process.exit(1);
+        }
+    });
+    // config path
+    configCmd
+        .command('path')
+        .description('显示配置文件路径')
+        .action(() => {
+        console.log(getGlobalConfigPath());
+    });
+    // config list
+    configCmd
+        .command('list')
+        .description('显示所有当前设置')
+        .option('--json', '以 JSON 格式输出')
+        .action((options) => {
+        const config = getGlobalConfig();
+        if (options.json) {
+            console.log(JSON.stringify(config, null, 2));
+        }
+        else {
+            // Read raw config to determine which values are explicit vs defaults
+            const configPath = getGlobalConfigPath();
+            let rawConfig = {};
+            try {
+                if (fs.existsSync(configPath)) {
+                    rawConfig = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
+                }
+            }
+            catch {
+                // If reading fails, treat all as defaults
+            }
+            console.log(formatValueYaml(config));
+            // Annotate profile settings
+            const profileSource = rawConfig.profile !== undefined ? '（显式设置）' : '（默认）';
+            const deliverySource = rawConfig.delivery !== undefined ? '（显式设置）' : '（默认）';
+            console.log(`\n配置文件设置：`);
+            console.log(`  profile: ${config.profile} ${profileSource}`);
+            console.log(`  delivery: ${config.delivery} ${deliverySource}`);
+            if (config.profile === 'core') {
+                console.log(`  workflows: ${CORE_WORKFLOWS.join(', ')}（来自 core 配置文件）`);
+            }
+            else if (config.workflows && config.workflows.length > 0) {
+                console.log(`  workflows: ${config.workflows.join(', ')}（显式设置）`);
+            }
+            else {
+                console.log(`  workflows:（无）`);
+            }
+        }
+    });
+    // config get
+    configCmd
+        .command('get <key>')
+        .description('获取特定值（原始格式，可脚本化）')
+        .action((key) => {
+        const config = getGlobalConfig();
+        const value = getNestedValue(config, key);
+        if (value === undefined) {
+            process.exitCode = 1;
+            return;
+        }
+        if (typeof value === 'object' && value !== null) {
+            console.log(JSON.stringify(value));
+        }
+        else {
+            console.log(String(value));
+        }
+    });
+    // config set
+    configCmd
+        .command('set <key> <value>')
+        .description('设置一个值（自动类型转换）')
+        .option('--string', '强制将值存储为字符串')
+        .option('--allow-unknown', '允许设置未预定义的键')
+        .action((key, value, options) => {
+        const allowUnknown = Boolean(options.allowUnknown);
+        const keyValidation = validateConfigKeyPath(key);
+        if (!keyValidation.valid && !allowUnknown) {
+            const reason = keyValidation.reason ? ` ${keyValidation.reason}。` : '';
+            console.error(`错误：无效的配置键 "${key}"。${reason}`);
+            console.error('使用 "openspec config list" 查看可用的键。');
+            console.error('使用 --allow-unknown 跳过此检查。');
+            process.exitCode = 1;
+            return;
+        }
+        const config = getGlobalConfig();
+        const coercedValue = coerceValue(value, options.string || false);
+        // Create a copy to validate before saving
+        const newConfig = JSON.parse(JSON.stringify(config));
+        setNestedValue(newConfig, key, coercedValue);
+        // Validate the new config
+        const validation = validateConfig(newConfig);
+        if (!validation.success) {
+            console.error(`错误：配置无效 - ${validation.error}`);
+            process.exitCode = 1;
+            return;
+        }
+        // Apply changes and save
+        setNestedValue(config, key, coercedValue);
+        saveGlobalConfig(config);
+        const displayValue = typeof coercedValue === 'string' ? `"${coercedValue}"` : String(coercedValue);
+        console.log(`已设置 ${key} = ${displayValue}`);
+    });
+    // config unset
+    configCmd
+        .command('unset <key>')
+        .description('删除一个键（恢复为默认值）')
+        .action((key) => {
+        const config = getGlobalConfig();
+        const existed = deleteNestedValue(config, key);
+        if (existed) {
+            saveGlobalConfig(config);
+            console.log(`已取消设置 ${key}（已恢复为默认值）`);
+        }
+        else {
+            console.log(`键 "${key}" 未被设置`);
+        }
+    });
+    // config reset
+    configCmd
+        .command('reset')
+        .description('将配置重置为默认值')
+        .option('--all', '重置所有配置（必选）')
+        .option('-y, --yes', '跳过确认提示')
+        .action(async (options) => {
+        if (!options.all) {
+            console.error('错误：重置需要 --all 标志');
+            console.error('用法：openspec config reset --all [-y]');
+            process.exitCode = 1;
+            return;
+        }
+        if (!options.yes) {
+            const { confirm } = await import('@inquirer/prompts');
+            let confirmed;
+            try {
+                confirmed = await confirm({
+                    message: '将所有配置重置为默认值？',
+                    default: false,
+                });
+            }
+            catch (error) {
+                if (isPromptCancellationError(error)) {
+                    console.log('已取消重置。');
+                    process.exitCode = 130;
+                    return;
+                }
+                throw error;
+            }
+            if (!confirmed) {
+                console.log('已取消重置。');
+                return;
+            }
+        }
+        saveGlobalConfig({ ...DEFAULT_CONFIG });
+        console.log('配置已重置为默认值');
+    });
+    // config edit
+    configCmd
+        .command('edit')
+        .description('在 $EDITOR 中编辑配置')
+        .action(async () => {
+        const editor = process.env.EDITOR || process.env.VISUAL;
+        if (!editor) {
+            console.error('错误：未配置编辑器');
+            console.error('设置 EDITOR 或 VISUAL 环境变量为您偏好的编辑器');
+            console.error('示例：export EDITOR=vim');
+            process.exitCode = 1;
+            return;
+        }
+        const configPath = getGlobalConfigPath();
+        // Ensure config file exists with defaults
+        if (!fs.existsSync(configPath)) {
+            saveGlobalConfig({ ...DEFAULT_CONFIG });
+        }
+        // Spawn editor and wait for it to close
+        // Avoid shell parsing to correctly handle paths with spaces in both
+        // the editor path and config path
+        const child = spawn(editor, [configPath], {
+            stdio: 'inherit',
+            shell: false,
+        });
+        await new Promise((resolve, reject) => {
+            child.on('close', (code) => {
+                if (code === 0) {
+                    resolve();
+                }
+                else {
+                    reject(new Error(`编辑器退出，退出码为 ${code}`));
+                }
+            });
+            child.on('error', reject);
+        });
+        try {
+            const rawConfig = fs.readFileSync(configPath, 'utf-8');
+            const parsedConfig = JSON.parse(rawConfig);
+            const validation = validateConfig(parsedConfig);
+            if (!validation.success) {
+                console.error(`错误：配置无效 - ${validation.error}`);
+                process.exitCode = 1;
+            }
+        }
+        catch (error) {
+            if (error.code === 'ENOENT') {
+                console.error(`错误：未找到配置文件 ${configPath}`);
+            }
+            else if (error instanceof SyntaxError) {
+                console.error(`错误：${configPath} 中的 JSON 格式无效`);
+                console.error(error.message);
+            }
+            else {
+                console.error(`错误：无法验证配置 - ${error instanceof Error ? error.message : String(error)}`);
+            }
+            process.exitCode = 1;
+        }
+    });
+    // config profile [preset]
+    configCmd
+        .command('profile [preset]')
+        .description('配置工作流配置文件（交互式选择或预设快捷方式）')
+        .action(async (preset) => {
+        // Preset shortcut: `openspec config profile core`
+        if (preset === 'core') {
+            const config = getGlobalConfig();
+            config.profile = 'core';
+            config.workflows = [...CORE_WORKFLOWS];
+            // Preserve delivery setting
+            saveGlobalConfig(config);
+            const workspaceContext = await resolveWorkspaceConfigProfileContext();
+            printConfigProfileApplyGuidance(workspaceContext);
+            return;
+        }
+        if (preset) {
+            console.error(`错误：未知的配置文件预设 "${preset}"。可用预设：core`);
+            process.exitCode = 1;
+            return;
+        }
+        // Non-interactive check
+        if (!process.stdout.isTTY) {
+            console.error('需要交互模式。请使用 `openspec config profile core` 或通过环境变量/标志设置配置。');
+            process.exitCode = 1;
+            return;
+        }
+        // Interactive picker
+        const { select, checkbox, confirm } = await import('@inquirer/prompts');
+        const chalk = (await import('chalk')).default;
+        try {
+            const config = getGlobalConfig();
+            const currentState = resolveCurrentProfileState(config);
+            console.log(chalk.bold('\n当前配置文件设置'));
+            console.log(`  交付方式: ${currentState.delivery}`);
+            console.log(`  工作流: ${formatWorkflowSummary(currentState.workflows, currentState.profile)}`);
+            console.log(chalk.dim('  交付方式 = 工作流的安装位置（skills、commands 或 both）'));
+            console.log(chalk.dim('  工作流 = 可用的操作（propose、explore、apply 等）'));
+            console.log();
+            const action = await select({
+                message: '您想配置什么？',
+                choices: [
+                    {
+                        value: 'both',
+                        name: '交付方式和工作流',
+                        description: '同时更新安装模式和可用操作',
+                    },
+                    {
+                        value: 'delivery',
+                        name: '仅交付方式',
+                        description: '更改工作流的安装位置',
+                    },
+                    {
+                        value: 'workflows',
+                        name: '仅工作流',
+                        description: '更改可用的工作流操作',
+                    },
+                    {
+                        value: 'keep',
+                        name: '保留当前设置（退出）',
+                        description: '保持配置不变并退出',
+                    },
+                ],
+            });
+            if (action === 'keep') {
+                console.log('配置未更改。');
+                await maybeWarnConfigDrift(currentState, chalk.yellow);
+                return;
+            }
+            const nextState = {
+                profile: currentState.profile,
+                delivery: currentState.delivery,
+                workflows: [...currentState.workflows],
+            };
+            if (action === 'both' || action === 'delivery') {
+                const deliveryChoices = [
+                    {
+                        value: 'both',
+                        name: '两者（skills + commands）',
+                        description: '将工作流同时安装为技能和斜杠命令',
+                    },
+                    {
+                        value: 'skills',
+                        name: '仅技能',
+                        description: '仅将工作流安装为技能',
+                    },
+                    {
+                        value: 'commands',
+                        name: '仅命令',
+                        description: '仅将工作流安装为斜杠命令',
+                    },
+                ];
+                for (const choice of deliveryChoices) {
+                    if (choice.value === currentState.delivery) {
+                        choice.name += ' [当前]';
+                    }
+                }
+                nextState.delivery = await select({
+                    message: '交付模式（工作流的安装方式）：',
+                    choices: deliveryChoices,
+                    default: currentState.delivery,
+                });
+            }
+            if (action === 'both' || action === 'workflows') {
+                const formatWorkflowChoice = (workflow) => {
+                    const metadata = WORKFLOW_PROMPT_META[workflow] ?? {
+                        name: workflow,
+                        description: `工作流：${workflow}`,
+                    };
+                    return {
+                        value: workflow,
+                        name: metadata.name,
+                        description: metadata.description,
+                        short: metadata.name,
+                        checked: currentState.workflows.includes(workflow),
+                    };
+                };
+                const selectedWorkflows = await checkbox({
+                    message: '选择要启用的工作流：',
+                    instructions: '空格键切换，回车键确认',
+                    pageSize: ALL_WORKFLOWS.length,
+                    theme: {
+                        icon: {
+                            checked: '[x]',
+                            unchecked: '[ ]',
+                        },
+                    },
+                    choices: ALL_WORKFLOWS.map(formatWorkflowChoice),
+                });
+                nextState.workflows = selectedWorkflows;
+                nextState.profile = deriveProfileFromWorkflowSelection(selectedWorkflows);
+            }
+            const diff = diffProfileState(currentState, nextState);
+            if (!diff.hasChanges) {
+                console.log('配置未更改。');
+                await maybeWarnConfigDrift(nextState, chalk.yellow);
+                return;
+            }
+            console.log(chalk.bold('\n配置变更：'));
+            for (const line of diff.lines) {
+                console.log(`  ${line}`);
+            }
+            console.log();
+            config.profile = nextState.profile;
+            config.delivery = nextState.delivery;
+            config.workflows = nextState.workflows;
+            saveGlobalConfig(config);
+            const workspaceContext = await resolveWorkspaceConfigProfileContext();
+            if (workspaceContext) {
+                const applyNow = await confirm({
+                    message: '立即将变更应用到当前工作区？',
+                    default: true,
+                });
+                if (applyNow) {
+                    try {
+                        execSync('npx openspec workspace update', {
+                            stdio: 'inherit',
+                            cwd: workspaceContext.commandCwd,
+                        });
+                        console.log('在其他工作区中运行 `openspec workspace update` 以应用变更。');
+                    }
+                    catch {
+                        console.error('`openspec workspace update` 执行失败。请手动运行它以应用配置文件变更。');
+                        process.exitCode = 1;
+                    }
+                    return;
+                }
+                printConfigProfileApplyGuidance(workspaceContext);
+                return;
+            }
+            // Check if inside an OpenSpec project
+            const projectDir = process.cwd();
+            const openspecDir = path.join(projectDir, OPENSPEC_DIR_NAME);
+            if (fs.existsSync(openspecDir)) {
+                const applyNow = await confirm({
+                    message: '立即将变更应用到当前项目？',
+                    default: true,
+                });
+                if (applyNow) {
+                    try {
+                        execSync('npx openspec update', { stdio: 'inherit', cwd: projectDir });
+                        console.log('在其他项目中运行 `openspec update` 以应用变更。');
+                    }
+                    catch {
+                        console.error('`openspec update` 执行失败。请手动运行它以应用配置文件变更。');
+                        process.exitCode = 1;
+                    }
+                    return;
+                }
+            }
+            printConfigProfileApplyGuidance(null);
+        }
+        catch (error) {
+            if (isPromptCancellationError(error)) {
+                console.log('已取消配置文件设置。');
+                process.exitCode = 130;
+                return;
+            }
+            throw error;
+        }
+    });
+}
+//# sourceMappingURL=config.js.map

package/dist/commands/context-store.d.ts

@@ -0,0 +1,3 @@
+import { Command } from 'commander';
+export declare function registerContextStoreCommand(program: Command): void;
+//# sourceMappingURL=context-store.d.ts.map