@gunshi/docs 0.27.0-beta.4 → 0.27.0-beta.5

package/README.md

@@ -0,0 +1,52 @@
+
+# Gunshi
+
+> Modern JavaScript Command-line library
+
+Robust, modular, flexible, and localizable CLI library
+
+## Table of Contents
+
+### Introduction
+
+- [What's Gunshi?](src/guide/introduction/what-is-gunshi)
+- [Setup](src/guide/introduction/setup)
+
+
+### Essentials
+
+- [Getting Started](src/guide/essentials/getting-started)
+- [Declarative Configuration](src/guide/essentials/declarative)
+- [Type Safe](src/guide/essentials/type-safe)
+- [Composable](src/guide/essentials/composable)
+- [Lazy & Async](src/guide/essentials/lazy-async)
+- [Auto Usage Generation](src/guide/essentials/auto-usage)
+- [Plugin System](src/guide/essentials/plugin-system)
+
+
+### Advanced
+
+- [Type System](src/guide/advanced/type-system)
+- [Command Hooks](src/guide/advanced/command-hooks)
+- [Context Extensions](src/guide/advanced/context-extensions)
+- [Custom Rendering](src/guide/advanced/custom-rendering)
+- [Internationalization](src/guide/advanced/internationalization)
+- [Documentation Generation](src/guide/advanced/docs-gen)
+- [Advanced Lazy Loading and Sub-Commands](src/guide/advanced/advanced-lazy-loading)
+
+
+### API References
+
+- [context](src/api/context/index)
+- [default](src/api/default/index)
+- [definition](src/api/definition/index)
+- [generator](src/api/generator/index)
+- [plugin](src/api/plugin/index)
+- [renderer](src/api/renderer/index)
+
+
+### Extra Topics
+
+- [Showcase](src/showcase)
+
+

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/docs",
   "description": "Documentation for gunshi",
-  "version": "0.27.0-beta.4",
+  "version": "0.27.0-beta.5",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"
@@ -13,6 +13,17 @@
     "directory": "packages/docs"
   },
   "type": "module",
