@gunshi/plugin 0.26.3 → 0.27.0-alpha.5

package/lib/index.d.ts

@@ -48,13 +48,14 @@ interface ArgToken {
   * Inline value, e.g. `--foo=bar` => `true`, `-x=bar` => `true`.
   */
   inlineValue?: boolean;
-} //#endregion
-//#region ../../node_modules/.pnpm/args-tokens@0.20.1/node_modules/args-tokens/lib/resolver-U72Jg6Ll.d.ts
-
+}
 /**
 * Parser Options.
 */
+//#endregion
+//#region ../../node_modules/.pnpm/args-tokens@0.20.1/node_modules/args-tokens/lib/resolver-U72Jg6Ll.d.ts
 //#region src/resolver.d.ts
+
 /**
 * An argument schema
 * This schema is similar to the schema of the `node:utils`.
@@ -142,20 +143,21 @@ 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] };
-
-//#endregion
-//#region ../gunshi/src/types.d.ts
 /**
 * An arguments for {@link resolveArgs | resolve arguments}.
 */
+//#endregion
+//#region ../gunshi/src/types.d.ts
 type Awaitable<T> = T | Promise<T>;
 /**
  * Extend command context type. This type is used to extend the command context with additional properties at {@link CommandContext.extensions}.
+ * @since v0.27.0
  */
 type ExtendContext = Record<string, unknown>;
 /**
  * Gunshi unified parameter type.
  * This type combines both argument definitions and command context extensions.
+ * @since v0.27.0
  */
 interface GunshiParams<P extends {
   args?: Args;
@@ -179,11 +181,13 @@ interface GunshiParams<P extends {
 }
 /**
  * Default Gunshi parameters
+ * @since v0.27.0
  */
 type DefaultGunshiParams = GunshiParams;
 /**
  * Generic constraint for command-related types.
  * This type constraint allows both GunshiParams and objects with extensions.
+ * @since v0.27.0
  */
 type GunshiParamsConstraint = GunshiParams<any> | {
   extensions: ExtendContext;
@@ -285,16 +289,19 @@ interface CommandEnvironment<G extends GunshiParamsConstraint = DefaultGunshiPar
   /**
    * Hook that runs before any command execution
    * @see {@link CliOptions.onBeforeCommand}
+   * @since v0.27.0
    */
   onBeforeCommand: ((ctx: Readonly<CommandContext<G>>) => Awaitable<void>) | undefined;
   /**
    * Hook that runs after successful command execution
    * @see {@link CliOptions.onAfterCommand}
+   * @since v0.27.0
    */
-  onAfterCommand: ((ctx: Readonly<CommandContext<G>>, result: string | void) => Awaitable<void>) | undefined;
+  onAfterCommand: ((ctx: Readonly<CommandContext<G>>, result: string | undefined) => Awaitable<void>) | undefined;
   /**
    * Hook that runs when a command throws an error
    * @see {@link CliOptions.onErrorCommand}
+   * @since v0.27.0
    */
   onErrorCommand: ((ctx: Readonly<CommandContext<G>>, error: Error) => Awaitable<void>) | undefined;
 }
@@ -377,7 +384,8 @@ interface CommandContext<G extends GunshiParamsConstraint = DefaultGunshiParams>
    */
   log: (message?: any, ...optionalParams: any[]) => void;
   /**
-   *  Command context extensions.
+   * Command context extensions.
+   * @since v0.27.0
    */
   extensions: keyof ExtractExtensions<G> extends never ? undefined : ExtractExtensions<G>;
   /**
@@ -388,10 +396,12 @@ interface CommandContext<G extends GunshiParamsConstraint = DefaultGunshiParams>
 }
 /**
  * CommandContextCore type (base type without extensions)
+ * @since v0.27.0
  */
 type CommandContextCore<G extends GunshiParamsConstraint = DefaultGunshiParams> = Readonly<CommandContext<G>>;
 /**
  * Command context extension
+ * @since v0.27.0
  */
 interface CommandContextExtension<E extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']> {
   readonly key: symbol;
@@ -461,7 +471,7 @@ type CommandExamplesFetcher<G extends GunshiParamsConstraint = DefaultGunshiPara
  * @param ctx A {@link CommandContext | command context}
  * @returns void or string (for CLI output)
  */
-type CommandRunner<G extends GunshiParamsConstraint = DefaultGunshiParams> = (ctx: Readonly<CommandContext<G>>) => Awaitable<void | string>;
+type CommandRunner<G extends GunshiParamsConstraint = DefaultGunshiParams> = (ctx: Readonly<CommandContext<G>>) => Awaitable<string | void>;
 /**
  * Command loader.
  * A function that returns a command or command runner.
@@ -474,14 +484,16 @@ type CommandRunner<G extends GunshiParamsConstraint = DefaultGunshiParams> = (ct
  * A function that wraps a command runner to add or modify its behavior.
  * @param baseRunner The base command runner to decorate
  * @returns The decorated command runner
+ * @since v0.27.0
  */
-type CommandDecorator<G extends GunshiParamsConstraint = DefaultGunshiParams> = (baseRunner: (ctx: Readonly<CommandContext<G>>) => Awaitable<void | string>) => (ctx: Readonly<CommandContext<G>>) => Awaitable<void | string>;
+type CommandDecorator<G extends GunshiParamsConstraint = DefaultGunshiParams> = (baseRunner: (ctx: Readonly<CommandContext<G>>) => Awaitable<string | void>) => (ctx: Readonly<CommandContext<G>>) => Awaitable<string | void>;
 /**
  * Renderer decorator type.
  * A function that wraps a base renderer to add or modify its behavior.
  * @param baseRenderer The base renderer function to decorate
  * @param ctx The command context
  * @returns The decorated result
+ * @since v0.27.0
  */
 type RendererDecorator<T, G extends GunshiParamsConstraint = DefaultGunshiParams> = (baseRenderer: (ctx: Readonly<CommandContext<G>>) => Promise<T>, ctx: Readonly<CommandContext<G>>) => Promise<T>;
 /**
@@ -491,8 +503,10 @@ type RendererDecorator<T, G extends GunshiParamsConstraint = DefaultGunshiParams
  * @param ctx The command context
  * @param error The aggregate error containing validation errors
  * @returns The decorated result
+ * @since v0.27.0
  */
-type ValidationErrorsDecorator<G extends GunshiParamsConstraint = DefaultGunshiParams> = (baseRenderer: (ctx: Readonly<CommandContext<G>>, error: AggregateError) => Promise<string>, ctx: Readonly<CommandContext<G>>, error: AggregateError) => Promise<string>; //#endregion
+type ValidationErrorsDecorator<G extends GunshiParamsConstraint = DefaultGunshiParams> = (baseRenderer: (ctx: Readonly<CommandContext<G>>, error: AggregateError) => Promise<string>, ctx: Readonly<CommandContext<G>>, error: AggregateError) => Promise<string>;
+//#endregion
 //#region ../gunshi/src/plugin/context.d.ts
 /**
  * Type helper to create GunshiParams from extracted args and extensions
@@ -504,6 +518,7 @@ type ExtractedParams<G extends GunshiParamsConstraint, L extends Record<string,
 };
 /**
  * Gunshi plugin context interface.
+ * @since v0.27.0
  */
 interface PluginContext<G extends GunshiParamsConstraint = DefaultGunshiParams> {
   /**
@@ -539,16 +554,16 @@ interface PluginContext<G extends GunshiParamsConstraint = DefaultGunshiParams>
    */
   decorateCommand<L extends Record<string, unknown> = DefaultGunshiParams['extensions']>(decorator: (baseRunner: (ctx: Readonly<CommandContext<ExtractedParams<G, L>>>) => Awaitable<void | string>) => (ctx: Readonly<CommandContext<ExtractedParams<G, L>>>) => Awaitable<void | string>): void;
 }
-
-//#endregion
-//#region ../gunshi/src/plugin/core.d.ts
 /**
  * Factory function for creating a plugin context.
  * @param decorators - A {@link Decorators} instance.
  * @returns A new {@link PluginContext} instance.
  */
+//#endregion
+//#region ../gunshi/src/plugin/core.d.ts
 /**
  * Plugin dependency definition
+ * @since v0.27.0
  */
 interface PluginDependency {
   /**
@@ -562,19 +577,23 @@ interface PluginDependency {
   optional?: boolean;
 }
 /**
- *  Plugin function type
+ * Plugin function type
+ * @since v0.27.0
  */
 type PluginFunction<G extends GunshiParams = DefaultGunshiParams> = (ctx: Readonly<PluginContext<G>>) => Awaitable<void>;
 /**
  * Plugin extension for CommandContext
+ * @since v0.27.0
  */
 type PluginExtension<T = Record<string, unknown>, G extends GunshiParams = DefaultGunshiParams> = (ctx: CommandContextCore<G>, cmd: Command<G>) => T;
 /**
  * Plugin extension callback type
+ * @since v0.27.0
  */
 type OnPluginExtension<G extends GunshiParams = DefaultGunshiParams> = (ctx: Readonly<CommandContext<G>>, cmd: Readonly<Command<G>>) => void;
 /**
  * Plugin definition options
+ * @since v0.27.0
  */
 interface PluginOptions<T extends Record<string, unknown> = Record<never, never>, G extends GunshiParams = DefaultGunshiParams> {
   /**
@@ -606,6 +625,7 @@ interface PluginOptions<T extends Record<string, unknown> = Record<never, never>
  * Gunshi plugin, which is a function that receives a PluginContext.
  * @param ctx - A {@link PluginContext}.
  * @returns An {@link Awaitable} that resolves when the plugin is loaded.
+ * @since v0.27.0
  */
 type Plugin<E extends GunshiParams['extensions'] = DefaultGunshiParams['extensions']> = PluginFunction & {
   id: string;
@@ -636,6 +656,7 @@ interface PluginWithoutExtension<E extends GunshiParams['extensions'] = DefaultG
  * Define a plugin with extension capabilities
  * @param options - {@link PluginOptions | plugin options}
  * @return A defined plugin with extension capabilities.
+ * @since v0.27.0
  */
 declare function plugin<I extends string, P extends PluginExtension<any, DefaultGunshiParams>>(options: {
   id: I;
@@ -655,6 +676,7 @@ declare function plugin<I extends string, P extends PluginExtension<any, Default
  * Define a plugin without extension capabilities
  * @param options - {@link PluginOptions | plugin options} without extension
  * @returns A defined plugin without extension capabilities.
+ * @since v0.27.0
  */
 declare function plugin(options: {
   id: string;
@@ -662,6 +684,5 @@ declare function plugin(options: {
   dependencies?: (PluginDependency | string)[];
   setup?: (ctx: Readonly<PluginContext<DefaultGunshiParams>>) => Awaitable<void>;
 }): PluginWithoutExtension<DefaultGunshiParams['extensions']>;
-
 //#endregion
 export { ArgSchema, ArgToken, ArgValues, Args, Awaitable, Command, CommandContext, CommandContextCore, CommandDecorator, CommandExamplesFetcher, CommandRunner, DefaultGunshiParams, ExtendContext, ExtractArgs, GunshiParams, GunshiParamsConstraint, LazyCommand, NormalizeToGunshiParams, OnPluginExtension, Plugin, PluginContext, PluginDependency, PluginExtension, PluginFunction, PluginOptions, PluginWithExtension, PluginWithoutExtension, RendererDecorator, ValidationErrorsDecorator, plugin };

package/lib/index.js

@@ -3,6 +3,7 @@
 * Define a plugin
 * @param options - {@link PluginOptions | plugin options}
 * @returns A defined plugin.
+* @since v0.27.0
 */
 function plugin(options) {
 	const { id, name, setup, extension, onExtension, dependencies } = options;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/plugin",
   "description": "utilities for gunshi plugin",
-  "version": "0.26.3",
+  "version": "0.27.0-alpha.5",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -51,12 +51,12 @@
     }
   },
   "devDependencies": {
-    "deno": "^2.3.3",
-    "jsr": "^0.13.4",
+    "deno": "^2.4.0",
+    "jsr": "^0.13.5",
     "jsr-exports-lint": "^0.4.1",
     "publint": "^0.3.12",
-    "tsdown": "^0.12.3",
-    "gunshi": "0.26.3"
+    "tsdown": "^0.12.9",
+    "gunshi": "0.27.0-alpha.5"
   },
   "scripts": {
     "build": "tsdown",