@zhuan-ai/zhuanspec 1.3.0

package/dist/commands/config.js

@@ -0,0 +1,198 @@
+import { spawn } from 'node:child_process';
+import * as fs from 'node:fs';
+import { getGlobalConfigPath, getGlobalConfig, saveGlobalConfig, } from '../core/global-config.js';
+import { getNestedValue, setNestedValue, deleteNestedValue, coerceValue, formatValueYaml, validateConfigKeyPath, validateConfig, DEFAULT_CONFIG, } from '../core/config-schema.js';
+/**
+ * Register the config command and all its subcommands.
+ *
+ * @param program - The Commander program instance
+ */
+export function registerConfigCommand(program) {
+    const configCmd = program
+        .command('config')
+        .description('View and modify global ZhuanSpec configuration')
+        .option('--scope <scope>', 'Config scope (only "global" supported currently)')
+        .hook('preAction', (thisCommand) => {
+        const opts = thisCommand.opts();
+        if (opts.scope && opts.scope !== 'global') {
+            console.error('错误：项目本地配置尚未实现');
+            process.exit(1);
+        }
+    });
+    // config path
+    configCmd
+        .command('path')
+        .description('Show config file location')
+        .action(() => {
+        console.log(getGlobalConfigPath());
+    });
+    // config list
+    configCmd
+        .command('list')
+        .description('Show all current settings')
+        .option('--json', 'Output as JSON')
+        .action((options) => {
+        const config = getGlobalConfig();
+        if (options.json) {
+            console.log(JSON.stringify(config, null, 2));
+        }
+        else {
+            console.log(formatValueYaml(config));
+        }
+    });
+    // config get
+    configCmd
+        .command('get <key>')
+        .description('Get a specific value (raw, scriptable)')
+        .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('Set a value (auto-coerce types)')
+        .option('--string', 'Force value to be stored as string')
+        .option('--allow-unknown', 'Allow setting unknown keys')
+        .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('使用 "zhuanspec 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('Remove a key (revert to default)')
+        .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('Reset configuration to defaults')
+        .option('--all', 'Reset all configuration (required)')
+        .option('-y, --yes', 'Skip confirmation prompts')
+        .action(async (options) => {
+        if (!options.all) {
+            console.error('错误：重置需要 --all 标志');
+            console.error('用法：zhuanspec config reset --all [-y]');
+            process.exitCode = 1;
+            return;
+        }
+        if (!options.yes) {
+            const { confirm } = await import('@inquirer/prompts');
+            const confirmed = await confirm({
+                message: '将所有配置重置为默认值？',
+                default: false,
+            });
+            if (!confirmed) {
+                console.log('重置已取消。');
+                return;
+            }
+        }
+        saveGlobalConfig({ ...DEFAULT_CONFIG });
+        console.log('配置已重置为默认值');
+    });
+    // config edit
+    configCmd
+        .command('edit')
+        .description('Open config in $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(`Editor exited with code ${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;
+        }
+    });
+}
+//# sourceMappingURL=config.js.map

package/dist/commands/show.d.ts

@@ -0,0 +1,14 @@
+export declare class ShowCommand {
+    execute(itemName?: string, options?: {
+        json?: boolean;
+        type?: string;
+        noInteractive?: boolean;
+        [k: string]: any;
+    }): Promise<void>;
+    private normalizeType;
+    private runInteractiveByType;
+    private showDirect;
+    private printNonInteractiveHint;
+    private warnIrrelevantFlags;
+}
+//# sourceMappingURL=show.d.ts.map

package/dist/commands/show.js

