@gunshi/plugin 1.0.0-beta.0 → 1.0.0-beta.1

package/lib/index.d.ts

@@ -55,9 +55,6 @@ interface ArgToken {
    */
   inlineValue?: boolean | undefined;
 }
-/**
- * Parser Options.
- */
 //#endregion
 //#region ../../node_modules/.pnpm/args-tokens@1.0.0-beta.1/node_modules/args-tokens/lib/resolver.d.ts
 //#region src/resolver.d.ts
@@ -701,7 +698,7 @@ interface Args {
  *
  * @typeParam T - {@link Args | Arguments} which is an object that defines the command line arguments.
  */
-type ArgValues<T> = T extends Args ? ResolveArgValues<T, { [Arg in keyof T]: ExtractOptionValue<T[Arg]> }> : {
+type ArgValues<T> = T extends Args ? ResolveArgValues<T, { [Arg in keyof T]: ExtractOptionValue<T[Arg]>; }> : {
   [option: string]: string | boolean | number | (string | boolean | number)[] | undefined;
 };
 /**
@@ -733,7 +730,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]?: IsPresentArg<A[Arg]> extends true ? unknown : V[Arg] } & { -readonly [Arg in keyof A as IsPresentArg<A[Arg]> extends true ? Arg : never]: V[Arg] } extends (infer P) ? { [K in keyof P]: P[K] } : never;
+type ResolveArgValues<A extends Args, V extends Record<keyof A, unknown>> = { -readonly [Arg in keyof A]?: IsPresentArg<A[Arg]> extends true ? unknown : V[Arg]; } & { -readonly [Arg in keyof A as IsPresentArg<A[Arg]> extends true ? Arg : never]: V[Arg]; } extends (infer P) ? { [K in keyof P]: P[K]; } : never;
 /**
  * Whether an argument with the schema `S` has a value: with a default, with `required: true` or as
  * a required positional argument. For a union of schemas, only when each schema of the union has
@@ -741,16 +738,6 @@ type ResolveArgValues<A extends Args, V extends Record<keyof A, unknown>> = { -r
  * value, as {@link FilterArgs} does.
  */
 type IsPresentArg<S extends ArgSchema> = S extends ArgSchema ? true extends (S['default'] extends {} ? true : S['required'] extends true ? true : false) ? true : IsRequiredPositionalArg<S> : never;
-/**
- * Filters the arguments based on their default values.
- *
- * @typeParam A - {@link Args | Arguments}, which is an object that defines the command line arguments.
- * @typeParam V - Resolvable argument values.
- * @typeParam K - Key of the {@link ArgSchema | argument schema} to filter by.
- *
- * @internal
- */
-
 type IsRequiredPositionalArg<A extends ArgSchema> = A['type'] extends 'positional' ? A['multiple'] extends true ? A['required'] extends true ? true : false : MayBeUnrequired<A> extends true ? A['default'] extends {} ? true : false : true : false;
 /**
  * Whether the `required` of `A` may be `false`. An optional `required` of type `boolean`, as in
@@ -761,10 +748,6 @@ type IsRequiredPositionalArg<A extends ArgSchema> = A['type'] extends 'positiona
 type MayBeUnrequired<A extends ArgSchema> = false extends A['required'] ? [A] extends [{
   required: unknown;
 }] ? true : boolean | undefined extends A['required'] ? false : true : false;
-/**
- * An arguments for {@link resolveArgs | resolve arguments}.
- */
-
 /**
  * Tracks which arguments were explicitly provided by the user.
  *
@@ -777,7 +760,7 @@ type MayBeUnrequired<A extends ArgSchema> = false extends A['required'] ? [A] ex
  *
  * @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 extends Args> = { [K in keyof A]: boolean; };
 //#endregion
 //#region ../gunshi/src/plugin/context.d.ts
 /**
@@ -858,12 +841,12 @@ interface PluginContext<G extends GunshiParamsConstraint = DefaultGunshiParams>
 }
 //#endregion
 //#region ../gunshi/src/plugin/core.d.ts
-type ProcessDependency<D, A extends ExtendContext> = D extends string ? D extends keyof A ? { [K in D]: A[K] } : {} : D extends {
+type ProcessDependency<D, A extends ExtendContext> = D extends string ? D extends keyof A ? { [K in D]: A[K]; } : {} : D extends {
   id: infer ID;
   optional?: any;
 } ? ID extends string ? ID extends keyof A ? D extends {
   optional: true;
-} ? { [K in ID]: A[K] | undefined } : { [K in ID]: A[K] } : {} : never : never;
+} ? { [K in ID]: A[K] | undefined; } : { [K in ID]: A[K]; } : {} : never : never;
 /**
  * Helper type to infer dependency extensions with optional support
  *
@@ -919,7 +902,7 @@ type PluginExtension<T = Record<string, unknown>, G extends GunshiParams = Defau
  */
 type OnPluginExtension<G extends GunshiParams = DefaultGunshiParams> = (ctx: Readonly<CommandContext<G>>, cmd: Readonly<Command<G>>) => Awaitable<void>;
 type IsStringLiteral<S extends string> = string extends S ? false : true;
-type MergeExtension<Id, ResolvedDepExt extends ExtendContext, PluginExt extends ExtendContext> = Id extends infer I ? I extends string ? IsStringLiteral<I> extends true ? ResolvedDepExt & { [K in I]: PluginExt } : ResolvedDepExt : ResolvedDepExt : ResolvedDepExt;
+type MergeExtension<Id, ResolvedDepExt extends ExtendContext, PluginExt extends ExtendContext> = Id extends (infer I) ? I extends string ? IsStringLiteral<I> extends true ? ResolvedDepExt & { [K in I]: PluginExt; } : ResolvedDepExt : ResolvedDepExt : ResolvedDepExt;
 /**
  * Extensions resolved from the declared plugin dependencies.
  *
@@ -955,15 +938,11 @@ type MergedPluginParams<Id extends string, Deps extends ReadonlyArray<PluginDepe
  *
  * @since v0.27.0
  */
-interface PluginOptions<DepExt extends ExtendContext = DefaultGunshiParams['extensions'],
-// for plugin dependency extensions
-Id extends string = string,
-// for plugin id
-Deps extends ReadonlyArray<PluginDependency | string> = (PluginDependency | string)[],
-// for plugin dependencies
-Ext extends Record<string, unknown> = {},
-// for plugin extension type
-ResolvedDepExt extends GunshiParams = DependencyParams<Deps, DepExt>, PluginExt extends PluginExtension<Ext, ResolvedDepExt> = PluginExtension<Ext, ResolvedDepExt>, MergedExt extends GunshiParams = MergedPluginParams<Id, Deps, DepExt, Awaited<ReturnType<PluginExt>>>> {
+interface PluginOptions<DepExt extends ExtendContext = DefaultGunshiParams['extensions'] // for plugin dependency extensions
+, Id extends string = string // for plugin id
+, Deps extends ReadonlyArray<PluginDependency | string> = (PluginDependency | string)[] // for plugin dependencies
+, Ext extends Record<string, unknown> = {} // for plugin extension type
+, ResolvedDepExt extends GunshiParams = DependencyParams<Deps, DepExt>, PluginExt extends PluginExtension<Ext, ResolvedDepExt> = PluginExtension<Ext, ResolvedDepExt>, MergedExt extends GunshiParams = MergedPluginParams<Id, Deps, DepExt, Awaited<ReturnType<PluginExt>>>> {
   /**
    * Plugin unique identifier.
    *
@@ -1066,15 +1045,11 @@ interface PluginWithoutExtension<E extends GunshiParams['extensions'] = DefaultG
  *
  * @since v0.27.0
  */
-declare function plugin<Context extends ExtendContext = DefaultGunshiParams['extensions'],
-// for plugin dependency extensions
-Id extends string = string,
-// for plugin id
-Deps extends ReadonlyArray<PluginDependency | string> = [],
-// for plugin dependencies
-Extension extends {} = {},
-// for plugin extension type
-ResolvedDepExtensions extends GunshiParams = DependencyParams<Deps, Context>, PluginExt extends PluginExtension<Extension, DefaultGunshiParams> = PluginExtension<Extension, ResolvedDepExtensions>, MergedExtensions extends GunshiParams = MergedPluginParams<Id, Deps, Context, Awaited<ReturnType<PluginExt>>>>(options: {
+declare function plugin<Context extends ExtendContext = DefaultGunshiParams['extensions'] // for plugin dependency extensions
+, Id extends string = string // for plugin id
+, Deps extends ReadonlyArray<PluginDependency | string> = [] // for plugin dependencies
+, Extension extends {} = {} // for plugin extension type
+, ResolvedDepExtensions extends GunshiParams = DependencyParams<Deps, Context>, PluginExt extends PluginExtension<Extension, DefaultGunshiParams> = PluginExtension<Extension, ResolvedDepExtensions>, MergedExtensions extends GunshiParams = MergedPluginParams<Id, Deps, Context, Awaited<ReturnType<PluginExt>>>>(options: {
   id: Id;
   name?: string;
   dependencies?: Deps;
@@ -1095,15 +1070,11 @@ ResolvedDepExtensions extends GunshiParams = DependencyParams<Deps, Context>, Pl
  *
  * @since v0.27.0
  */
-declare function plugin<Context extends ExtendContext = DefaultGunshiParams['extensions'],
-// for plugin dependency extensions
-Id extends string = string,
-// for plugin id
-Deps extends ReadonlyArray<PluginDependency | string> = [],
-// for plugin dependencies
-Extension extends Record<string, unknown> = {},
-// for plugin extension type
-ResolvedDepExtensions extends GunshiParams = DependencyParams<Deps, Context>, PluginExt extends PluginExtension<Extension, DefaultGunshiParams> = PluginExtension<Extension, ResolvedDepExtensions>, MergedExtensions extends GunshiParams = MergedPluginParams<Id, Deps, Context, Awaited<ReturnType<PluginExt>>>>(options: {
+declare function plugin<Context extends ExtendContext = DefaultGunshiParams['extensions'] // for plugin dependency extensions
+, Id extends string = string // for plugin id
+, Deps extends ReadonlyArray<PluginDependency | string> = [] // for plugin dependencies
+, Extension extends Record<string, unknown> = {} // for plugin extension type
+, ResolvedDepExtensions extends GunshiParams = DependencyParams<Deps, Context>, PluginExt extends PluginExtension<Extension, DefaultGunshiParams> = PluginExtension<Extension, ResolvedDepExtensions>, MergedExtensions extends GunshiParams = MergedPluginParams<Id, Deps, Context, Awaited<ReturnType<PluginExt>>>>(options: {
   id: Id;
   name?: string;
   dependencies?: Deps;
@@ -1123,7 +1094,7 @@ type Awaitable<T> = T | Promise<T>;
  *
  * @typeParam T - The type to be prettified.
  */
-type Prettify<T> = { [K in keyof T]: T[K] } & {};
+type Prettify<T> = { [K in keyof T]: T[K]; } & {};
 /**
  * Extend command context type. This type is used to extend the command context with additional properties at {@linkcode CommandContext.extensions}.
  *
@@ -1876,7 +1847,7 @@ declare const CLI_OPTIONS_DEFAULT: CliOptions<DefaultGunshiParams>;
  *
  * @internal
  */
-type ExtractExtensionValues<E extends Record<string, CommandContextExtension>> = { [K in keyof E]: E[K] extends CommandContextExtension<infer T> ? T : never };
+type ExtractExtensionValues<E extends Record<string, CommandContextExtension>> = { [K in keyof E]: E[K] extends CommandContextExtension<infer T> ? T : never; };
 /**
  * Return type of {@link createCommandContext}
  *
@@ -1957,22 +1928,7 @@ interface CommandContextParams<G extends GunshiParams | {
  * @param param - A {@link CommandContextParams | parameters} to create a command context.
  * @returns A {@link CommandContext | command context}, which is readonly.
  */
-declare function createCommandContext<G extends GunshiParamsConstraint = DefaultGunshiParams, V extends ArgValues<ExtractArgs<G>> = ArgValues<ExtractArgs<G>>, C extends Command<G> | LazyCommand<G> = Command<G>, E extends Record<string, CommandContextExtension> = {}>({
-  args,
-  explicit,
-  values,
-  positionals,
-  rest,
-  argv,
-  tokens,
-  command,
-  extensions,
-  cliOptions,
-  callMode,
-  commandPath,
-  omitted,
-  validationError
-}: CommandContextParams<G, V, C, E>): Promise<CommandContextResult<G, E>>;
+declare function createCommandContext<G extends GunshiParamsConstraint = DefaultGunshiParams, V extends ArgValues<ExtractArgs<G>> = ArgValues<ExtractArgs<G>>, C extends Command<G> | LazyCommand<G> = Command<G>, E extends Record<string, CommandContextExtension> = {}>({ args, explicit, values, positionals, rest, argv, tokens, command, extensions, cliOptions, callMode, commandPath, omitted, validationError }: CommandContextParams<G, V, C, E>): Promise<CommandContextResult<G, E>>;
 //#endregion
 //#region ../gunshi/src/error.d.ts
 /**
@@ -2128,11 +2084,4 @@ declare function isArgsValidationError(error: unknown): error is ArgsValidationE
  */
 declare function hasPriorityValidationError(error: AggregateError | undefined): boolean;
 //#endregion
-//#region src/index.d.ts
-/**
-* @author kazuya kawaguchi (a.k.a. kazupon)
-* @license MIT
-*/
-
-//#endregion
-export { ANONYMOUS_COMMAND_NAME, type ArgSchema, type ArgToken, type ArgValues, type Args, ArgsValidationError, ArgsValidationErrorCode, ArgsValidationErrorKeys, Awaitable, CLI_OPTIONS_DEFAULT, Command, CommandContext, CommandContextCore, CommandContextExtension, CommandContextParams, CommandDecorator, CommandExamplesFetcher, CommandNotFoundError, CommandNotFoundErrorCode, CommandNotFoundErrorKeys, CommandNotFoundErrorOptions, CommandResolutionError, CommandResolutionErrorCode, CommandResolutionErrorKeys, CommandResolutionErrorOptions, CommandRunner, DefaultGunshiParams, ExtendContext, ExtractArgs, ExtractExtensions, GunshiParams, GunshiParamsConstraint, LazyCommand, MergeGunshiExtensions, NormalizeToGunshiParams, OnPluginExtension, Plugin, PluginContext, PluginDependency, PluginExtension, PluginFunction, PluginOptions, PluginWithExtension, PluginWithoutExtension, Prettify, RendererDecorator, ValidationErrorsDecorator, createCommandContext, hasPriorityValidationError, isArgsValidationError, isCommandNotFoundError, isCommandResolutionError, plugin };
+export { ANONYMOUS_COMMAND_NAME, type ArgSchema, type ArgToken, type ArgValues, type Args, ArgsValidationError, type ArgsValidationErrorCode, ArgsValidationErrorKeys, type Awaitable, CLI_OPTIONS_DEFAULT, type Command, type CommandContext, type CommandContextCore, type CommandContextExtension, type CommandContextParams, type CommandDecorator, type CommandExamplesFetcher, CommandNotFoundError, type CommandNotFoundErrorCode, CommandNotFoundErrorKeys, type CommandNotFoundErrorOptions, CommandResolutionError, type CommandResolutionErrorCode, CommandResolutionErrorKeys, type CommandResolutionErrorOptions, type CommandRunner, type DefaultGunshiParams, type ExtendContext, type ExtractArgs, type ExtractExtensions, type GunshiParams, type GunshiParamsConstraint, type LazyCommand, type MergeGunshiExtensions, type NormalizeToGunshiParams, type OnPluginExtension, type Plugin, type PluginContext, type PluginDependency, type PluginExtension, type PluginFunction, type PluginOptions, type PluginWithExtension, type PluginWithoutExtension, type Prettify, type RendererDecorator, type ValidationErrorsDecorator, createCommandContext, hasPriorityValidationError, isArgsValidationError, isCommandNotFoundError, isCommandResolutionError, plugin };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/plugin",
   "description": "plugin development kit for gunshi",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0-beta.1",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -52,11 +52,11 @@
   },
   "devDependencies": {
     "deno": "^2.7.14",
+    "gunshi": "1.0.0-beta.1",
     "jsr": "^0.14.3",
     "jsr-exports-lint": "^0.4.2",
     "publint": "^0.3.20",
-    "tsdown": "0.21.0",
-    "gunshi": "1.0.0-beta.0"
+    "tsdown": "0.22.14"
   },
   "scripts": {
     "build": "tsdown",