Skip to content
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.

Sign up for GitHub

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

feat!: parsed optionals and enum type safety #174

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat!: parsed optionals and enum type safety #174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
be3bd67
feat: opt-in type safety
BobbieGoede Dec 11, 2024
bb813c5
fix: remove opt-in conditionals
BobbieGoede Dec 11, 2024
2e11454
fix: add types for parsed argument aliases
BobbieGoede Dec 11, 2024
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
2 changes: 1 addition & 1 deletion src/command.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { CommandContext, CommandDef, ArgsDef } from "./types";
import { CLIError, resolveValue } from "./_utils";
import { parseArgs } from "./args";

export function defineCommand<T extends ArgsDef = ArgsDef>(
export function defineCommand<const T extends ArgsDef = ArgsDef>(
def: CommandDef<T>,
): CommandDef<T> {
return def;
Expand Down
88 changes: 58 additions & 30 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ export type ArgType =
| "positional"
| undefined;

// Args: Definition

export type _ArgDef<T extends ArgType, VT extends boolean | number | string> = {
type?: T;
description?: string;
Expand Down Expand Up @@ -40,36 +42,62 @@ export type ArgsDef = Record<string, ArgDef>;

export type Arg = ArgDef & { name: string; alias: string[] };

export type ParsedArgs<T extends ArgsDef = ArgsDef> = { _: string[] } & Record<
{ [K in keyof T]: T[K] extends { type: "positional" } ? K : never }[keyof T],
string
> &
Record<
{
[K in keyof T]: T[K] extends { type: "string" } ? K : never;
}[keyof T],
string
> &
Record<
{
[K in keyof T]: T[K] extends { type: "number" } ? K : never;
}[keyof T],
number
> &
Record<
{
[K in keyof T]: T[K] extends { type: "boolean" } ? K : never;
}[keyof T],
boolean
> &
Record<
{
[K in keyof T]: T[K] extends { type: "enum" } ? K : never;
}[keyof T],
{
[K in keyof T]: T[K] extends { options: infer U } ? U : never;
}[keyof T]
> &
// Args: Parsed

type ResolveParsedArgType<T extends ArgDef, VT> = T extends {
default?: any;
required?: boolean;
}
? T["default"] extends NonNullable<VT>
? VT
: T["required"] extends true
? VT
: VT | undefined
: VT | undefined;

type ParsedPositionalArg<T extends ArgDef> = T extends { type: "positional" }
? ResolveParsedArgType<T, string>
: never;

type ParsedStringArg<T extends ArgDef> = T extends { type: "string" }
? ResolveParsedArgType<T, string>
: never;

type ParsedNumberArg<T extends ArgDef> = T extends { type: "number" }
? ResolveParsedArgType<T, number>
: never;

type ParsedBooleanArg<T extends ArgDef> = T extends { type: "boolean" }
? ResolveParsedArgType<T, boolean>
: never;

type ParsedEnumArg<T extends ArgDef> = T extends {
type: "enum";
options: infer U;
}
? U extends Array<any>
? ResolveParsedArgType<T, U[number]>
: never
: never;

type RawArgs = {
_: string[];
};

// prettier-ignore
type ParsedArg<T extends ArgDef> =
T["type"] extends "positional" ? ParsedPositionalArg<T> :
T["type"] extends "boolean" ? ParsedBooleanArg<T> :
T["type"] extends "string" ? ParsedStringArg<T> :
T["type"] extends "number" ? ParsedNumberArg<T> :
T["type"] extends "enum" ? ParsedEnumArg<T> :
never;

// prettier-ignore
export type ParsedArgs<T extends ArgsDef = ArgsDef> = RawArgs &
{ [K in keyof T]: ParsedArg<T[K]>; } &
{ [K in keyof T as T[K] extends { alias: string } ? T[K]["alias"] : never]: ParsedArg<T[K]> } &
{ [K in keyof T as T[K] extends { alias: string[] } ? T[K]["alias"][number] : never]: ParsedArg<T[K]> } &
Record<string, string | number | boolean | string[]>;

// ----- Command -----
Expand Down