.opencode/node_modules/effect/dist/unstable/cli/Completions.d.ts

/**
 * Shell type used to generate completion scripts.
 *
 * @category models
 * @since 4.0.0
 */
export type Shell = "bash" | "zsh" | "fish";
/**
 * Describes a command for completion script generation.
 *
 * @category models
 * @since 4.0.0
 */
export interface CommandDescriptor {
    readonly name: string;
    readonly description: string | undefined;
    readonly flags: ReadonlyArray<FlagDescriptor>;
    readonly arguments: ReadonlyArray<ArgumentDescriptor>;
    readonly subcommands: ReadonlyArray<CommandDescriptor>;
}
/**
 * Describes a command flag for completions.
 *
 * @category models
 * @since 4.0.0
 */
export interface FlagDescriptor {
    readonly name: string;
    readonly aliases: ReadonlyArray<string>;
    readonly description: string | undefined;
    readonly type: FlagType;
}
/**
 * Describes the supported flag value shapes.
 *
 * @category models
 * @since 4.0.0
 */
export type FlagType = {
    readonly _tag: "Boolean";
} | {
    readonly _tag: "String";
} | {
    readonly _tag: "Integer";
} | {
    readonly _tag: "Float";
} | {
    readonly _tag: "Date";
} | {
    readonly _tag: "Choice";
    readonly values: ReadonlyArray<string>;
} | {
    readonly _tag: "Path";
    readonly pathType: "file" | "directory" | "either";
};
/**
 * Describes a positional argument for completions.
 *
 * @category models
 * @since 4.0.0
 */
export interface ArgumentDescriptor {
    readonly name: string;
    readonly description: string | undefined;
    readonly required: boolean;
    readonly variadic: boolean;
    readonly type: ArgumentType;
}
/**
 * Describes the supported argument value shapes.
 *
 * @category models
 * @since 4.0.0
 */
export type ArgumentType = {
    readonly _tag: "String";
} | {
    readonly _tag: "Integer";
} | {
    readonly _tag: "Float";
} | {
    readonly _tag: "Date";
} | {
    readonly _tag: "Choice";
    readonly values: ReadonlyArray<string>;
} | {
    readonly _tag: "Path";
    readonly pathType: "file" | "directory" | "either";
};
/**
 * Generates a shell completion script for a command descriptor.
 *
 * **When to use**
 *
 * Use when you need an installable completion script from an existing
 * `CommandDescriptor`.
 *
 * **Details**
 *
 * Dispatches by `shell` to Bash, Zsh, or Fish generation and returns a static
 * script string for `executableName`.
 *
 * @see {@link Shell} for supported shell names
 * @see {@link CommandDescriptor} for the command shape used by completion generation
 *
 * @category constructors
 * @since 4.0.0
 */
export declare const generate: (executableName: string, shell: Shell, descriptor: CommandDescriptor) => string;
//# sourceMappingURL=Completions.d.ts.map