@gunshi/bone 0.27.0-beta.2 → 0.27.0-beta.4

package/lib/index.d.ts

@@ -484,8 +484,8 @@ type IsFunction<T> = T extends ((...args: any[]) => any) ? true : false;
  *
  * @internal
  */
-type ExtractOptionValue<A extends ArgSchema> = A['type'] extends 'string' ? ResolveOptionValue<A, string> : A['type'] extends 'boolean' ? ResolveOptionValue<A, boolean> : A['type'] extends 'number' ? ResolveOptionValue<A, number> : A['type'] extends 'positional' ? ResolveOptionValue<A, string> : A['type'] extends 'enum' ? A['choices'] extends string[] | readonly string[] ? ResolveOptionValue<A, A['choices'][number]> : never : A['type'] extends 'custom' ? IsFunction<A['parse']> extends true ? ResolveOptionValue<A, ReturnType<NonNullable<A['parse']>>> : never : ResolveOptionValue<A, string | boolean | number>;
-type ResolveOptionValue<A extends ArgSchema, T> = A['multiple'] extends true ? T[] : T;
+type ExtractOptionValue<A$1 extends ArgSchema> = A$1['type'] extends 'string' ? ResolveOptionValue<A$1, string> : A$1['type'] extends 'boolean' ? ResolveOptionValue<A$1, boolean> : A$1['type'] extends 'number' ? ResolveOptionValue<A$1, number> : A$1['type'] extends 'positional' ? ResolveOptionValue<A$1, string> : A$1['type'] extends 'enum' ? A$1['choices'] extends string[] | readonly string[] ? ResolveOptionValue<A$1, A$1['choices'][number]> : never : A$1['type'] extends 'custom' ? IsFunction<A$1['parse']> extends true ? ResolveOptionValue<A$1, ReturnType<NonNullable<A$1['parse']>>> : never : ResolveOptionValue<A$1, string | boolean | number>;
+type ResolveOptionValue<A$1 extends ArgSchema, T> = A$1['multiple'] extends true ? T[] : T;
 /**
  * Resolved argument values.
  *
@@ -494,7 +494,7 @@ type ResolveOptionValue<A extends ArgSchema, T> = A['multiple'] extends true ? T
  *
  * @internal
  */
-type ResolveArgValues<A extends Args, V extends Record<keyof A, unknown>> = { -readonly [Arg in keyof A]?: V[Arg] } & FilterArgs<A, V, 'default'> & FilterArgs<A, V, 'required'> & FilterPositionalArgs<A, V> extends infer P ? { [K in keyof P]: P[K] } : never;
+type ResolveArgValues<A$1 extends Args, V extends Record<keyof A$1, unknown>> = { -readonly [Arg in keyof A$1]?: V[Arg] } & FilterArgs<A$1, V, 'default'> & FilterArgs<A$1, V, 'required'> & FilterPositionalArgs<A$1, V> extends infer P ? { [K in keyof P]: P[K] } : never;
 /**
  * Filters the arguments based on their default values.
  *
@@ -504,7 +504,7 @@ type ResolveArgValues<A extends Args, V extends Record<keyof A, unknown>> = { -r
  *
  * @internal
  */
-type FilterArgs<A extends Args, V extends Record<keyof A, unknown>, K extends keyof ArgSchema> = { [Arg in keyof A as A[Arg][K] extends {} ? Arg : never]: V[Arg] };
+type FilterArgs<A$1 extends Args, V extends Record<keyof A$1, unknown>, K$1 extends keyof ArgSchema> = { [Arg in keyof A$1 as A$1[Arg][K$1] extends {} ? Arg : never]: V[Arg] };
 /**
  * Filters positional arguments from the argument schema.
  *
@@ -513,7 +513,7 @@ type FilterArgs<A extends Args, V extends Record<keyof A, unknown>, K extends ke
  *
  * @internal
  */
-type FilterPositionalArgs<A extends Args, V extends Record<keyof A, unknown>> = { [Arg in keyof A as A[Arg]['type'] extends 'positional' ? Arg : never]: V[Arg] };
+type FilterPositionalArgs<A$1 extends Args, V extends Record<keyof A$1, unknown>> = { [Arg in keyof A$1 as A$1[Arg]['type'] extends 'positional' ? Arg : never]: V[Arg] };
 /**
  * An arguments for {@link resolveArgs | resolve arguments}.
  */
