@dedesfr/prompter 0.9.0 → 1.0.0

package/src/core/completions/generators/zsh-generator.ts

@@ -1,281 +0,0 @@
-import { CompletionGenerator, CommandDefinition, FlagDefinition } from '../types.js';
-import { ZSH_DYNAMIC_HELPERS } from '../templates/zsh-templates.js';
-
-/**
- * Generates Zsh completion scripts for the Prompter CLI.
- * Follows Zsh completion system conventions using the _prompter function.
- */
-export class ZshGenerator implements CompletionGenerator {
-  readonly shell = 'zsh' as const;
-
-  /**
-   * Generate a Zsh completion script
-   *
-   * @param commands - Command definitions to generate completions for
-   * @returns Zsh completion script as a string
-   */
-  generate(commands: CommandDefinition[]): string {
-    // Build command list using push() for loop clarity
-    const commandLines: string[] = [];
-    for (const cmd of commands) {
-      const escapedDesc = this.escapeDescription(cmd.description);
-      commandLines.push(`    '${cmd.name}:${escapedDesc}'`);
-    }
-    const commandList = commandLines.join('\n');
-
-    // Build command cases using push() for loop clarity
-    const commandCaseLines: string[] = [];
-    for (const cmd of commands) {
-      commandCaseLines.push(`        ${cmd.name})`);
-      commandCaseLines.push(`          _prompter_${this.sanitizeFunctionName(cmd.name)}`);
-      commandCaseLines.push('          ;;');
-    }
-    const commandCases = commandCaseLines.join('\n');
-
-    // Build command functions using push() for loop clarity
-    const commandFunctionLines: string[] = [];
-    for (const cmd of commands) {
-      commandFunctionLines.push(...this.generateCommandFunction(cmd));
-      commandFunctionLines.push('');
-    }
-    const commandFunctions = commandFunctionLines.join('\n');
-
-    // Dynamic completion helpers from template
-    const helpers = ZSH_DYNAMIC_HELPERS;
-
-    // Assemble final script with template literal
-    return `#compdef prompter
-
-# Zsh completion script for Prompter CLI
-# Auto-generated - do not edit manually
-
-_prompter() {
-  local context state line
-  typeset -A opt_args
-
-  local -a commands
-  commands=(
-${commandList}
-  )
-
-  _arguments -C \\
-    "1: :->command" \\
-    "*::arg:->args"
-
-  case $state in
-    command)
-      _describe "prompter command" commands
-      ;;
-    args)
-      case $words[1] in
-${commandCases}
-      esac
-      ;;
-  esac
-}
-
-${commandFunctions}
-${helpers}
-compdef _prompter prompter
-`;
-  }
-
-  /**
-   * Generate completion function for a specific command
-   */
-  private generateCommandFunction(cmd: CommandDefinition): string[] {
-    const funcName = `_prompter_${this.sanitizeFunctionName(cmd.name)}`;
-    const lines: string[] = [];
-
-    lines.push(`${funcName}() {`);
-
-    // If command has subcommands, handle them
-    if (cmd.subcommands && cmd.subcommands.length > 0) {
-      lines.push('  local context state line');
-      lines.push('  typeset -A opt_args');
-      lines.push('');
-      lines.push('  local -a subcommands');
-      lines.push('  subcommands=(');
-
-      for (const subcmd of cmd.subcommands) {
-        const escapedDesc = this.escapeDescription(subcmd.description);
-        lines.push(`    '${subcmd.name}:${escapedDesc}'`);
-      }
-
-      lines.push('  )');
-      lines.push('');
-      lines.push('  _arguments -C \\');
-
-      // Add command flags
-      for (const flag of cmd.flags) {
-        lines.push('    ' + this.generateFlagSpec(flag) + ' \\');
-      }
-
-      lines.push('    "1: :->subcommand" \\');
-      lines.push('    "*::arg:->args"');
-      lines.push('');
-      lines.push('  case $state in');
-      lines.push('    subcommand)');
-      lines.push('      _describe "subcommand" subcommands');
-      lines.push('      ;;');
-      lines.push('    args)');
-      lines.push('      case $words[1] in');
-
-      for (const subcmd of cmd.subcommands) {
-        lines.push(`        ${subcmd.name})`);
-        lines.push(`          _prompter_${this.sanitizeFunctionName(cmd.name)}_${this.sanitizeFunctionName(subcmd.name)}`);
-        lines.push('          ;;');
-      }
-
-      lines.push('      esac');
-      lines.push('      ;;');
-      lines.push('  esac');
-    } else {
-      // Command without subcommands
-      lines.push('  _arguments \\');
-
-      // Add flags
-      for (const flag of cmd.flags) {
-        lines.push('    ' + this.generateFlagSpec(flag) + ' \\');
-      }
-
-      // Add positional argument completion
-      if (cmd.acceptsPositional) {
-        const positionalSpec = this.generatePositionalSpec(cmd.positionalType);
-        lines.push('    ' + positionalSpec);
-      } else {
-        // Remove trailing backslash from last flag
-        if (lines[lines.length - 1].endsWith(' \\')) {
-          lines[lines.length - 1] = lines[lines.length - 1].slice(0, -2);
-        }
-      }
-    }
-
-    lines.push('}');
-
-    // Generate subcommand functions if they exist
-    if (cmd.subcommands) {
-      for (const subcmd of cmd.subcommands) {
-        lines.push('');
-        lines.push(...this.generateSubcommandFunction(cmd.name, subcmd));
-      }
-    }
-
-    return lines;
-  }
-
-  /**
-   * Generate completion function for a subcommand
-   */
-  private generateSubcommandFunction(parentName: string, subcmd: CommandDefinition): string[] {
-    const funcName = `_prompter_${this.sanitizeFunctionName(parentName)}_${this.sanitizeFunctionName(subcmd.name)}`;
-    const lines: string[] = [];
-
-    lines.push(`${funcName}() {`);
-    lines.push('  _arguments \\');
-
-    // Add flags
-    for (const flag of subcmd.flags) {
-      lines.push('    ' + this.generateFlagSpec(flag) + ' \\');
-    }
-
-    // Add positional argument completion
-    if (subcmd.acceptsPositional) {
-      const positionalSpec = this.generatePositionalSpec(subcmd.positionalType);
-      lines.push('    ' + positionalSpec);
-    } else {
-      // Remove trailing backslash from last flag
-      if (lines[lines.length - 1].endsWith(' \\')) {
-        lines[lines.length - 1] = lines[lines.length - 1].slice(0, -2);
-      }
-    }
-
-    lines.push('}');
-
-    return lines;
-  }
-
-  /**
-   * Generate flag specification for _arguments
-   */
-  private generateFlagSpec(flag: FlagDefinition): string {
-    const parts: string[] = [];
-
-    // Handle mutually exclusive short and long forms
-    if (flag.short) {
-      parts.push(`'(-${flag.short} --${flag.name})'{-${flag.short},--${flag.name}}'`);
-    } else {
-      parts.push(`'--${flag.name}`);
-    }
-
-    // Add description
-    const escapedDesc = this.escapeDescription(flag.description);
-    parts.push(`[${escapedDesc}]`);
-
-    // Add value completion if flag takes a value
-    if (flag.takesValue) {
-      if (flag.values && flag.values.length > 0) {
-        // Provide specific value completions
-        const valueList = flag.values.map(v => this.escapeValue(v)).join(' ');
-        parts.push(`:value:(${valueList})`);
-      } else {
-        // Generic value placeholder
-        parts.push(':value:');
-      }
-    }
-
-    // Close the quote (needed for both short and long forms)
-    parts.push("'");
-
-    return parts.join('');
-  }
-
-  /**
-   * Generate positional argument specification
-   */
-  private generatePositionalSpec(positionalType?: string): string {
-    switch (positionalType) {
-      case 'change-id':
-        return "'*: :_prompter_complete_changes'";
-      case 'spec-id':
-        return "'*: :_prompter_complete_specs'";
-      case 'change-or-spec-id':
-        return "'*: :_prompter_complete_items'";
-      case 'path':
-        return "'*:path:_files'";
-      case 'shell':
-        return "'*:shell:(zsh bash fish powershell)'";
-      default:
-        return "'*: :_default'";
-    }
-  }
-
-  /**
-   * Escape special characters in descriptions
-   */
-  private escapeDescription(desc: string): string {
-    return desc
-      .replace(/\\/g, '\\\\')
-      .replace(/'/g, "\\'")
-      .replace(/\[/g, '\\[')
-      .replace(/]/g, '\\]')
-      .replace(/:/g, '\\:');
-  }
-
-  /**
-   * Escape special characters in values
-   */
-  private escapeValue(value: string): string {
-    return value
-      .replace(/\\/g, '\\\\')
-      .replace(/'/g, "\\'")
-      .replace(/ /g, '\\ ');
-  }
-
-  /**
-   * Sanitize command names for use in function names
-   */
-  private sanitizeFunctionName(name: string): string {
-    return name.replace(/-/g, '_');
-  }
-}

package/src/core/completions/templates/bash-templates.ts

@@ -1,24 +0,0 @@
-/**
- * Static template strings for Bash completion scripts.
- * These are Bash-specific helper functions that never change.
- */
-
-export const BASH_DYNAMIC_HELPERS = `# Dynamic completion helpers
-
-_prompter_complete_changes() {
-  local changes
-  changes=$(prompter __complete changes 2>/dev/null | cut -f1)
-  COMPREPLY=($(compgen -W "$changes" -- "$cur"))
-}
-
-_prompter_complete_specs() {
-  local specs
-  specs=$(prompter __complete specs 2>/dev/null | cut -f1)
-  COMPREPLY=($(compgen -W "$specs" -- "$cur"))
-}
-
-_prompter_complete_items() {
-  local items
-  items=$(prompter __complete changes 2>/dev/null | cut -f1; prompter __complete specs 2>/dev/null | cut -f1)
-  COMPREPLY=($(compgen -W "$items" -- "$cur"))
-}`;

package/src/core/completions/templates/fish-templates.ts

@@ -1,40 +0,0 @@
-/**
- * Static template strings for Fish completion scripts.
- * These are Fish-specific helper functions that never change.
- */
-
-export const FISH_STATIC_HELPERS = `# Helper function to check if a subcommand is present
-function __fish_prompter_using_subcommand
-    set -l cmd (commandline -opc)
-    set -e cmd[1]
-    for i in $argv
-        if contains -- $i $cmd
-            return 0
-        end
-    end
-    return 1
-end
-
-function __fish_prompter_no_subcommand
-    set -l cmd (commandline -opc)
-    test (count $cmd) -eq 1
-end`;
-
-export const FISH_DYNAMIC_HELPERS = `# Dynamic completion helpers
-
-function __fish_prompter_changes
-    prompter __complete changes 2>/dev/null | while read -l id desc
-        printf '%s\\t%s\\n' "$id" "$desc"
-    end
-end
-
-function __fish_prompter_specs
-    prompter __complete specs 2>/dev/null | while read -l id desc
-        printf '%s\\t%s\\n' "$id" "$desc"
-    end
-end
-
-function __fish_prompter_items
-    __fish_prompter_changes
-    __fish_prompter_specs
-end`;

package/src/core/completions/templates/powershell-templates.ts

@@ -1,25 +0,0 @@
-/**
- * Static template strings for PowerShell completion scripts.
- * These are PowerShell-specific helper functions that never change.
- */
-
-export const POWERSHELL_DYNAMIC_HELPERS = `# Dynamic completion helpers
-
-function Get-PrompterChanges {
-    $output = prompter __complete changes 2>$null
-    if ($output) {
-        $output | ForEach-Object {
-            ($_ -split "\\t")[0]
-        }
-    }
-}
-
-function Get-PrompterSpecs {
-    $output = prompter __complete specs 2>$null
-    if ($output) {
-        $output | ForEach-Object {
-            ($_ -split "\\t")[0]
-        }
-    }
-}
-`;

package/src/core/completions/templates/zsh-templates.ts

@@ -1,36 +0,0 @@
-/**
- * Static template strings for Zsh completion scripts.
- * These are Zsh-specific helper functions that never change.
- */
-
-export const ZSH_DYNAMIC_HELPERS = `# Dynamic completion helpers
-
-# Use prompter __complete to get available changes
-_prompter_complete_changes() {
-  local -a changes
-  while IFS=$'\\t' read -r id desc; do
-    changes+=("$id:$desc")
-  done < <(prompter __complete changes 2>/dev/null)
-  _describe "change" changes
-}
-
-# Use prompter __complete to get available specs
-_prompter_complete_specs() {
-  local -a specs
-  while IFS=$'\\t' read -r id desc; do
-    specs+=("$id:$desc")
-  done < <(prompter __complete specs 2>/dev/null)
-  _describe "spec" specs
-}
-
-# Get both changes and specs
-_prompter_complete_items() {
-  local -a items
-  while IFS=$'\\t' read -r id desc; do
-    items+=("$id:$desc")
-  done < <(prompter __complete changes 2>/dev/null)
-  while IFS=$'\\t' read -r id desc; do
-    items+=("$id:$desc")
-  done < <(prompter __complete specs 2>/dev/null)
-  _describe "item" items
-}`;

package/src/core/completions/types.ts

@@ -1,90 +0,0 @@
-import { SupportedShell } from '../../utils/shell-detection.js';
-
-/**
- * Definition of a command-line flag/option
- */
-export interface FlagDefinition {
-  /**
-   * Flag name without dashes (e.g., "json", "strict", "no-interactive")
-   */
-  name: string;
-
-  /**
-   * Short flag name without dash (e.g., "y" for "-y")
-   */
-  short?: string;
-
-  /**
-   * Human-readable description of what the flag does
-   */
-  description: string;
-
-  /**
-   * Whether the flag takes an argument value
-   */
-  takesValue?: boolean;
-
-  /**
-   * Possible values for the flag (for completion suggestions)
-   */
-  values?: string[];
-}
-
-/**
- * Definition of a CLI command
- */
-export interface CommandDefinition {
-  /**
-   * Command name (e.g., "init", "validate", "show")
-   */
-  name: string;
-
-  /**
-   * Human-readable description of the command
-   */
-  description: string;
-
-  /**
-   * Flags/options supported by this command
-   */
-  flags: FlagDefinition[];
-
-  /**
-   * Subcommands (e.g., "change show", "spec validate")
-   */
-  subcommands?: CommandDefinition[];
-
-  /**
-   * Whether this command accepts a positional argument (e.g., item name, path)
-   */
-  acceptsPositional?: boolean;
-
-  /**
-   * Type of positional argument for dynamic completion
-   * - 'change-id': Complete with active change IDs
-   * - 'spec-id': Complete with spec IDs
-   * - 'change-or-spec-id': Complete with both changes and specs
-   * - 'path': Complete with file paths
-   * - 'shell': Complete with supported shell names
-   * - undefined: No specific completion
-   */
-  positionalType?: 'change-id' | 'spec-id' | 'change-or-spec-id' | 'path' | 'shell';
-}
-
-/**
- * Interface for shell-specific completion script generators
- */
-export interface CompletionGenerator {
-  /**
-   * The shell type this generator targets
-   */
-  readonly shell: SupportedShell;
-
-  /**
-   * Generate the completion script content
-   *
-   * @param commands - Command definitions to generate completions for
-   * @returns The shell-specific completion script as a string
-   */
-  generate(commands: CommandDefinition[]): string;
-}