openspec-cn 0.23.0

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: 'What would you like to show?',
+                    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('No changes found.');
+                process.exitCode = 1;
+                return;
+            }
+            const picked = await select({ message: 'Pick a change', 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('No specs found.');
+            process.exitCode = 1;
+            return;
+        }
+        const picked = await select({ message: 'Pick a spec', 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(`Unknown item '${itemName}'`);
+            const suggestions = nearestMatches(itemName, [...changes, ...specs]);
+            if (suggestions.length)
+                console.error(`Did you mean: ${suggestions.join(', ')}?`);
+            process.exitCode = 1;
+            return;
+        }
+        if (!params.typeOverride && isChange && isSpec) {
+            console.error(`Ambiguous item '${itemName}' matches both a change and a spec.`);
+            console.error('Pass --type change|spec, or use: openspec change show / openspec 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('Nothing to show. Try one of:');
+        console.error('  openspec show <item>');
+        console.error('  openspec change show');
+        console.error('  openspec spec show');
+        console.error('Or run in an interactive terminal.');
+    }
+    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(`Warning: Ignoring flags not applicable to ${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 = 'openspec/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: 'openspec' };
+    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 = 'openspec/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: 'Select a spec to show',
+                    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 openspec/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: 'openspec' },
+            };
+            console.log(JSON.stringify(output, null, 2));
+            return;
+        }
+        printSpecTextRaw(specPath);
+    }
+}
+export function registerSpecCommand(rootProgram) {
+    const specCommand = rootProgram
+        .command('spec')
+        .description('Manage and view OpenSpec specifications');
+    // Deprecation notice for noun-based commands
+    specCommand.hook('preAction', () => {
+        console.error('Warning: The "openspec spec ..." commands are deprecated. Prefer verb-first commands (e.g., "openspec show", "openspec 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: 'Select a spec to validate',
+                        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 openspec/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