@fission-ai/openspec 0.16.0 → 0.17.0

package/dist/commands/config.js

@@ -0,0 +1,198 @@
+import { confirm } from '@inquirer/prompts';
+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 OpenSpec 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('Error: Project-local config is not yet implemented');
+            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(`Error: Invalid configuration key "${key}".${reason}`);
+            console.error('Use "openspec config list" to see available keys.');
+            console.error('Pass --allow-unknown to bypass this check.');
+            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(`Error: Invalid configuration - ${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(`Set ${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(`Unset ${key} (reverted to default)`);
+        }
+        else {
+            console.log(`Key "${key}" was not set`);
+        }
+    });
+    // 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('Error: --all flag is required for reset');
+            console.error('Usage: openspec config reset --all [-y]');
+            process.exitCode = 1;
+            return;
+        }
+        if (!options.yes) {
+            const confirmed = await confirm({
+                message: 'Reset all configuration to defaults?',
+                default: false,
+            });
+            if (!confirmed) {
+                console.log('Reset cancelled.');
+                return;
+            }
+        }
+        saveGlobalConfig({ ...DEFAULT_CONFIG });
+        console.log('Configuration reset to defaults');
+    });
+    // config edit
+    configCmd
+        .command('edit')
+        .description('Open config in $EDITOR')
+        .action(async () => {
+        const editor = process.env.EDITOR || process.env.VISUAL;
+        if (!editor) {
+            console.error('Error: No editor configured');
+            console.error('Set the EDITOR or VISUAL environment variable to your preferred editor');
+            console.error('Example: 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(`Error: Invalid configuration - ${validation.error}`);
+                process.exitCode = 1;
+            }
+        }
+        catch (error) {
+            if (error.code === 'ENOENT') {
+                console.error(`Error: Config file not found at ${configPath}`);
+            }
+            else if (error instanceof SyntaxError) {
+                console.error(`Error: Invalid JSON in ${configPath}`);
+                console.error(error.message);
+            }
+            else {
+                console.error(`Error: Unable to validate configuration - ${error instanceof Error ? error.message : String(error)}`);
+            }
+            process.exitCode = 1;
+        }
+    });
+}
+//# sourceMappingURL=config.js.map

package/dist/commands/show.js

@@ -1,4 +1,3 @@
-import { select } from '@inquirer/prompts';
 import { isInteractive } from '../utils/interactive.js';
 import { getActiveChangeIds, getSpecIds } from '../utils/item-discovery.js';
 import { ChangeCommand } from './change.js';
