@dynamicworks/br-openspec 1.3.1

package/dist/core/completions/command-registry.js

@@ -0,0 +1,462 @@
+import { CLI_DESCRIPTIONS, CONFIG_MESSAGES, SCHEMA_MESSAGES } from '../../messages/index.js';
+/**
+ * Common flags used across multiple commands
+ */
+const COMMON_FLAGS = {
+    json: {
+        name: 'json',
+        description: CLI_DESCRIPTIONS.showJson,
+    },
+    jsonValidation: {
+        name: 'json',
+        description: CLI_DESCRIPTIONS.validateJson,
+    },
+    strict: {
+        name: 'strict',
+        description: CLI_DESCRIPTIONS.validateStrict,
+    },
+    noInteractive: {
+        name: 'no-interactive',
+        description: CLI_DESCRIPTIONS.showNoInteractive,
+    },
+    type: {
+        name: 'type',
+        description: CLI_DESCRIPTIONS.validateType,
+        takesValue: true,
+        values: ['change', 'spec'],
+    },
+};
+/**
+ * Registry of all BR-OpenSpec CLI commands with their flags and metadata.
+ * This registry is used to generate shell completion scripts.
+ */
+export const COMMAND_REGISTRY = [
+    {
+        name: 'init',
+        description: CLI_DESCRIPTIONS.init,
+        acceptsPositional: true,
+        positionalType: 'path',
+        flags: [
+            {
+                name: 'tools',
+                description: CLI_DESCRIPTIONS.toolsOption,
+                takesValue: true,
+            },
+        ],
+    },
+    {
+        name: 'update',
+        description: CLI_DESCRIPTIONS.update,
+        acceptsPositional: true,
+        positionalType: 'path',
+        flags: [],
+    },
+    {
+        name: 'list',
+        description: CLI_DESCRIPTIONS.list,
+        flags: [
+            {
+                name: 'specs',
+                description: CLI_DESCRIPTIONS.listSpecs,
+            },
+            {
+                name: 'changes',
+                description: CLI_DESCRIPTIONS.listChanges,
+            },
+        ],
+    },
+    {
+        name: 'view',
+        description: CLI_DESCRIPTIONS.view,
+        flags: [],
+    },
+    {
+        name: 'validate',
+        description: CLI_DESCRIPTIONS.validate,
+        acceptsPositional: true,
+        positionalType: 'change-or-spec-id',
+        flags: [
+            {
+                name: 'all',
+                description: CLI_DESCRIPTIONS.validateAll,
+            },
+            {
+                name: 'changes',
+                description: CLI_DESCRIPTIONS.validateChanges,
+            },
+            {
+                name: 'specs',
+                description: CLI_DESCRIPTIONS.validateSpecs,
+            },
+            COMMON_FLAGS.type,
+            COMMON_FLAGS.strict,
+            COMMON_FLAGS.jsonValidation,
+            {
+                name: 'concurrency',
+                description: CLI_DESCRIPTIONS.validateConcurrency,
+                takesValue: true,
+            },
+            COMMON_FLAGS.noInteractive,
+        ],
+    },
+    {
+        name: 'show',
+        description: CLI_DESCRIPTIONS.show,
+        acceptsPositional: true,
+        positionalType: 'change-or-spec-id',
+        flags: [
+            COMMON_FLAGS.json,
+            COMMON_FLAGS.type,
+            COMMON_FLAGS.noInteractive,
+            {
+                name: 'deltas-only',
+                description: CLI_DESCRIPTIONS.showDeltasOnly,
+            },
+            {
+                name: 'requirements-only',
+                description: CLI_DESCRIPTIONS.showRequirementsOnly,
+            },
+            {
+                name: 'requirements',
+                description: CLI_DESCRIPTIONS.showRequirements,
+            },
+            {
+                name: 'no-scenarios',
+                description: CLI_DESCRIPTIONS.showNoScenarios,
+            },
+            {
+                name: 'requirement',
+                short: 'r',
+                description: CLI_DESCRIPTIONS.showRequirement,
+                takesValue: true,
+            },
+        ],
+    },
+    {
+        name: 'archive',
+        description: CLI_DESCRIPTIONS.archive,
+        acceptsPositional: true,
+        positionalType: 'change-id',
+        flags: [
+            {
+                name: 'yes',
+                short: 'y',
+                description: CLI_DESCRIPTIONS.archiveYes,
+            },
+            {
+                name: 'skip-specs',
+                description: CLI_DESCRIPTIONS.archiveSkipSpecs,
+            },
+            {
+                name: 'no-validate',
+                description: CLI_DESCRIPTIONS.archiveNoValidate,
+            },
+        ],
+    },
+    {
+        name: 'feedback',
+        description: CLI_DESCRIPTIONS.feedback,
+        acceptsPositional: true,
+        flags: [
+            {
+                name: 'body',
+                description: CLI_DESCRIPTIONS.feedbackBody,
+                takesValue: true,
+            },
+        ],
+    },
+    {
+        name: 'change',
+        description: CLI_DESCRIPTIONS.change,
+        flags: [],
+        subcommands: [
+            {
+                name: 'show',
+                description: CLI_DESCRIPTIONS.changeShow,
+                acceptsPositional: true,
+                positionalType: 'change-id',
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'deltas-only',
+                        description: CLI_DESCRIPTIONS.changeShowDeltasOnly,
+                    },
+                    {
+                        name: 'requirements-only',
+                        description: CLI_DESCRIPTIONS.changeShowRequirementsOnly,
+                    },
+                    COMMON_FLAGS.noInteractive,
+                ],
+            },
+            {
+                name: 'list',
+                description: CLI_DESCRIPTIONS.changeList,
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'long',
+                        description: CLI_DESCRIPTIONS.changeListLong,
+                    },
+                ],
+            },
+            {
+                name: 'validate',
+                description: CLI_DESCRIPTIONS.changeValidate,
+                acceptsPositional: true,
+                positionalType: 'change-id',
+                flags: [
+                    COMMON_FLAGS.strict,
+                    COMMON_FLAGS.jsonValidation,
+                    COMMON_FLAGS.noInteractive,
+                ],
+            },
+        ],
+    },
+    {
+        name: 'spec',
+        description: CLI_DESCRIPTIONS.spec,
+        flags: [],
+        subcommands: [
+            {
+                name: 'show',
+                description: CLI_DESCRIPTIONS.specShow,
+                acceptsPositional: true,
+                positionalType: 'spec-id',
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'requirements',
+                        description: CLI_DESCRIPTIONS.specShowRequirements,
+                    },
+                    {
+                        name: 'no-scenarios',
+                        description: CLI_DESCRIPTIONS.specShowNoScenarios,
+                    },
+                    {
+                        name: 'requirement',
+                        short: 'r',
+                        description: CLI_DESCRIPTIONS.specShowRequirement,
+                        takesValue: true,
+                    },
+                    COMMON_FLAGS.noInteractive,
+                ],
+            },
+            {
+                name: 'list',
+                description: CLI_DESCRIPTIONS.specList,
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'long',
+                        description: CLI_DESCRIPTIONS.specListLong,
+                    },
+                ],
+            },
+            {
+                name: 'validate',
+                description: CLI_DESCRIPTIONS.specValidate,
+                acceptsPositional: true,
+                positionalType: 'spec-id',
+                flags: [
+                    COMMON_FLAGS.strict,
+                    COMMON_FLAGS.jsonValidation,
+                    COMMON_FLAGS.noInteractive,
+                ],
+            },
+        ],
+    },
+    {
+        name: 'completion',
+        description: CLI_DESCRIPTIONS.completion,
+        flags: [],
+        subcommands: [
+            {
+                name: 'generate',
+                description: CLI_DESCRIPTIONS.completionGenerate,
+                acceptsPositional: true,
+                positionalType: 'shell',
+                flags: [],
+            },
+            {
+                name: 'install',
+                description: CLI_DESCRIPTIONS.completionInstall,
+                acceptsPositional: true,
+                positionalType: 'shell',
+                flags: [
+                    {
+                        name: 'verbose',
+                        description: CLI_DESCRIPTIONS.completionVerbose,
+                    },
+                ],
+            },
+            {
+                name: 'uninstall',
+                description: CLI_DESCRIPTIONS.completionUninstall,
+                acceptsPositional: true,
+                positionalType: 'shell',
+                flags: [
+                    {
+                        name: 'yes',
+                        short: 'y',
+                        description: CLI_DESCRIPTIONS.yesSkipConfirm,
+                    },
+                ],
+            },
+        ],
+    },
+    {
+        name: 'config',
+        description: CONFIG_MESSAGES.viewAndModify,
+        flags: [
+            {
+                name: 'scope',
+                description: CONFIG_MESSAGES.configScopeOption,
+                takesValue: true,
+                values: ['global'],
+            },
+        ],
+        subcommands: [
+            {
+                name: 'path',
+                description: CONFIG_MESSAGES.showLocation,
+                flags: [],
+            },
+            {
+                name: 'list',
+                description: CONFIG_MESSAGES.showAllSettings,
+                flags: [
+                    COMMON_FLAGS.json,
+                ],
+            },
+            {
+                name: 'get',
+                description: CONFIG_MESSAGES.getValue,
+                acceptsPositional: true,
+                flags: [],
+            },
+            {
+                name: 'set',
+                description: CONFIG_MESSAGES.setValue,
+                acceptsPositional: true,
+                flags: [
+                    {
+                        name: 'string',
+                        description: CONFIG_MESSAGES.forceStringOption,
+                    },
+                    {
+                        name: 'allow-unknown',
+                        description: CONFIG_MESSAGES.allowUnknownOption,
+                    },
+                ],
+            },
+            {
+                name: 'unset',
+                description: CONFIG_MESSAGES.removeKey,
+                acceptsPositional: true,
+                flags: [],
+            },
+            {
+                name: 'reset',
+                description: CONFIG_MESSAGES.resetConfig,
+                flags: [
+                    {
+                        name: 'all',
+                        description: CONFIG_MESSAGES.resetAllOption,
+                    },
+                    {
+                        name: 'yes',
+                        short: 'y',
+                        description: CLI_DESCRIPTIONS.yesSkipConfirm,
+                    },
+                ],
+            },
+            {
+                name: 'edit',
+                description: CONFIG_MESSAGES.openInEditor,
+                flags: [],
+            },
+            {
+                name: 'profile',
+                description: CONFIG_MESSAGES.configureProfile,
+                flags: [],
+            },
+        ],
+    },
+    {
+        name: 'schema',
+        description: SCHEMA_MESSAGES.manageWorkflows,
+        flags: [],
+        subcommands: [
+            {
+                name: 'which',
+                description: SCHEMA_MESSAGES.showResolve,
+                acceptsPositional: true,
+                positionalType: 'schema-name',
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'all',
+                        description: SCHEMA_MESSAGES.listAllSchemasOption,
+                    },
+                ],
+            },
+            {
+                name: 'validate',
+                description: SCHEMA_MESSAGES.validateStructure,
+                acceptsPositional: true,
+                positionalType: 'schema-name',
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'verbose',
+                        description: SCHEMA_MESSAGES.verboseOption,
+                    },
+                ],
+            },
+            {
+                name: 'fork',
+                description: SCHEMA_MESSAGES.copySchema,
+                acceptsPositional: true,
+                positionalType: 'schema-name',
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'force',
+                        description: SCHEMA_MESSAGES.forceOption,
+                    },
+                ],
+            },
+            {
+                name: 'init',
+                description: SCHEMA_MESSAGES.createSchema,
+                acceptsPositional: true,
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'description',
+                        description: SCHEMA_MESSAGES.descriptionOption,
+                        takesValue: true,
+                    },
+                    {
+                        name: 'artifacts',
+                        description: SCHEMA_MESSAGES.artifactsOption,
+                        takesValue: true,
+                    },
+                    {
+                        name: 'default',
+                        description: SCHEMA_MESSAGES.defaultOption,
+                    },
+                    {
+                        name: 'no-default',
+                        description: SCHEMA_MESSAGES.noDefaultOption,
+                    },
+                    {
+                        name: 'force',
+                        description: SCHEMA_MESSAGES.forceOption2,
+                    },
+                ],
+            },
+        ],
+    },
+];
+//# sourceMappingURL=command-registry.js.map

