synarcx 0.1.0

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

@@ -0,0 +1,596 @@
+/**
+ * Common flags used across multiple commands
+ */
+const COMMON_FLAGS = {
+    json: {
+        name: 'json',
+        description: 'Output as JSON',
+    },
+    jsonValidation: {
+        name: 'json',
+        description: 'Output validation results as JSON',
+    },
+    strict: {
+        name: 'strict',
+        description: 'Enable strict validation mode',
+    },
+    noInteractive: {
+        name: 'no-interactive',
+        description: 'Disable interactive prompts',
+    },
+    type: {
+        name: 'type',
+        description: 'Specify item type when ambiguous',
+        takesValue: true,
+        values: ['change', 'spec'],
+    },
+};
+/**
+ * Registry of all synarcx CLI commands with their flags and metadata.
+ * This registry is used to generate shell completion scripts.
+ */
+export const COMMAND_REGISTRY = [
+    {
+        name: 'init',
+        description: 'Initialize synarcx in your project',
+        acceptsPositional: true,
+        positionalType: 'path',
+        flags: [
+            {
+                name: 'tools',
+                description: 'Configure AI tools non-interactively (e.g., "all", "none", or comma-separated tool IDs)',
+                takesValue: true,
+            },
+        ],
+    },
+    {
+        name: 'update',
+        description: 'Update synarcx instruction files',
+        acceptsPositional: true,
+        positionalType: 'path',
+        flags: [],
+    },
+    {
+        name: 'list',
+        description: 'List items (changes by default, or specs with --specs)',
+        flags: [
+            {
+                name: 'specs',
+                description: 'List specs instead of changes',
+            },
+            {
+                name: 'changes',
+                description: 'List changes explicitly (default)',
+            },
+        ],
+    },
+    {
+        name: 'view',
+        description: 'Display an interactive dashboard of specs and changes',
+        flags: [],
+    },
+    {
+        name: 'validate',
+        description: 'Validate changes and specs',
+        acceptsPositional: true,
+        positionalType: 'change-or-spec-id',
+        flags: [
+            {
+                name: 'all',
+                description: 'Validate all changes and specs',
+            },
+            {
+                name: 'changes',
+                description: 'Validate all changes',
+            },
+            {
+                name: 'specs',
+                description: 'Validate all specs',
+            },
+            COMMON_FLAGS.type,
+            COMMON_FLAGS.strict,
+            COMMON_FLAGS.jsonValidation,
+            {
+                name: 'concurrency',
+                description: 'Max concurrent validations (defaults to env SYNARCX_CONCURRENCY or 6)',
+                takesValue: true,
+            },
+            COMMON_FLAGS.noInteractive,
+        ],
+    },
+    {
+        name: 'show',
+        description: 'Show a change or spec',
+        acceptsPositional: true,
+        positionalType: 'change-or-spec-id',
+        flags: [
+            COMMON_FLAGS.json,
+            COMMON_FLAGS.type,
+            COMMON_FLAGS.noInteractive,
+            {
+                name: 'deltas-only',
+                description: 'Show only deltas (JSON only, change-specific)',
+            },
+            {
+                name: 'requirements-only',
+                description: 'Alias for --deltas-only (deprecated, change-specific)',
+            },
+            {
+                name: 'requirements',
+                description: 'Show only requirements, exclude scenarios (JSON only, spec-specific)',
+            },
+            {
+                name: 'no-scenarios',
+                description: 'Exclude scenario content (JSON only, spec-specific)',
+            },
+            {
+                name: 'requirement',
+                short: 'r',
+                description: 'Show specific requirement by ID (JSON only, spec-specific)',
+                takesValue: true,
+            },
+        ],
+    },
+    {
+        name: 'archive',
+        description: 'Archive a completed change and update main specs',
+        acceptsPositional: true,
+        positionalType: 'change-id',
+        flags: [
+            {
+                name: 'yes',
+                short: 'y',
+                description: 'Skip confirmation prompts',
+            },
+            {
+                name: 'skip-specs',
+                description: 'Skip spec update operations',
+            },
+            {
+                name: 'no-validate',
+                description: 'Skip validation (not recommended)',
+            },
+        ],
+    },
+    {
+        name: 'workspace',
+        description: 'Set up and inspect coordination workspaces',
+        flags: [],
+        subcommands: [
+            {
+                name: 'setup',
+                description: 'Set up a workspace and link existing repos or folders',
+                flags: [
+                    {
+                        name: 'name',
+                        description: 'Workspace name',
+                        takesValue: true,
+                    },
+                    {
+                        name: 'link',
+                        description: 'Repo or folder link. Use <path> or <name>=<path>',
+                        takesValue: true,
+                    },
+                    {
+                        name: 'opener',
+                        description: 'Preferred opener: codex, claude, github-copilot, or editor',
+                        takesValue: true,
+                        values: ['codex', 'claude', 'github-copilot', 'editor'],
+                    },
+                    COMMON_FLAGS.json,
+                    COMMON_FLAGS.noInteractive,
+                ],
+            },
+            {
+                name: 'list',
+                description: 'List known synarcx workspaces',
+                flags: [
+                    COMMON_FLAGS.json,
+                ],
+            },
+            {
+                name: 'ls',
+                description: 'List known synarcx workspaces',
+                flags: [
+                    COMMON_FLAGS.json,
+                ],
+            },
+            {
+                name: 'link',
+                description: 'Link an existing repo or folder to a workspace',
+                acceptsPositional: true,
+                positionals: [
+                    {
+                        name: 'name-or-path',
+                        type: 'path',
+                        optional: true,
+                    },
+                    {
+                        name: 'path',
+                        type: 'path',
+                    },
+                ],
+                flags: [
+                    {
+                        name: 'workspace',
+                        description: 'Workspace name from the local workspace registry',
+                        takesValue: true,
+                    },
+                    COMMON_FLAGS.json,
+                    COMMON_FLAGS.noInteractive,
+                ],
+            },
+            {
+                name: 'relink',
+                description: 'Update the local path for an existing workspace link',
+                acceptsPositional: true,
+                positionals: [
+                    {
+                        name: 'name',
+                    },
+                    {
+                        name: 'path',
+                        type: 'path',
+                    },
+                ],
+                flags: [
+                    {
+                        name: 'workspace',
+                        description: 'Workspace name from the local workspace registry',
+                        takesValue: true,
+                    },
+                    COMMON_FLAGS.json,
+                    COMMON_FLAGS.noInteractive,
+                ],
+            },
+            {
+                name: 'doctor',
+                description: 'Check what a workspace can resolve on this machine',
+                flags: [
+                    {
+                        name: 'workspace',
+                        description: 'Workspace name from the local workspace registry',
+                        takesValue: true,
+                    },
+                    COMMON_FLAGS.json,
+                    COMMON_FLAGS.noInteractive,
+                ],
+            },
+            {
+                name: 'open',
+                description: 'Open a workspace in an agent or VS Code editor',
+                acceptsPositional: true,
+                positionals: [
+                    {
+                        name: 'name',
+                        optional: true,
+                    },
+                ],
+                flags: [
+                    {
+                        name: 'workspace',
+                        description: 'Workspace name from the local workspace registry',
+                        takesValue: true,
+                    },
+                    {
+                        name: 'agent',
+                        description: 'Use an agent for this session: codex, claude, or github-copilot',
+                        takesValue: true,
+                        values: ['codex', 'claude', 'github-copilot'],
+                    },
+                    {
+                        name: 'editor',
+                        description: 'Open the workspace in VS Code editor mode',
+                    },
+                    COMMON_FLAGS.noInteractive,
+                ],
+            },
+        ],
+    },
+    {
+        name: 'feedback',
+        description: 'Submit feedback',
+        acceptsPositional: true,
+        flags: [
+            {
+                name: 'body',
+                description: 'Detailed description for the feedback',
+                takesValue: true,
+            },
+        ],
+    },
+    {
+        name: 'change',
+        description: 'Manage synarcx change proposals (deprecated)',
+        flags: [],
+        subcommands: [
+            {
+                name: 'show',
+                description: 'Show a change proposal',
+                acceptsPositional: true,
+                positionalType: 'change-id',
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'deltas-only',
+                        description: 'Show only deltas (JSON only)',
+                    },
+                    {
+                        name: 'requirements-only',
+                        description: 'Alias for --deltas-only (deprecated)',
+                    },
+                    COMMON_FLAGS.noInteractive,
+                ],
+            },
+            {
+                name: 'list',
+                description: 'List all active changes (deprecated)',
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'long',
+                        description: 'Show id and title with counts',
+                    },
+                ],
+            },
+            {
+                name: 'validate',
+                description: 'Validate a change proposal',
+                acceptsPositional: true,
+                positionalType: 'change-id',
+                flags: [
+                    COMMON_FLAGS.strict,
+                    COMMON_FLAGS.jsonValidation,
+                    COMMON_FLAGS.noInteractive,
+                ],
+            },
+        ],
+    },
+    {
+        name: 'spec',
+        description: 'Manage synarcx specifications',
+        flags: [],
+        subcommands: [
+            {
+                name: 'show',
+                description: 'Show a specification',
+                acceptsPositional: true,
+                positionalType: 'spec-id',
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'requirements',
+                        description: 'Show only requirements, exclude scenarios (JSON only)',
+                    },
+                    {
+                        name: 'no-scenarios',
+                        description: 'Exclude scenario content (JSON only)',
+                    },
+                    {
+                        name: 'requirement',
+                        short: 'r',
+                        description: 'Show specific requirement by ID (JSON only)',
+                        takesValue: true,
+                    },
+                    COMMON_FLAGS.noInteractive,
+                ],
+            },
+            {
+                name: 'list',
+                description: 'List all specifications',
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'long',
+                        description: 'Show id and title with counts',
+                    },
+                ],
+            },
+            {
+                name: 'validate',
+                description: 'Validate a specification',
+                acceptsPositional: true,
+                positionalType: 'spec-id',
+                flags: [
+                    COMMON_FLAGS.strict,
+                    COMMON_FLAGS.jsonValidation,
+                    COMMON_FLAGS.noInteractive,
+                ],
+            },
+        ],
+    },
+    {
+        name: 'completion',
+        description: 'Manage shell completions for synarcx CLI',
+        flags: [],
+        subcommands: [
+            {
+                name: 'generate',
+                description: 'Generate completion script for a shell (outputs to stdout)',
+                acceptsPositional: true,
+                positionalType: 'shell',
+                flags: [],
+            },
+            {
+                name: 'install',
+                description: 'Install completion script for a shell',
+                acceptsPositional: true,
+                positionalType: 'shell',
+                flags: [
+                    {
+                        name: 'verbose',
+                        description: 'Show detailed installation output',
+                    },
+                ],
+            },
+            {
+                name: 'uninstall',
+                description: 'Uninstall completion script for a shell',
+                acceptsPositional: true,
+                positionalType: 'shell',
+                flags: [
+                    {
+                        name: 'yes',
+                        short: 'y',
+                        description: 'Skip confirmation prompts',
+                    },
+                ],
+            },
+        ],
+    },
+    {
+        name: 'config',
+        description: 'View and modify global synarcx configuration',
+        flags: [
+            {
+                name: 'scope',
+                description: 'Config scope (only "global" supported currently)',
+                takesValue: true,
+                values: ['global'],
+            },
+        ],
+        subcommands: [
+            {
+                name: 'path',
+                description: 'Show config file location',
+                flags: [],
+            },
+            {
+                name: 'list',
+                description: 'Show all current settings',
+                flags: [
+                    COMMON_FLAGS.json,
+                ],
+            },
+            {
+                name: 'get',
+                description: 'Get a specific value (raw, scriptable)',
+                acceptsPositional: true,
+                flags: [],
+            },
+            {
+                name: 'set',
+                description: 'Set a value (auto-coerce types)',
+                acceptsPositional: true,
+                flags: [
+                    {
+                        name: 'string',
+                        description: 'Force value to be stored as string',
+                    },
+                    {
+                        name: 'allow-unknown',
+                        description: 'Allow setting unknown keys',
+                    },
+                ],
+            },
+            {
+                name: 'unset',
+                description: 'Remove a key (revert to default)',
+                acceptsPositional: true,
+                flags: [],
+            },
+            {
+                name: 'reset',
+                description: 'Reset configuration to defaults',
+                flags: [
+                    {
+                        name: 'all',
+                        description: 'Reset all configuration (required)',
+                    },
+                    {
+                        name: 'yes',
+                        short: 'y',
+                        description: 'Skip confirmation prompts',
+                    },
+                ],
+            },
+            {
+                name: 'edit',
+                description: 'Open config in $EDITOR',
+                flags: [],
+            },
+            {
+                name: 'profile',
+                description: 'Configure workflow profile (interactive picker or preset shortcut)',
+                flags: [],
+            },
+        ],
+    },
+    {
+        name: 'schema',
+        description: 'Manage workflow schemas',
+        flags: [],
+        subcommands: [
+            {
+                name: 'which',
+                description: 'Show where a schema resolves from',
+                acceptsPositional: true,
+                positionalType: 'schema-name',
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'all',
+                        description: 'List all schemas with their resolution sources',
+                    },
+                ],
+            },
+            {
+                name: 'validate',
+                description: 'Validate a schema structure and templates',
+                acceptsPositional: true,
+                positionalType: 'schema-name',
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'verbose',
+                        description: 'Show detailed validation steps',
+                    },
+                ],
+            },
+            {
+                name: 'fork',
+                description: 'Copy an existing schema to project for customization',
+                acceptsPositional: true,
+                positionalType: 'schema-name',
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'force',
+                        description: 'Overwrite existing destination',
+                    },
+                ],
+            },
+            {
+                name: 'init',
+                description: 'Create a new project-local schema',
+                acceptsPositional: true,
+                flags: [
+                    COMMON_FLAGS.json,
+                    {
+                        name: 'description',
+                        description: 'Schema description',
+                        takesValue: true,
+                    },
+                    {
+                        name: 'artifacts',
+                        description: 'Comma-separated artifact IDs',
+                        takesValue: true,
+                    },
+                    {
+                        name: 'default',
+                        description: 'Set as project default schema',
+                    },
+                    {
+                        name: 'no-default',
+                        description: 'Do not prompt to set as default',
+                    },
+                    {
+                        name: 'force',
+                        description: 'Overwrite existing schema',
+                    },
+                ],
+            },
+        ],
+    },
+];
+//# sourceMappingURL=command-registry.js.map

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

@@ -0,0 +1,71 @@
+/**
+ * Provides dynamic completion suggestions for synarcx 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;
+    private schemaCache;
+    /**
+     * 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 all schema names for completion
+     *
+     * @returns Array of schema names
+     */
+    getSchemaNames(): 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;
+        };
+        schemaCache: {
+            valid: boolean;
+            age?: number;
+        };
+    };
+}
+//# sourceMappingURL=completion-provider.d.ts.map