@@ -8,10 +7,11 @@ 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.noInteractive);
+        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: [
@@ -37,6 +37,7 @@ export class ShowCommand {
         return undefined;
     }
     async runInteractiveByType(type, options) {
+        const { select } = await import('@inquirer/prompts');
         if (type === 'change') {
             const changes = await getActiveChangeIds();
             if (changes.length === 0) {

package/dist/commands/spec.js

@@ -2,7 +2,6 @@ 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 { select } from '@inquirer/prompts';
 import { isInteractive } from '../utils/interactive.js';
 import { getSpecIds } from '../utils/item-discovery.js';
 const SPECS_DIR = 'openspec/specs';
@@ -49,9 +48,10 @@ export class SpecCommand {
     SPECS_DIR = 'openspec/specs';
     async show(specId, options = {}) {
         if (!specId) {
-            const canPrompt = isInteractive(options?.noInteractive);
+            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 })),
@@ -178,9 +178,10 @@ export function registerSpecCommand(rootProgram) {
         .action(async (specId, options) => {
         try {
             if (!specId) {
-                const canPrompt = isInteractive(options?.noInteractive);
+                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 })),

package/dist/commands/validate.js

@@ -1,4 +1,3 @@
-import { select } from '@inquirer/prompts';
 import ora from 'ora';
 import path from 'path';
 import { Validator } from '../core/validation/validator.js';
@@ -7,7 +6,7 @@ import { getActiveChangeIds, getSpecIds } from '../utils/item-discovery.js';
 import { nearestMatches } from '../utils/match.js';
 export class ValidateCommand {
     async execute(itemName, options = {}) {
-        const interactive = isInteractive(options.noInteractive);
+        const interactive = isInteractive(options);
         // Handle bulk flags first
         if (options.all || options.changes || options.specs) {
             await this.runBulkValidation({
@@ -39,6 +38,7 @@ export class ValidateCommand {
         return undefined;
     }
     async runInteractiveSelector(opts) {
+        const { select } = await import('@inquirer/prompts');
         const choice = await select({
             message: 'What would you like to validate?',
             choices: [
@@ -178,6 +178,25 @@ export class ValidateCommand {
                 return { id, type: 'spec', valid: report.valid, issues: report.issues, durationMs };
             });
         }
+        if (queue.length === 0) {
+            spinner?.stop();
+            const summary = {
+                totals: { items: 0, passed: 0, failed: 0 },
+                byType: {
+                    ...(scope.changes ? { change: { items: 0, passed: 0, failed: 0 } } : {}),
+                    ...(scope.specs ? { spec: { items: 0, passed: 0, failed: 0 } } : {}),
+                },
+            };
+            if (opts.json) {
+                const out = { items: [], summary, version: '1.0' };
+                console.log(JSON.stringify(out, null, 2));
+            }
+            else {
+                console.log('No items found to validate.');
+            }
+            process.exitCode = 0;
+            return;
+        }
         const results = [];
         let index = 0;
         let running = 0;

package/dist/core/archive.js

@@ -1,6 +1,5 @@
 import { promises as fs } from 'fs';
 import path from 'path';
-import { select, confirm } from '@inquirer/prompts';
 import { getTaskProgressForChange, formatTaskStatus } from '../utils/task-progress.js';
 import { Validator } from './validation/validator.js';
 import chalk from 'chalk';
@@ -106,6 +105,7 @@ export class ArchiveCommand {
             // Log warning when validation is skipped
             const timestamp = new Date().toISOString();
             if (!options.yes) {
+                const { confirm } = await import('@inquirer/prompts');
                 const proceed = await confirm({
                     message: chalk.yellow('⚠️  WARNING: Skipping validation may archive invalid specs. Continue? (y/N)'),
                     default: false
@@ -128,6 +128,7 @@ export class ArchiveCommand {
         const incompleteTasks = Math.max(progress.total - progress.completed, 0);
         if (incompleteTasks > 0) {
             if (!options.yes) {
+                const { confirm } = await import('@inquirer/prompts');
                 const proceed = await confirm({
                     message: `Warning: ${incompleteTasks} incomplete task(s) found. Continue?`,
                     default: false
@@ -157,6 +158,7 @@ export class ArchiveCommand {
                 }
                 let shouldUpdateSpecs = true;
                 if (!options.yes) {
+                    const { confirm } = await import('@inquirer/prompts');
                     shouldUpdateSpecs = await confirm({
                         message: 'Proceed with spec updates?',
                         default: true
@@ -228,6 +230,7 @@ export class ArchiveCommand {
         console.log(`Change '${changeName}' archived as '${archiveName}'.`);
     }
     async selectChange(changesDir) {
+        const { select } = await import('@inquirer/prompts');
         // Get all directories in changes (excluding archive)
         const entries = await fs.readdir(changesDir, { withFileTypes: true });
         const changeDirs = entries

package/dist/core/completions/command-registry.d.ts

@@ -0,0 +1,7 @@
+import { CommandDefinition } from './types.js';
+/**
+ * Registry of all OpenSpec CLI commands with their flags and metadata.
+ * This registry is used to generate shell completion scripts.
+ */
+export declare const COMMAND_REGISTRY: CommandDefinition[];
+//# sourceMappingURL=command-registry.d.ts.map