package/dist/core/completions/completion-provider.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Provides dynamic completion suggestions for OpenSpec items (changes and specs).
+ * Implements a 2-second cache to avoid excessive file system operations during
+ * tab completion.
+ */
+export declare class CompletionProvider {
+    private readonly cacheTTLMs;
+    private readonly projectRoot;
+    private readonly cacheTTL;
+    private changeCache;
+    private specCache;
+    /**
+     * Creates a new completion provider
+     *
+     * @param cacheTTLMs - Cache time-to-live in milliseconds (default: 2000ms)
+     * @param projectRoot - Project root directory (default: process.cwd())
+     */
+    constructor(cacheTTLMs?: number, projectRoot?: string);
+    /**
+     * Get all active change IDs for completion
+     *
+     * @returns Array of change IDs
+     */
+    getChangeIds(): Promise<string[]>;
+    /**
+     * Get all spec IDs for completion
+     *
+     * @returns Array of spec IDs
+     */
+    getSpecIds(): Promise<string[]>;
+    /**
+     * Get both change and spec IDs for completion
+     *
+     * @returns Object with changeIds and specIds arrays
+     */
+    getAllIds(): Promise<{
+        changeIds: string[];
+        specIds: string[];
+    }>;
+    /**
+     * Clear all cached data
+     */
+    clearCache(): void;
+    /**
+     * Get cache statistics for debugging
+     *
+     * @returns Cache status information
+     */
+    getCacheStats(): {
+        changeCache: {
+            valid: boolean;
+            age?: number;
+        };
+        specCache: {
+            valid: boolean;
+            age?: number;
+        };
+    };
+}
+//# sourceMappingURL=completion-provider.d.ts.map