@@ -526,7 +526,7 @@ type FilterPositionalArgs<A extends Args, V extends Record<keyof A, unknown>> =
  *
  * @typeParam A - {@link Args | Arguments}, which is an object that defines the command line arguments.
  */
-type ArgExplicitlyProvided<A extends Args> = { [K in keyof A]: boolean };
+type ArgExplicitlyProvided<A$1 extends Args> = { [K in keyof A$1]: boolean };
 /**
  * Resolve command line arguments.
  *
@@ -682,11 +682,11 @@ type PluginFunction<G extends GunshiParams = DefaultGunshiParams> = (ctx: Readon
  *
  * @since v0.27.0
  */
-type Plugin<E extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']> = PluginFunction & {
+type Plugin<E$1 extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']> = PluginFunction & {
   id: string;
   name?: string;
   dependencies?: (PluginDependency | string)[];
-  extension?: CommandContextExtension<E>;
+  extension?: CommandContextExtension<E$1>;
 };
 //#endregion
 //#region ../gunshi/src/types.d.ts
@@ -717,7 +717,7 @@ type ExtendContext = Record<string, unknown>;
  *
  * @since v0.27.0
  */
-interface GunshiParams<P extends {
+interface GunshiParams<P$1 extends {
   args?: Args;
   extensions?: ExtendContext;
 } = {
@@ -727,13 +727,13 @@ interface GunshiParams<P extends {
   /**
    * Command argument definitions.
    */
-  args: P extends {
+  args: P$1 extends {
     args: infer A extends Args;
   } ? A : Args;
   /**
    * Command context extensions.
    */
-  extensions: P extends {
+  extensions: P$1 extends {
     extensions: infer E extends ExtendContext;
   } ? E : {};
 }
@@ -1110,7 +1110,7 @@ type CommandContextCore<G extends GunshiParamsConstraint = DefaultGunshiParams>
  *
  * @since v0.27.0
  */
-interface CommandContextExtension<E extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']> {
+interface CommandContextExtension<E$1 extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']> {
   /**
    * Plugin identifier
    */
@@ -1118,7 +1118,7 @@ interface CommandContextExtension<E extends GunshiParams['extensions'] = Default
   /**
    * Plugin extension factory
    */
-  readonly factory: (ctx: CommandContextCore, cmd: Command) => Awaitable<E>;
+  readonly factory: (ctx: CommandContextCore, cmd: Command) => Awaitable<E$1>;
   /**
    * Plugin extension factory after hook
    */
@@ -1320,8 +1320,8 @@ type ValidationErrorsDecorator<G extends GunshiParamsConstraint = DefaultGunshiP
  * @param options - A {@link CliOptions | CLI options}
  * @returns A rendered usage or undefined. if you will use {@linkcode CliOptions.usageSilent} option, it will return rendered usage string.
  */
-declare function cli<A extends Args = Args, G extends GunshiParams = {
-  args: A;
+declare function cli<A$1 extends Args = Args, G extends GunshiParams = {
+  args: A$1;
   extensions: {};
 }>(args: string[], entry: Command<G> | CommandRunner<G> | LazyCommand<G>, options?: CliOptions<G>): Promise<string | undefined>;
 /**
@@ -1334,9 +1334,9 @@ declare function cli<A extends Args = Args, G extends GunshiParams = {
  * @param options - A {@link CliOptions | CLI options}
  * @returns A rendered usage or undefined. if you will use {@link CliOptions.usageSilent} option, it will return rendered usage string.
  */
-declare function cli<E extends ExtendContext = ExtendContext, G extends GunshiParams = {
+declare function cli<E$1 extends ExtendContext = ExtendContext, G extends GunshiParams = {
   args: Args;
-  extensions: E;
+  extensions: E$1;
 }>(args: string[], entry: Command<G> | CommandRunner<G> | LazyCommand<G>, options?: CliOptions<G>): Promise<string | undefined>;
 /**
  * Run the command.

package/lib/index.js

@@ -603,6 +603,21 @@ function deepFreeze(obj, ignores = []) {
 //#endregion
 //#region ../gunshi/src/context.ts
 /**
+* The entry for gunshi context.
+* This module is exported for the purpose of testing the command.
+*
+* @example
+* ```js
+* import { createCommandContext } from 'gunshi/context'
+* ```
+*
+* @module
+*/
+/**
+* @author kazuya kawaguchi (a.k.a. kazupon)
+* @license MIT
+*/
+/**
 * Create a command context.
 *
 * @param param - A {@link CommandContextParams | parameters} to create a command context.
@@ -675,7 +690,7 @@ function getCommandName(cmd) {
 
 //#endregion
 //#region ../gunshi/src/decorators.ts
-const EMPTY_RENDERER = async () => "";
+const EMPTY_RENDERER = () => Promise.resolve("");
 /**
 * Factory function for creating a decorators manager.
 *
@@ -834,6 +849,10 @@ function resolveDependencies(plugins) {
 //#endregion
 //#region ../gunshi/src/cli/core.ts
 /**
+* @author kazuya kawaguchi (a.k.a. kazupon)
+* @license MIT
+*/
+/**
 * Run the command.
 *
 * @typeParam G - A type extending {@linkcode GunshiParams} to specify the shape of command and cli options.
@@ -851,7 +870,7 @@ async function cliCore(argv, entry, options, plugins) {
 	const cliOptions = normalizeCliOptions(options, decorators, pluginContext);
 	const tokens = parseArgs(argv);
 	const subCommand = getSubCommand(tokens);
-	const { commandName: name, command, callMode } = await resolveCommand(subCommand, entry, cliOptions);
+	const { commandName: name, command, callMode } = resolveCommand(subCommand, entry, cliOptions);
 	if (!command) throw new Error(`Command not found: ${name || ""}`);
 	const args = resolveArguments(pluginContext, getCommandArgs(command));
 	const { explicit, values, positionals, rest, error } = resolveArgs(args, tokens, {
@@ -934,9 +953,9 @@ function getSubCommand(tokens) {
 	return firstToken && firstToken.kind === "positional" && firstToken.index === 0 && firstToken.value ? firstToken.value : "";
 }
 const CANNOT_RESOLVE_COMMAND = { callMode: "unexpected" };
-async function resolveCommand(sub, entry, options) {
+function resolveCommand(sub, entry, options) {
 	const omitted = !sub;
-	async function doResolveCommand() {
+	function doResolveCommand() {
 		if (typeof entry === "function") if ("commandName" in entry && entry.commandName) return {
 			commandName: entry.commandName,
 			command: entry,
@@ -1006,6 +1025,10 @@ async function executeCommand(cmd, ctx, decorators) {
 //#endregion
 //#region ../gunshi/src/cli/bone.ts
 /**
+* @author kazuya kawaguchi (a.k.a. kazupon)
+* @license MIT
+*/
+/**
 * Run the command.
 *
 * @typeParam G - A type extending {@linkcode GunshiParams} to specify the shape of command and cli options.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/bone",
   "description": "gunshi minimum",
-  "version": "0.27.0-beta.2",
+  "version": "0.27.0-beta.4",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -51,15 +51,15 @@
     }
   },
   "devDependencies": {
-    "deno": "^2.5.4",
+    "deno": "^2.5.6",
     "jsr": "^0.13.5",
     "jsr-exports-lint": "^0.4.1",
-    "publint": "^0.3.14",
-    "tsdown": "^0.15.6",
-    "@gunshi/definition": "0.27.0-beta.2",
-    "@gunshi/plugin-renderer": "0.27.0-beta.2",
-    "gunshi": "0.27.0-beta.2",
-    "@gunshi/plugin-global": "0.27.0-beta.2"
+    "publint": "^0.3.15",
+    "tsdown": "0.15.12",
+    "@gunshi/definition": "0.27.0-beta.4",
+    "@gunshi/plugin-global": "0.27.0-beta.4",
+    "gunshi": "0.27.0-beta.4",
+    "@gunshi/plugin-renderer": "0.27.0-beta.4"
   },
   "scripts": {
     "build": "tsdown",