import { Suggestion } from "./internal/parser.js";

//#region src/completion.d.ts

/**
 * A shell completion generator.
 * @since 0.6.0
 */
interface ShellCompletion {
  /**
   * The name of the shell.
   */
  readonly name: string;
  /**
   * Generates a shell completion script for the given program name.
   * @param programName The name of the program.
   * @param args The arguments passed to the program.  If omitted, an empty
   *             array is used.
   * @returns The shell completion script.
   */
  generateScript(programName: string, args?: readonly string[]): string;
  /**
   * Encodes {@link Suggestion}s into chunks of strings suitable for the shell.
   * All chunks will be joined without any separator.
   * @param suggestions The suggestions to encode.
   * @returns The encoded suggestions.
   */
  encodeSuggestions(suggestions: readonly Suggestion[]): Iterable<string>;
}
/**
 * The Bash shell completion generator.
 * @since 0.6.0
 */
declare const bash: ShellCompletion;
/**
 * The Zsh shell completion generator.
 * @since 0.6.0
 */
declare const zsh: ShellCompletion;
/**
 * The fish shell completion generator.
 * @since 0.6.0
 */
declare const fish: ShellCompletion;
/**
 * The Nushell completion generator.
 * @since 0.6.0
 */
declare const nu: ShellCompletion;
/**
 * The PowerShell completion generator.
 * @since 0.6.0
 */
declare const pwsh: ShellCompletion;
//#endregion
export { ShellCompletion, bash, fish, nu, pwsh, zsh };