package/dist/core/completions/completion-provider.js

@@ -0,0 +1,102 @@
+import { getActiveChangeIds, getSpecIds } from '../../utils/item-discovery.js';
+/**
+ * Provides dynamic completion suggestions for OpenSpec items (changes and specs).
+ * Implements a 2-second cache to avoid excessive file system operations during
+ * tab completion.
+ */
+export class CompletionProvider {
+    cacheTTLMs;
+    projectRoot;
+    cacheTTL;
+    changeCache = null;
+    specCache = null;
+    /**
+     * Creates a new completion provider
+     *
+     * @param cacheTTLMs - Cache time-to-live in milliseconds (default: 2000ms)
+     * @param projectRoot - Project root directory (default: process.cwd())
+     */
+    constructor(cacheTTLMs = 2000, projectRoot = process.cwd()) {
+        this.cacheTTLMs = cacheTTLMs;
+        this.projectRoot = projectRoot;
+        this.cacheTTL = cacheTTLMs;
+    }
+    /**
+     * Get all active change IDs for completion
+     *
+     * @returns Array of change IDs
+     */
+    async getChangeIds() {
+        const now = Date.now();
+        // Check if cache is valid
+        if (this.changeCache && now - this.changeCache.timestamp < this.cacheTTL) {
+            return this.changeCache.data;
+        }
+        // Fetch fresh data
+        const changeIds = await getActiveChangeIds(this.projectRoot);
+        // Update cache
+        this.changeCache = {
+            data: changeIds,
+            timestamp: now,
+        };
+        return changeIds;
+    }
+    /**
+     * Get all spec IDs for completion
+     *
+     * @returns Array of spec IDs
+     */
+    async getSpecIds() {
+        const now = Date.now();
+        // Check if cache is valid
+        if (this.specCache && now - this.specCache.timestamp < this.cacheTTL) {
+            return this.specCache.data;
+        }
+        // Fetch fresh data
+        const specIds = await getSpecIds(this.projectRoot);
+        // Update cache
+        this.specCache = {
+            data: specIds,
+            timestamp: now,
+        };
+        return specIds;
+    }
+    /**
+     * Get both change and spec IDs for completion
+     *
+     * @returns Object with changeIds and specIds arrays
+     */
+    async getAllIds() {
+        const [changeIds, specIds] = await Promise.all([
+            this.getChangeIds(),
+            this.getSpecIds(),
+        ]);
+        return { changeIds, specIds };
+    }
+    /**
+     * Clear all cached data
+     */
+    clearCache() {
+        this.changeCache = null;
+        this.specCache = null;
+    }
+    /**
+     * Get cache statistics for debugging
+     *
+     * @returns Cache status information
+     */
+    getCacheStats() {
+        const now = Date.now();
+        return {
+            changeCache: {
+                valid: this.changeCache !== null && now - this.changeCache.timestamp < this.cacheTTL,
+                age: this.changeCache ? now - this.changeCache.timestamp : undefined,
+            },
+            specCache: {
+                valid: this.specCache !== null && now - this.specCache.timestamp < this.cacheTTL,
+                age: this.specCache ? now - this.specCache.timestamp : undefined,
+            },
+        };
+    }
+}
+//# sourceMappingURL=completion-provider.js.map