@@ -0,0 +1,132 @@
+import { isInteractive } from '../utils/interactive.js';
+import { getActiveChangeIds, getSpecIds } from '../utils/item-discovery.js';
+import { ChangeCommand } from './change.js';
+import { SpecCommand } from './spec.js';
+import { nearestMatches } from '../utils/match.js';
+const CHANGE_FLAG_KEYS = new Set(['deltasOnly', 'requirementsOnly']);
+const SPEC_FLAG_KEYS = new Set(['requirements', 'scenarios', 'requirement']);
+export class ShowCommand {
+    async execute(itemName, options = {}) {
+        const interactive = isInteractive(options);
+        const typeOverride = this.normalizeType(options.type);
+        if (!itemName) {
+            if (interactive) {
+                const { select } = await import('@inquirer/prompts');
+                const type = await select({
+                    message: '您想显示什么？',
+                    choices: [
+                        { name: 'Change', value: 'change' },
+                        { name: 'Spec', value: 'spec' },
+                    ],
+                });
+                await this.runInteractiveByType(type, options);
+                return;
+            }
+            this.printNonInteractiveHint();
+            process.exitCode = 1;
+            return;
+        }
+        await this.showDirect(itemName, { typeOverride, options });
+    }
+    normalizeType(value) {
+        if (!value)
+            return undefined;
+        const v = value.toLowerCase();
+        if (v === 'change' || v === 'spec')
+            return v;
+        return undefined;
+    }
+    async runInteractiveByType(type, options) {
+        const { select } = await import('@inquirer/prompts');
+        if (type === 'change') {
+            const changes = await getActiveChangeIds();
+            if (changes.length === 0) {
+                console.error('未找到变更。');
+                process.exitCode = 1;
+                return;
+            }
+            const picked = await select({ message: '选择变更', choices: changes.map(id => ({ name: id, value: id })) });
+            const cmd = new ChangeCommand();
+            await cmd.show(picked, options);
+            return;
+        }
+        const specs = await getSpecIds();
+        if (specs.length === 0) {
+            console.error('未找到规范。');
+            process.exitCode = 1;
+            return;
+        }
+        const picked = await select({ message: '选择规范', choices: specs.map(id => ({ name: id, value: id })) });
+        const cmd = new SpecCommand();
+        await cmd.show(picked, options);
+    }
+    async showDirect(itemName, params) {
+        // Optimize lookups when type is pre-specified
+        let isChange = false;
+        let isSpec = false;
+        let changes = [];
+        let specs = [];
+        if (params.typeOverride === 'change') {
+            changes = await getActiveChangeIds();
+            isChange = changes.includes(itemName);
+        }
+        else if (params.typeOverride === 'spec') {
+            specs = await getSpecIds();
+            isSpec = specs.includes(itemName);
+        }
+        else {
+            [changes, specs] = await Promise.all([getActiveChangeIds(), getSpecIds()]);
+            isChange = changes.includes(itemName);
+            isSpec = specs.includes(itemName);
+        }
+        const resolvedType = params.typeOverride ?? (isChange ? 'change' : isSpec ? 'spec' : undefined);
+        if (!resolvedType) {
+            console.error(`未知项目 '${itemName}'`);
+            const suggestions = nearestMatches(itemName, [...changes, ...specs]);
+            if (suggestions.length)
+                console.error(`您是指：${suggestions.join(', ')}？`);
+            process.exitCode = 1;
+            return;
+        }
+        if (!params.typeOverride && isChange && isSpec) {
+            console.error(`项目 '${itemName}' 既匹配变更又匹配规范，存在歧义。`);
+            console.error('请传递 --type change|spec，或使用：zhuanspec change show / zhuanspec spec show');
+            process.exitCode = 1;
+            return;
+        }
+        this.warnIrrelevantFlags(resolvedType, params.options);
+        if (resolvedType === 'change') {
+            const cmd = new ChangeCommand();
+            await cmd.show(itemName, params.options);
+            return;
+        }
+        const cmd = new SpecCommand();
+        await cmd.show(itemName, params.options);
+    }
+    printNonInteractiveHint() {
+        console.error('没有可显示的内容。请尝试以下之一：');
+        console.error('  zhuanspec show <item>');
+        console.error('  zhuanspec change show');
+        console.error('  zhuanspec spec show');
+        console.error('或在交互式终端中运行。');
+    }
+    warnIrrelevantFlags(type, options) {
+        const irrelevant = [];
+        if (type === 'change') {
+            for (const k of SPEC_FLAG_KEYS)
+                if (k in options)
+                    irrelevant.push(k);
+        }
+        else {
+            for (const k of CHANGE_FLAG_KEYS)
+                if (k in options)
+                    irrelevant.push(k);
+        }
+        if (irrelevant.length > 0) {
+            console.error(`警告：忽略不适用于 ${type} 的标志：${irrelevant.join(', ')}`);
+            return true;
+        }
+        return false;
+    }
+}
+//# sourceMappingURL=show.js.map

package/dist/commands/spec.d.ts

@@ -0,0 +1,15 @@
+import { program } from 'commander';
+interface ShowOptions {
+    json?: boolean;
+    requirements?: boolean;
+    scenarios?: boolean;
+    requirement?: string;
+    noInteractive?: boolean;
+}
+export declare class SpecCommand {
+    private SPECS_DIR;
+    show(specId?: string, options?: ShowOptions): Promise<void>;
+}
+export declare function registerSpecCommand(rootProgram: typeof program): import("commander").Command;
+export {};
+//# sourceMappingURL=spec.d.ts.map

package/dist/commands/spec.js

