[READ-ONLY] Mirror of https://github.com/bombshell-dev/tab. shell autocompletions for javascript CLIs
Something went wrong. Try again.
TypeScript
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253import { defineCommand } from 'citty';import type { ArgDef } from 'citty';import * as zsh from './zsh';import * as bash from './bash';import * as fish from './fish';import * as powershell from './powershell';import type { ArgsDef, CommandDef, PositionalArgDef, SubCommandsDef,} from 'citty';import { generateFigSpec } from './fig';import { assertDoubleDashes } from './shared';import type { CompletionConfig } from './shared';import t, { type RootCommand } from './t';
function quoteIfNeeded(path: string) { return path.includes(' ') ? `'${path}'` : path;}
const execPath = process.execPath;const processArgs = process.argv.slice(1);const quotedExecPath = quoteIfNeeded(execPath);const quotedProcessArgs = processArgs.map(quoteIfNeeded);const quotedProcessExecArgs = process.execArgv.map(quoteIfNeeded);const x = `${quotedExecPath} ${quotedProcessExecArgs.join(' ')} ${quotedProcessArgs[0]}`;
function isConfigPositional<T extends ArgsDef>(config: CommandDef<T>) { return ( config.args && Object.values(config.args).some((arg) => arg.type === 'positional') );}
async function handleSubCommands( subCommands: SubCommandsDef, parentCmd?: string, completionConfig?: Record<string, CompletionConfig>) { for (const [cmd, resolvableConfig] of Object.entries(subCommands)) { const config = await resolve(resolvableConfig); const meta = await resolve(config.meta); const subCommands = await resolve(config.subCommands); const subCompletionConfig = completionConfig?.[cmd];
if (!meta || typeof meta?.description !== 'string') { throw new Error('Invalid meta or missing description.'); } const isPositional = isConfigPositional(config);
const commandName = parentCmd ? `${parentCmd} ${cmd}` : cmd; const command = t.command(commandName, meta.description);
// Set args for the command if it has positional arguments if (isPositional && config.args) { for (const [argName, argConfig] of Object.entries(config.args)) { const conf = argConfig as ArgDef; if (conf.type === 'positional') { const isVariadic = conf.required === false; const argHandler = subCompletionConfig?.args?.[argName]; if (argHandler) { command.argument(argName, argHandler, isVariadic); } else { command.argument(argName, undefined, isVariadic); } } } }
// subcommands (recursive) if (subCommands) { await handleSubCommands( subCommands, commandName, subCompletionConfig?.subCommands ); }
// args if (config.args) { for (const [argName, argConfig] of Object.entries(config.args)) { const conf = argConfig as ArgDef; // alias (if exists) const shortFlag = typeof conf === 'object' && 'alias' in conf ? Array.isArray(conf.alias) ? conf.alias[0] : conf.alias : undefined;
// option (without -- prefix) const handler = subCompletionConfig?.options?.[argName]; if (handler) { // value option (if has custom handler) if (shortFlag) { command.option(argName, conf.description ?? '', handler, shortFlag); } else { command.option(argName, conf.description ?? '', handler); } } else { // boolean flag (if no custom handler) if (shortFlag) { command.option(argName, conf.description ?? '', shortFlag); } else { command.option(argName, conf.description ?? ''); } } } } }}
export default async function tab<TArgs extends ArgsDef>( instance: CommandDef<TArgs>, completionConfig?: CompletionConfig): Promise<RootCommand> { const meta = await resolve(instance.meta);
if (!meta) { throw new Error('Invalid meta.'); } const name = meta.name; if (!name) { throw new Error('Invalid meta or missing name.'); }
const subCommands = await resolve(instance.subCommands);
const isPositional = isConfigPositional(instance);
// args (if has positional arguments) if (isPositional && instance.args) { for (const [argName, argConfig] of Object.entries(instance.args)) { const conf = argConfig as PositionalArgDef; if (conf.type === 'positional') { const isVariadic = conf.required === false; const argHandler = completionConfig?.args?.[argName]; if (argHandler) { t.argument(argName, argHandler, isVariadic); } else { t.argument(argName, undefined, isVariadic); } } } }
if (subCommands) { await handleSubCommands( subCommands, undefined, completionConfig?.subCommands ); }
if (instance.args) { for (const [argName, argConfig] of Object.entries(instance.args)) { const conf = argConfig as ArgDef;
const shortFlag = typeof conf === 'object' && 'alias' in conf ? Array.isArray(conf.alias) ? conf.alias[0] : conf.alias : undefined;
const handler = completionConfig?.options?.[argName]; if (handler) { if (shortFlag) { t.option(argName, conf.description ?? '', handler, shortFlag); } else { t.option(argName, conf.description ?? '', handler); } } else { if (shortFlag) { t.option(argName, conf.description ?? '', shortFlag); } else { t.option(argName, conf.description ?? ''); } } } }
const completeCommand = defineCommand({ meta: { name: 'complete', description: 'Generate shell completion scripts', }, args: { shell: { type: 'positional', description: 'Shell type (zsh, bash, fish, powershell, fig)', required: false, }, }, async run(ctx) { let shell: string | undefined = ctx.rawArgs[0];
if (shell === '--') { shell = undefined; }
switch (shell) { case 'zsh': { const script = zsh.generate(name, x); console.log(script); break; } case 'bash': { const script = bash.generate(name, x); console.log(script); break; } case 'fish': { const script = fish.generate(name, x); console.log(script); break; } case 'powershell': { const script = powershell.generate(name, x); console.log(script); break; } case 'fig': { const spec = await generateFigSpec(instance); console.log(spec); break; } default: { assertDoubleDashes(name);
const extra = ctx.rawArgs.slice(ctx.rawArgs.indexOf('--') + 1); return t.parse(extra); } } }, });
if (!subCommands) { instance.subCommands = { complete: completeCommand }; } else { subCommands.complete = completeCommand; }
return t;}
type Resolvable<T> = T | Promise<T> | (() => T) | (() => Promise<T>);
async function resolve<T>(resolvable: Resolvable<T>): Promise<T> { return resolvable instanceof Function ? await resolvable() : await resolvable;}