+  "keywords": [
+    "command",
+    "option",
+    "cli",
+    "argument",
+    "args",
+    "argv",
+    "docs",
+    "documentation",
+    "llms"
+  ],
   "files": [
     "README.md",
     "src/api/context",

package/src/api/context/functions/createCommandContext.md

@@ -0,0 +1,36 @@
+[gunshi](../../index.md) / [context](../index.md) / createCommandContext
+
+# Function: createCommandContext()
+
+```ts
+function createCommandContext<G, V, C, E>(param): Promise<object extends ExtractExtensions<E> ? Readonly<CommandContext<G>> : Readonly<CommandContext<GunshiParams<{
+  args: ExtractArgs<G>;
+  extensions: ExtractExtensions<E>;
+}>>>>;
+```
+
+Create a command context.
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `G` *extends* [`GunshiParamsConstraint`](../../default/type-aliases/GunshiParamsConstraint.md) | [`DefaultGunshiParams`](../../default/type-aliases/DefaultGunshiParams.md) |
+| `V` *extends* `object` | [`ArgValues`](../../default/type-aliases/ArgValues.md)\<`ExtractArgs`\<`G`\>\> |
+| `C` *extends* \| [`Command`](../../default/interfaces/Command.md)\<`G`\> \| [`LazyCommand`](../../default/type-aliases/LazyCommand.md)\<`G`\> | [`Command`](../../default/interfaces/Command.md)\<`G`\> |
+| `E` *extends* `Record`\<`string`, [`CommandContextExtension`](../../default/interfaces/CommandContextExtension.md)\<\{ \}\>\> | `object` |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `param` | [`CommandContextParams`](../interfaces/CommandContextParams.md)\<`G`, `V`, `C`, `E`\> | A [parameters](../interfaces/CommandContextParams.md) to create a command context. |
+
+## Returns
+
+`Promise`\<`object` *extends* `ExtractExtensions`\<`E`\> ? `Readonly`\<[`CommandContext`](../../default/interfaces/CommandContext.md)\<`G`\>\> : `Readonly`\<[`CommandContext`](../../default/interfaces/CommandContext.md)\<[`GunshiParams`](../../default/interfaces/GunshiParams.md)\<\{
+  `args`: `ExtractArgs`\<`G`\>;
+  `extensions`: `ExtractExtensions`\<`E`\>;
+\}\>\>\>\>
+
+A [command context](../../default/interfaces/CommandContext.md), which is readonly.

package/src/api/context/index.md

@@ -0,0 +1,24 @@
+[gunshi](../index.md) / context
+
+# context
+
+The entry for gunshi context.
+This module is exported for the purpose of testing the command.
+
+## Example
+
+```js
+import { createCommandContext } from 'gunshi/context'
+```
+
+## Functions
+
+| Function | Description |
+| ------ | ------ |
+| [createCommandContext](functions/createCommandContext.md) | Create a command context. |
+
+## Interfaces
+
+| Interface | Description |
+| ------ | ------ |
+| [CommandContextParams](interfaces/CommandContextParams.md) | Parameters of [createCommandContext](functions/createCommandContext.md) |

package/src/api/context/interfaces/CommandContextParams.md

@@ -0,0 +1,32 @@
+[gunshi](../../index.md) / [context](../index.md) / CommandContextParams
+
+# Interface: CommandContextParams\<G, V, C, E\>
+
+Parameters of [createCommandContext](../functions/createCommandContext.md)
+
+## Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `G` *extends* \| [`GunshiParams`](../../default/interfaces/GunshiParams.md) \| \{ `args`: [`Args`](../../default/interfaces/Args.md); \} \| \{ `extensions`: [`ExtendContext`](../../default/type-aliases/ExtendContext.md); \} | - |
+| `V` *extends* [`ArgValues`](../../default/type-aliases/ArgValues.md)\<`ExtractArgs`\<`G`\>\> | - |
+| `C` *extends* \| [`Command`](../../default/interfaces/Command.md)\<`G`\> \| [`LazyCommand`](../../default/type-aliases/LazyCommand.md)\<`G`\> | [`Command`](../../default/interfaces/Command.md)\<`G`\> |
+| `E` *extends* `Record`\<`string`, [`CommandContextExtension`](../../default/interfaces/CommandContextExtension.md)\> | `Record`\<`string`, [`CommandContextExtension`](../../default/interfaces/CommandContextExtension.md)\> |
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="args"></a> `args?` | `ExtractArgs`\<`G`\> | An arguments of target command |
+| <a id="argv"></a> `argv?` | `string`[] | Original command line arguments |
+| <a id="callmode"></a> `callMode?` | [`CommandCallMode`](../../default/type-aliases/CommandCallMode.md) | Command call mode. |
+| <a id="clioptions"></a> `cliOptions?` | [`CliOptions`](../../default/interfaces/CliOptions.md)\<`G`\> | A command options, which is spicialized from `cli` function |
+| <a id="command"></a> `command?` | `C` | A target command |
+| <a id="explicit"></a> `explicit?` | `ArgExplicitlyProvided`\<`ExtractArgs`\<`G`\>\> | Explicitly provided arguments |
+| <a id="extensions"></a> `extensions?` | `E` | Plugin extensions to apply as the command context extension. |
+| <a id="omitted"></a> `omitted?` | `boolean` | Whether the command is omitted |
+| <a id="positionals"></a> `positionals?` | `string`[] | A positionals arguments, which passed to the target command |
+| <a id="rest"></a> `rest?` | `string`[] | A rest arguments, which passed to the target command |
+| <a id="tokens"></a> `tokens?` | [`ArgToken`](../../default/interfaces/ArgToken.md)[] | Argument tokens that are parsed by the `parseArgs` function |
+| <a id="validationerror"></a> `validationError?` | `AggregateError` | Validation error from argument parsing. |
+| <a id="values"></a> `values?` | `V` | A values of target command |

package/src/api/default/classes/DefaultTranslation.md

@@ -0,0 +1,146 @@
+[gunshi](../../index.md) / [default](../index.md) / DefaultTranslation
+
+# Class: DefaultTranslation
+
+Default implementation of `TranslationAdapter`.
+
+## Implements
+
+- `TranslationAdapter`
+
+## Constructors
+
+### Constructor
+
+```ts
+new DefaultTranslation(options): DefaultTranslation;
+```
+
+Creates a new instance of DefaultTranslation.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | `TranslationAdapterFactoryOptions` | Options for the translation adapter, see `TranslationAdapterFactoryOptions` |
+
+#### Returns
+
+`DefaultTranslation`
+
+## Methods
+
+### getMessage()
+
+```ts
+getMessage(locale, key): string | undefined;
+```
+
+Get a message of locale.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `locale` | `string` | A locale of message (BCP 47 language tag) |
+| `key` | `string` | A key of message resource |
+
+#### Returns
+
+`string` \| `undefined`
+
+A message of locale. If message not found, return `undefined`.
+
+#### Implementation of
+
+```ts
+TranslationAdapter.getMessage
+```
+
+***
+
+### getResource()
+
+```ts
+getResource(locale): Record<string, string> | undefined;
+```
+
+Get a resource of locale.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `locale` | `string` | A locale of resource (BCP 47 language tag) |
+
+#### Returns
+
+`Record`\<`string`, `string`\> \| `undefined`
+
+A resource of locale. If resource not found, return `undefined`.
+
+#### Implementation of
+
+```ts
+TranslationAdapter.getResource
+```
+
+***
+
+### setResource()
+
+```ts
+setResource(locale, resource): void;
+```
+
+Set a resource of locale.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `locale` | `string` | A locale of resource (BCP 47 language tag) |
+| `resource` | `Record`\<`string`, `string`\> | A resource of locale |
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+```ts
+TranslationAdapter.setResource
+```
+
+***
+
+### translate()
+
+```ts
+translate(
+   locale, 
+   key, 
+   values): string | undefined;
+```
+
+Translate a message.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `locale` | `string` | A locale of message (BCP 47 language tag) |
+| `key` | `string` | A key of message resource |
+| `values` | `Record`\<`string`, `unknown`\> | A values to interpolate in the message |
+
+#### Returns
+
+`string` \| `undefined`
+
+A translated message, if message is not translated, return `undefined`.
+
+#### Implementation of
+
+```ts
+TranslationAdapter.translate
+```

package/src/api/default/functions/cli.md

@@ -0,0 +1,147 @@
+[gunshi](../../index.md) / [default](../index.md) / cli
+
+# Function: cli()
+
+Run the command.
+
+## Type Param
+
+A type extending [`GunshiParams`](../interfaces/GunshiParams.md) to specify the shape of command and cli options.
+
+## Param
+
+Command line arguments
+
+## Param
+
+A [entry command](../interfaces/Command.md), an [inline command runner](../type-aliases/CommandRunner.md), or a [lazily-loaded command](../type-aliases/LazyCommand.md)
+
+## Param
+
+A [CLI options](../interfaces/CliOptions.md)
+
+## Call Signature
+
+```ts
+function cli<G>(
+   args, 
+   entry, 
+options?): Promise<string | undefined>;
+```
+
+Run the command.
+
+### Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `G` *extends* [`GunshiParamsConstraint`](../type-aliases/GunshiParamsConstraint.md) | A type extending [`GunshiParams`](../interfaces/GunshiParams.md) to specify the shape of command and cli options. |
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `string`[] | Command line arguments |
+| `entry` | \| [`Command`](../interfaces/Command.md)\<`G`\> \| [`CommandRunner`](../type-aliases/CommandRunner.md)\<`G`\> \| [`LazyCommand`](../type-aliases/LazyCommand.md)\<`G`\> | A [entry command](../interfaces/Command.md), an [inline command runner](../type-aliases/CommandRunner.md), or a [lazily-loaded command](../type-aliases/LazyCommand.md) |
+| `options?` | [`CliOptions`](../interfaces/CliOptions.md)\<`G`\> | A [CLI options](../interfaces/CliOptions.md) |
+
+### Returns
+
+`Promise`\<`string` \| `undefined`\>
+
+A rendered usage or undefined. if you will use [`CliOptions.usageSilent`](../interfaces/CliOptions.md#usagesilent) option, it will return rendered usage string.
+
+## Call Signature
+
+```ts
+function cli<A, G>(
+   args, 
+   entry, 
+options?): Promise<string | undefined>;
+```
+
+Run the command.
+
+### Type Parameters
+
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `A` *extends* [`Args`](../interfaces/Args.md) | [`Args`](../interfaces/Args.md) | The type of [`arguments`](../interfaces/Args.md) defined in the command and cli options. |
+| `G` *extends* [`GunshiParams`](../interfaces/GunshiParams.md)\<\{ `args`: [`Args`](../interfaces/Args.md); `extensions`: \{ \}; \}\> | `object` | - |
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `string`[] | Command line arguments |
+| `entry` | \| [`Command`](../interfaces/Command.md)\<`G`\> \| [`CommandRunner`](../type-aliases/CommandRunner.md)\<`G`\> \| [`LazyCommand`](../type-aliases/LazyCommand.md)\<`G`\> | A [entry command](../interfaces/Command.md), an [inline command runner](../type-aliases/CommandRunner.md), or a [lazily-loaded command](../type-aliases/LazyCommand.md) |
+| `options?` | [`CliOptions`](../interfaces/CliOptions.md)\<`G`\> | A [CLI options](../interfaces/CliOptions.md) |
+
+### Returns
+
+`Promise`\<`string` \| `undefined`\>
+
+A rendered usage or undefined. if you will use [`CliOptions.usageSilent`](../interfaces/CliOptions.md#usagesilent) option, it will return rendered usage string.
+
+## Call Signature
+
+```ts
+function cli<E, G>(
+   args, 
+   entry, 
+options?): Promise<string | undefined>;
+```
+
+Run the command.
+
+### Type Parameters
+
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `E` *extends* [`ExtendContext`](../type-aliases/ExtendContext.md) | [`ExtendContext`](../type-aliases/ExtendContext.md) | An [`ExtendContext`](../type-aliases/ExtendContext.md) type to specify the shape of command and cli options. |
+| `G` *extends* [`GunshiParams`](../interfaces/GunshiParams.md)\<\{ `args`: [`Args`](../interfaces/Args.md); `extensions`: \{ \}; \}\> | `object` | - |
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `string`[] | Command line arguments |
+| `entry` | \| [`Command`](../interfaces/Command.md)\<`G`\> \| [`CommandRunner`](../type-aliases/CommandRunner.md)\<`G`\> \| [`LazyCommand`](../type-aliases/LazyCommand.md)\<`G`\> | A [entry command](../interfaces/Command.md), an [inline command runner](../type-aliases/CommandRunner.md), or a [lazily-loaded command](../type-aliases/LazyCommand.md) |
+| `options?` | [`CliOptions`](../interfaces/CliOptions.md)\<`G`\> | A [CLI options](../interfaces/CliOptions.md) |
+
+### Returns
+
+`Promise`\<`string` \| `undefined`\>
+
+A rendered usage or undefined. if you will use [`CliOptions.usageSilent`](../interfaces/CliOptions.md#usagesilent) option, it will return rendered usage string.
+
+## Call Signature
+
+```ts
+function cli<G>(
+   args, 
+   entry, 
+options?): Promise<string | undefined>;
+```
+
+Run the command.
+
+### Type Parameters
+
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `G` *extends* [`GunshiParams`](../interfaces/GunshiParams.md)\<\{ `args`: [`Args`](../interfaces/Args.md); `extensions`: \{ \}; \}\> | [`DefaultGunshiParams`](../type-aliases/DefaultGunshiParams.md) | A type extending [`GunshiParams`](../interfaces/GunshiParams.md) to specify the shape of command and cli options. |
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `string`[] | Command line arguments |
+| `entry` | \| [`Command`](../interfaces/Command.md)\<`G`\> \| [`CommandRunner`](../type-aliases/CommandRunner.md)\<`G`\> \| [`LazyCommand`](../type-aliases/LazyCommand.md)\<`G`\> | A [entry command](../interfaces/Command.md), an [inline command runner](../type-aliases/CommandRunner.md), or a [lazily-loaded command](../type-aliases/LazyCommand.md) |
+| `options?` | [`CliOptions`](../interfaces/CliOptions.md)\<`G`\> | A [CLI options](../interfaces/CliOptions.md) |
+
+### Returns
+
+`Promise`\<`string` \| `undefined`\>
+
+A rendered usage or undefined. if you will use [`CliOptions.usageSilent`](../interfaces/CliOptions.md#usagesilent) option, it will return rendered usage string.

package/src/api/default/functions/parseArgs.md

@@ -0,0 +1,34 @@
+[gunshi](../../index.md) / [default](../index.md) / parseArgs
+
+# Function: parseArgs()
+
+```ts
+function parseArgs(args, options?): ArgToken[];
+```
+
+Parse command line arguments.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `string`[] | command line arguments |
+| `options?` | `ParserOptions` | parse options, about details see ParserOptions |
+
+## Returns
+
+[`ArgToken`](../interfaces/ArgToken.md)[]
+
+Argument tokens.
+
+## Example
+
+```js
+import { parseArgs } from 'args-tokens' // for Node.js and Bun
+// import { parseArgs } from 'jsr:@kazupon/args-tokens' // for Deno
+
+const tokens = parseArgs(['--foo', 'bar', '-x', '--bar=baz'])
+// do something with using tokens
+// ...
+console.log('tokens:', tokens)
+```

package/src/api/default/functions/plugin.md

@@ -0,0 +1,98 @@
+[gunshi](../../index.md) / [default](../index.md) / plugin
+
+# Function: plugin()
+
+Define a plugin
+
+## Param
+
+[`plugin options`](../interfaces/PluginOptions.md)
+
+## Since
+
+v0.27.0
+
+## Call Signature
+
+```ts
+function plugin<Context, Id, Deps, Extension, ResolvedDepExtensions, PluginExt, MergedExtensions>(options): PluginWithExtension<Awaited<ReturnType<PluginExt>>>;
+```
+
+Define a plugin with extension compatibility and typed dependency extensions
+
+### Type Parameters
+
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `Context` *extends* [`ExtendContext`](../type-aliases/ExtendContext.md) | `object` | A type extending [`ExtendContext`](../type-aliases/ExtendContext.md) to specify the shape of plugin dependency extensions. |
+| `Id` *extends* `string` | `string` | A string type to specify the plugin ID. |
+| `Deps` *extends* readonly (`string` \| [`PluginDependency`](../interfaces/PluginDependency.md))[] | \[\] | A readonly array of [`PluginDependency`](../interfaces/PluginDependency.md) or string to specify the plugin dependencies. |
+| `Extension` *extends* `object` | `object` | A type to specify the shape of the plugin extension object. |
+| `ResolvedDepExtensions` *extends* [`GunshiParams`](../interfaces/GunshiParams.md)\<\{ `args`: [`Args`](../interfaces/Args.md); `extensions`: \{ \}; \}\> | [`GunshiParams`](../interfaces/GunshiParams.md)\<\{ `args`: [`Args`](../interfaces/Args.md); `extensions`: `InferDependencyExtensions`\<`Deps`, `Context`\>; \}\> | - |
+| `PluginExt` *extends* [`PluginExtension`](../type-aliases/PluginExtension.md)\<`Extension`, [`DefaultGunshiParams`](../type-aliases/DefaultGunshiParams.md)\> | [`PluginExtension`](../type-aliases/PluginExtension.md)\<`Extension`, `ResolvedDepExtensions`\> | - |
+| `MergedExtensions` *extends* [`GunshiParams`](../interfaces/GunshiParams.md)\<\{ `args`: [`Args`](../interfaces/Args.md); `extensions`: \{ \}; \}\> | [`GunshiParams`](../interfaces/GunshiParams.md)\<\{ `args`: [`Args`](../interfaces/Args.md); `extensions`: `MergeExtension`\<`Id`, `InferDependencyExtensions`\<`Deps`, `Context`\>, `Awaited`\<`ReturnType`\<`PluginExt`\>\>\>; \}\> | - |
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \{ `dependencies?`: `Deps`; `extension`: `PluginExt`; `id`: `Id`; `name?`: `string`; `onExtension?`: [`OnPluginExtension`](../type-aliases/OnPluginExtension.md)\<`MergedExtensions`\>; `setup?`: (`ctx`) => [`Awaitable`](../type-aliases/Awaitable.md)\<`void`\>; \} | [`plugin options`](../interfaces/PluginOptions.md) |
+| `options.dependencies?` | `Deps` | - |
+| `options.extension` | `PluginExt` | - |
+| `options.id` | `Id` | - |
+| `options.name?` | `string` | - |
+| `options.onExtension?` | [`OnPluginExtension`](../type-aliases/OnPluginExtension.md)\<`MergedExtensions`\> | - |
+| `options.setup?` | (`ctx`) => [`Awaitable`](../type-aliases/Awaitable.md)\<`void`\> | - |
+
+### Returns
+
+[`PluginWithExtension`](../interfaces/PluginWithExtension.md)\<`Awaited`\<`ReturnType`\<`PluginExt`\>\>\>
+
+A defined plugin with extension
+
+### Since
+
+v0.27.0
+
+## Call Signature
+
+```ts
+function plugin<Context, Id, Deps, Extension, ResolvedDepExtensions, PluginExt, MergedExtensions>(options): PluginWithoutExtension<{
+}>;
+```
+
+Define a plugin without extension and typed dependency extensions
+
+### Type Parameters
+
+| Type Parameter | Default type | Description |
+| ------ | ------ | ------ |
+| `Context` *extends* [`ExtendContext`](../type-aliases/ExtendContext.md) | `object` | A type extending [`ExtendContext`](../type-aliases/ExtendContext.md) to specify the shape of plugin dependency extensions. |
+| `Id` *extends* `string` | `string` | A string type to specify the plugin ID. |
+| `Deps` *extends* readonly (`string` \| [`PluginDependency`](../interfaces/PluginDependency.md))[] | \[\] | A readonly array of [`PluginDependency`](../interfaces/PluginDependency.md) or string to specify the plugin dependencies. |
+| `Extension` *extends* `Record`\<`string`, `unknown`\> | `object` | A type to specify the shape of the plugin extension object. |
+| `ResolvedDepExtensions` *extends* [`GunshiParams`](../interfaces/GunshiParams.md)\<\{ `args`: [`Args`](../interfaces/Args.md); `extensions`: \{ \}; \}\> | [`GunshiParams`](../interfaces/GunshiParams.md)\<\{ `args`: [`Args`](../interfaces/Args.md); `extensions`: `InferDependencyExtensions`\<`Deps`, `Context`\>; \}\> | - |
+| `PluginExt` *extends* [`PluginExtension`](../type-aliases/PluginExtension.md)\<`Extension`, [`DefaultGunshiParams`](../type-aliases/DefaultGunshiParams.md)\> | [`PluginExtension`](../type-aliases/PluginExtension.md)\<`Extension`, `ResolvedDepExtensions`\> | - |
+| `MergedExtensions` *extends* [`GunshiParams`](../interfaces/GunshiParams.md)\<\{ `args`: [`Args`](../interfaces/Args.md); `extensions`: \{ \}; \}\> | [`GunshiParams`](../interfaces/GunshiParams.md)\<\{ `args`: [`Args`](../interfaces/Args.md); `extensions`: `MergeExtension`\<`Id`, `InferDependencyExtensions`\<`Deps`, `Context`\>, `Awaited`\<`ReturnType`\<`PluginExt`\>\>\>; \}\> | - |
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options` | \{ `dependencies?`: `Deps`; `id`: `Id`; `name?`: `string`; `onExtension?`: [`OnPluginExtension`](../type-aliases/OnPluginExtension.md)\<`MergedExtensions`\>; `setup?`: (`ctx`) => [`Awaitable`](../type-aliases/Awaitable.md)\<`void`\>; \} | [`plugin options`](../interfaces/PluginOptions.md) without extension |
+| `options.dependencies?` | `Deps` | - |
+| `options.id` | `Id` | - |
+| `options.name?` | `string` | - |
+| `options.onExtension?` | [`OnPluginExtension`](../type-aliases/OnPluginExtension.md)\<`MergedExtensions`\> | - |
+| `options.setup?` | (`ctx`) => [`Awaitable`](../type-aliases/Awaitable.md)\<`void`\> | - |
+
+### Returns
+
+[`PluginWithoutExtension`](../interfaces/PluginWithoutExtension.md)\<\{
+\}\>
+
+A defined plugin without extension
+
+### Since
+
+v0.27.0

package/src/api/default/functions/resolveArgs.md

@@ -0,0 +1,85 @@
+[gunshi](../../index.md) / [default](../index.md) / resolveArgs
+
+# Function: resolveArgs()
+
+```ts
+function resolveArgs<A>(
+   args, 
+   tokens, 
+   resolveArgs?): object;
+```
+
+Resolve command line arguments.
+
+## Type Parameters
+
+| Type Parameter | Description |
+| ------ | ------ |
+| `A` *extends* [`Args`](../interfaces/Args.md) | [Arguments](../interfaces/Args.md), which is an object that defines the command line arguments. |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `A` | An arguments that contains [arguments schema](../interfaces/ArgSchema.md). |
+| `tokens` | [`ArgToken`](../interfaces/ArgToken.md)[] | An array of [tokens](../interfaces/ArgToken.md). |
+| `resolveArgs?` | `ResolveArgs` | An arguments that contains ResolveArgs \| resolve arguments. |
+
+## Returns
+
+`object`
+
+An object that contains the values of the arguments, positional arguments, rest arguments, AggregateError \| validation errors, and explicit provision status.
+
+### error
+
+```ts
+error: AggregateError | undefined;
+```
+
+### explicit
+
+```ts
+explicit: ArgExplicitlyProvided<A>;
+```
+
+### positionals
+
+```ts
+positionals: string[];
+```
+
+### rest
+
+```ts
+rest: string[];
+```
+
+### values
+
+```ts
+values: ArgValues<A>;
+```
+
+## Example
+
+```typescript
+// passed tokens: --port 3000
+
+const { values, explicit } = resolveArgs({
+  port: {
+    type: 'number',
+    default: 8080
+  },
+  host: {
+    type: 'string',
+    default: 'localhost'
+  }
+}, parsedTokens)
+
+values.port // 3000
+values.host // 'localhost'
+
+explicit.port // true (explicitly provided)
+explicit.host // false (not provided, fallback to default)
+```