@@ -0,0 +1,225 @@
+import { existsSync, readdirSync, readFileSync } from 'fs';
+import { join } from 'path';
+import { MarkdownParser } from '../core/parsers/markdown-parser.js';
+import { Validator } from '../core/validation/validator.js';
+import { isInteractive } from '../utils/interactive.js';
+import { getSpecIds } from '../utils/item-discovery.js';
+const SPECS_DIR = 'zhuanspec/specs';
+function parseSpecFromFile(specPath, specId) {
+    const content = readFileSync(specPath, 'utf-8');
+    const parser = new MarkdownParser(content);
+    return parser.parseSpec(specId);
+}
+function validateRequirementIndex(spec, requirementOpt) {
+    if (!requirementOpt)
+        return undefined;
+    const index = Number.parseInt(requirementOpt, 10);
+    if (!Number.isInteger(index) || index < 1 || index > spec.requirements.length) {
+        throw new Error(`Requirement ${requirementOpt} not found`);
+    }
+    return index - 1; // convert to 0-based
+}
+function filterSpec(spec, options) {
+    const requirementIndex = validateRequirementIndex(spec, options.requirement);
+    const includeScenarios = options.scenarios !== false && !options.requirements;
+    const filteredRequirements = (requirementIndex !== undefined
+        ? [spec.requirements[requirementIndex]]
+        : spec.requirements).map(req => ({
+        text: req.text,
+        scenarios: includeScenarios ? req.scenarios : [],
+    }));
+    const metadata = spec.metadata ?? { version: '1.0.0', format: 'zhuanspec' };
+    return {
+        name: spec.name,
+        overview: spec.overview,
+        requirements: filteredRequirements,
+        metadata,
+    };
+}
+/**
+ * Print the raw markdown content for a spec file without any formatting.
+ * Raw-first behavior ensures text mode is a passthrough for deterministic output.
+ */
+function printSpecTextRaw(specPath) {
+    const content = readFileSync(specPath, 'utf-8');
+    console.log(content);
+}
+export class SpecCommand {
+    SPECS_DIR = 'zhuanspec/specs';
+    async show(specId, options = {}) {
+        if (!specId) {
+            const canPrompt = isInteractive(options);
+            const specIds = await getSpecIds();
+            if (canPrompt && specIds.length > 0) {
+                const { select } = await import('@inquirer/prompts');
+                specId = await select({
+                    message: '选择要显示的规范',
+                    choices: specIds.map(id => ({ name: id, value: id })),
+                });
+            }
+            else {
+                throw new Error('Missing required argument <spec-id>');
+            }
+        }
+        const specPath = join(this.SPECS_DIR, specId, 'spec.md');
+        if (!existsSync(specPath)) {
+            throw new Error(`Spec '${specId}' not found at zhuanspec/specs/${specId}/spec.md`);
+        }
+        if (options.json) {
+            if (options.requirements && options.requirement) {
+                throw new Error('Options --requirements and --requirement cannot be used together');
+            }
+            const parsed = parseSpecFromFile(specPath, specId);
+            const filtered = filterSpec(parsed, options);
+            const output = {
+                id: specId,
+                title: parsed.name,
+                overview: parsed.overview,
+                requirementCount: filtered.requirements.length,
+                requirements: filtered.requirements,
+                metadata: parsed.metadata ?? { version: '1.0.0', format: 'zhuanspec' },
+            };
+            console.log(JSON.stringify(output, null, 2));
+            return;
+        }
+        printSpecTextRaw(specPath);
+    }
+}
+export function registerSpecCommand(rootProgram) {
+    const specCommand = rootProgram
+        .command('spec')
+        .description('Manage and view ZhuanSpec specifications');
+    // Deprecation notice for noun-based commands
+    specCommand.hook('preAction', () => {
+        console.error('Warning: The "zhuanspec spec ..." commands are deprecated. Prefer verb-first commands (e.g., "zhuanspec show", "zhuanspec validate --specs").');
+    });
+    specCommand
+        .command('show [spec-id]')
+        .description('Display a specific specification')
+        .option('--json', 'Output as JSON')
+        .option('--requirements', 'JSON only: Show only requirements (exclude scenarios)')
+        .option('--no-scenarios', 'JSON only: Exclude scenario content')
+        .option('-r, --requirement <id>', 'JSON only: Show specific requirement by ID (1-based)')
+        .option('--no-interactive', 'Disable interactive prompts')
+        .action(async (specId, options) => {
+        try {
+            const cmd = new SpecCommand();
+            await cmd.show(specId, options);
+        }
+        catch (error) {
+            console.error(`Error: ${error instanceof Error ? error.message : 'Unknown error'}`);
+            process.exitCode = 1;
+        }
+    });
+    specCommand
+        .command('list')
+        .description('List all available specifications')
+        .option('--json', 'Output as JSON')
+        .option('--long', 'Show id and title with counts')
+        .action((options) => {
+        try {
+            if (!existsSync(SPECS_DIR)) {
+                console.log('No items found');
+                return;
+            }
+            const specs = readdirSync(SPECS_DIR, { withFileTypes: true })
+                .filter(dirent => dirent.isDirectory())
+                .map(dirent => {
+                const specPath = join(SPECS_DIR, dirent.name, 'spec.md');
+                if (existsSync(specPath)) {
+                    try {
+                        const spec = parseSpecFromFile(specPath, dirent.name);
+                        return {
+                            id: dirent.name,
+                            title: spec.name,
+                            requirementCount: spec.requirements.length
+                        };
+                    }
+                    catch {
+                        return {
+                            id: dirent.name,
+                            title: dirent.name,
+                            requirementCount: 0
+                        };
+                    }
+                }
+                return null;
+            })
+                .filter((spec) => spec !== null)
+                .sort((a, b) => a.id.localeCompare(b.id));
+            if (options.json) {
+                console.log(JSON.stringify(specs, null, 2));
+            }
+            else {
+                if (specs.length === 0) {
+                    console.log('No items found');
+                    return;
+                }
+                if (!options.long) {
+                    specs.forEach(spec => console.log(spec.id));
+                    return;
+                }
+                specs.forEach(spec => {
+                    console.log(`${spec.id}: ${spec.title} [requirements ${spec.requirementCount}]`);
+                });
+            }
+        }
+        catch (error) {
+            console.error(`Error: ${error instanceof Error ? error.message : 'Unknown error'}`);
+            process.exitCode = 1;
+        }
+    });
+    specCommand
+        .command('validate [spec-id]')
+        .description('Validate a specification structure')
+        .option('--strict', 'Enable strict validation mode')
+        .option('--json', 'Output validation report as JSON')
+        .option('--no-interactive', 'Disable interactive prompts')
+        .action(async (specId, options) => {
+        try {
+            if (!specId) {
+                const canPrompt = isInteractive(options);
+                const specIds = await getSpecIds();
+                if (canPrompt && specIds.length > 0) {
+                    const { select } = await import('@inquirer/prompts');
+                    specId = await select({
+                        message: '选择要验证的规范',
+                        choices: specIds.map(id => ({ name: id, value: id })),
+                    });
+                }
+                else {
+                    throw new Error('Missing required argument <spec-id>');
+                }
+            }
+            const specPath = join(SPECS_DIR, specId, 'spec.md');
+            if (!existsSync(specPath)) {
+                throw new Error(`Spec '${specId}' not found at zhuanspec/specs/${specId}/spec.md`);
+            }
+            const validator = new Validator(options.strict);
+            const report = await validator.validateSpec(specPath);
+            if (options.json) {
+                console.log(JSON.stringify(report, null, 2));
+            }
+            else {
+                if (report.valid) {
+                    console.log(`Specification '${specId}' is valid`);
+                }
+                else {
+                    console.error(`Specification '${specId}' has issues`);
+                    report.issues.forEach(issue => {
+                        const label = issue.level === 'ERROR' ? 'ERROR' : issue.level;
+                        const prefix = issue.level === 'ERROR' ? '✗' : issue.level === 'WARNING' ? '⚠' : 'ℹ';
+                        console.error(`${prefix} [${label}] ${issue.path}: ${issue.message}`);
+                    });
+                }
+            }
+            process.exitCode = report.valid ? 0 : 1;
+        }
+        catch (error) {
+            console.error(`Error: ${error instanceof Error ? error.message : 'Unknown error'}`);
+            process.exitCode = 1;
+        }
+    });
+    return specCommand;
+}
+//# sourceMappingURL=spec.js.map

package/dist/commands/validate.d.ts

@@ -0,0 +1,24 @@
+interface ExecuteOptions {
+    all?: boolean;
+    changes?: boolean;
+    specs?: boolean;
+    type?: string;
+    strict?: boolean;
+    json?: boolean;
+    noInteractive?: boolean;
+    interactive?: boolean;
+    concurrency?: string;
+}
+export declare class ValidateCommand {
+    execute(itemName: string | undefined, options?: ExecuteOptions): Promise<void>;
+    private normalizeType;
+    private runInteractiveSelector;
+    private printNonInteractiveHint;
+    private validateDirectItem;
+    private validateByType;
+    private printReport;
+    private printNextSteps;
+    private runBulkValidation;
+}
+export {};
+//# sourceMappingURL=validate.d.ts.map