Skip to content

feat(subcommand): support alias for subcommand #155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion src/_utils.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { Resolvable } from "./types";
import type { CommandDef, Resolvable, SubCommandsDef } from "./types";

export function toArray(val: any) {
if (Array.isArray(val)) {
Expand Down Expand Up @@ -30,6 +30,25 @@ export function resolveValue<T>(input: Resolvable<T>): T | Promise<T> {
return typeof input === "function" ? (input as any)() : input;
}

export async function getSubCommand(
subCommands: SubCommandsDef,
command: string,
): Promise<CommandDef<any>> {
if (Object.keys(subCommands).includes(command)) {
return resolveValue(subCommands[command]);
}

for (const subCommand of Object.values(subCommands)) {
const resolvedSubCommand = await resolveValue(subCommand);
for (const alias of toArray(resolvedSubCommand.alias)) {
if (alias === command) {
return resolvedSubCommand;
}
}
}
throw new CLIError(`Unknown command \`${command}\``, "E_UNKNOWN_COMMAND");
}

export class CLIError extends Error {
constructor(
message: string,
Expand Down
10 changes: 2 additions & 8 deletions src/command.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import type { CommandContext, CommandDef, ArgsDef } from "./types";
import { CLIError, resolveValue } from "./_utils";
import { CLIError, getSubCommand, resolveValue } from "./_utils";
import { parseArgs } from "./args";

export function defineCommand<T extends ArgsDef = ArgsDef>(
Expand Down Expand Up @@ -43,13 +43,7 @@ export async function runCommand<T extends ArgsDef = ArgsDef>(
);
const subCommandName = opts.rawArgs[subCommandArgIndex];
if (subCommandName) {
if (!subCommands[subCommandName]) {
throw new CLIError(
`Unknown command \`${subCommandName}\``,
"E_UNKNOWN_COMMAND",
);
}
const subCommand = await resolveValue(subCommands[subCommandName]);
const subCommand = await getSubCommand(subCommands, subCommandName);
if (subCommand) {
await runCommand(subCommand, {
rawArgs: opts.rawArgs.slice(subCommandArgIndex + 1),
Expand Down
1 change: 1 addition & 0 deletions src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ export type SubCommandsDef = Record<string, Resolvable<CommandDef<any>>>;
export type CommandDef<T extends ArgsDef = ArgsDef> = {
meta?: Resolvable<CommandMeta>;
args?: Resolvable<T>;
alias?: Resolvable<string | string[]>;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor nit, maybe this should actually be in a SubCommandDef

you can't alias the root command since it is the 'argless' execution afaict

so maybe SubCommandsDef should actually be Record<string, Resolvable<SubCommandDef<any>>>, where SubCommandDef is just CommandDef<T> & {alias?: Resolvable<string | string[]>}

what do you think?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your review, this is an early PR, it took me some time to understand it.😂

I agree with you and I will try to revise it later.

subCommands?: Resolvable<SubCommandsDef>;
setup?: (context: CommandContext<T>) => any | Promise<any>;
cleanup?: (context: CommandContext<T>) => any | Promise<any>;
Expand Down