package/dist/core/completions/factory.d.ts

@@ -0,0 +1,64 @@
+import { CompletionGenerator } from './types.js';
+import { SupportedShell } from '../../utils/shell-detection.js';
+/**
+ * Common installation result interface
+ */
+export interface InstallationResult {
+    success: boolean;
+    installedPath?: string;
+    backupPath?: string;
+    message: string;
+    instructions?: string[];
+    warnings?: string[];
+    isOhMyZsh?: boolean;
+    zshrcConfigured?: boolean;
+    bashrcConfigured?: boolean;
+    profileConfigured?: boolean;
+}
+/**
+ * Interface for completion installers
+ */
+export interface CompletionInstaller {
+    install(script: string): Promise<InstallationResult>;
+    uninstall(): Promise<{
+        success: boolean;
+        message: string;
+    }>;
+}
+/**
+ * Factory for creating completion generators and installers
+ * This design makes it easy to add support for additional shells
+ */
+export declare class CompletionFactory {
+    private static readonly SUPPORTED_SHELLS;
+    /**
+     * Create a completion generator for the specified shell
+     *
+     * @param shell - The target shell
+     * @returns CompletionGenerator instance
+     * @throws Error if shell is not supported
+     */
+    static createGenerator(shell: SupportedShell): CompletionGenerator;
+    /**
+     * Create a completion installer for the specified shell
+     *
+     * @param shell - The target shell
+     * @returns CompletionInstaller instance
+     * @throws Error if shell is not supported
+     */
+    static createInstaller(shell: SupportedShell): CompletionInstaller;
+    /**
+     * Check if a shell is supported
+     *
+     * @param shell - The shell to check
+     * @returns true if the shell is supported
+     */
+    static isSupported(shell: string): shell is SupportedShell;
+    /**
+     * Get list of all supported shells
+     *
+     * @returns Array of supported shell names
+     */
+    static getSupportedShells(): SupportedShell[];
+}
+//# sourceMappingURL=factory.d.ts.map