@gunshi/docs 0.27.0 → 0.27.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@gunshi/docs",
   "description": "Documentation for gunshi",
-  "version": "0.27.0",
+  "version": "0.27.3",
   "author": {
     "name": "kazuya kawaguchi",
     "email": "kawakazu80@gmail.com"

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

@@ -22,6 +22,34 @@ A [CLI options](../interfaces/CliOptions.md)
 
 ## Call Signature
 
+```ts
+function cli(
+   args, 
+   entry, 
+options?): Promise<string | undefined>;
+```
+
+Run the command.
+
+This overload accepts any command-like object using a loose structural type.
+It bypasses TypeScript contravariance issues with callback properties.
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `args` | `string`[] | Command line arguments |
+| `entry` | [`SubCommandable`](../interfaces/SubCommandable.md) | A command-like object (command, command runner, or lazy command) |
+| `options?` | [`CliOptions`](../interfaces/CliOptions.md)\<[`DefaultGunshiParams`](../type-aliases/DefaultGunshiParams.md)\> | 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, 

package/src/api/default/index.md

@@ -61,6 +61,7 @@ import { cli } from 'gunshi'
 | [PluginWithExtension](interfaces/PluginWithExtension.md) | Plugin return type with extension, which includes the plugin ID, name, dependencies, and extension. |
 | [PluginWithoutExtension](interfaces/PluginWithoutExtension.md) | Plugin return type without extension, which includes the plugin ID, name, and dependencies, but no extension. |
 | [RenderingOptions](interfaces/RenderingOptions.md) | Rendering control options |
+| [SubCommandable](interfaces/SubCommandable.md) | Sub-command entry type for use in subCommands. |
 
 ## References
 

package/src/api/default/interfaces/CliOptions.md

@@ -27,7 +27,7 @@ CLI options of [`cli`](../functions/cli.md) function.
 | <a id="renderheader"></a> `renderHeader?` | (`ctx`) => `Promise`\<`string`\> \| `null` | Render function the header section in the command usage. |
 | <a id="renderusage"></a> `renderUsage?` | (`ctx`) => `Promise`\<`string`\> \| `null` | Render function the command usage. |
 | <a id="rendervalidationerrors"></a> `renderValidationErrors?` | (`ctx`, `error`) => `Promise`\<`string`\> \| `null` | Render function the validation errors. |
-| <a id="subcommands"></a> `subCommands?` | \| `Map`\<`string`, \| [`Command`](Command.md)\<`any`\> \| [`LazyCommand`](../type-aliases/LazyCommand.md)\<`any`, \{ \}\>\> \| `Record`\<`string`, \| [`Command`](Command.md)\<`any`\> \| [`LazyCommand`](../type-aliases/LazyCommand.md)\<`any`, \{ \}\>\> | Sub commands. |
+| <a id="subcommands"></a> `subCommands?` | \| `Record`\<`string`, [`SubCommandable`](SubCommandable.md)\> \| `Map`\<`string`, [`SubCommandable`](SubCommandable.md)\> | Sub commands. |
 | <a id="usageoptiontype"></a> `usageOptionType?` | `boolean` | Whether to display the usage optional argument type. |
 | <a id="usageoptionvalue"></a> `usageOptionValue?` | `boolean` | Whether to display the optional argument value. |
 | <a id="usagesilent"></a> `usageSilent?` | `boolean` | Whether to display the command usage. |

package/src/api/default/interfaces/SubCommandable.md

@@ -0,0 +1,35 @@
+[gunshi](../../index.md) / [default](../index.md) / SubCommandable
+
+# Interface: SubCommandable
+
+Sub-command entry type for use in subCommands.
+
+This type uses a loose structural match to bypass TypeScript's contravariance issues
+with function parameters, allowing any Command or LazyCommand to be used as a sub-command.
+
+## Since
+
+v0.27.1
+
+## Indexable
+
+```ts
+[key: string]: any
+```
+
+Index signature to allow additional properties
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| <a id="args"></a> `args?` | [`Args`](Args.md) \| `Record`\<`string`, `any`\> | Command arguments - accepts any args structure |
+| <a id="commandname"></a> `commandName?` | `string` | Command name for lazy commands |
+| <a id="description"></a> `description?` | `string` | Command description |
+| <a id="entry"></a> `entry?` | `boolean` | Whether this is an entry command |
+| <a id="examples"></a> `examples?` | `string` \| (...`args`) => `any` | Command examples |
+| <a id="internal"></a> `internal?` | `boolean` | Whether this is an internal command |
+| <a id="name"></a> `name?` | `string` | Command name |
+| <a id="rendering"></a> `rendering?` | `any` | Rendering options |
+| <a id="run"></a> `run?` | (...`args`) => `any` | Command runner |
+| <a id="tokebab"></a> `toKebab?` | `boolean` | Whether to convert camelCase to kebab-case |

package/src/guide/essentials/plugin-system.md

@@ -144,10 +144,9 @@ const resources = {
 const command = defineI18n({
   name: 'greet',
   description: 'Greet someone in their language',
-  // Resource function returns translations for the current locale
-  resource: async ctx => {
-    const locale = ctx.extensions['g:i18n'].locale
-    return resources[locale] || resources['en-US']
+  // Resource function receives locale and returns translations
+  resource: locale => {
+    return resources[locale.toString()] || resources['en-US']
   },
   args: {
     name: {
@@ -333,9 +332,8 @@ const resources = {
 const buildCommand = defineI18n({
   name: 'build',
   description: 'Build the project',
-  resource: async ctx => {
-    const locale = ctx.extensions['g:i18n'].locale
-    return resources[locale] || resources['en-US']
+  resource: locale => {
+    return resources[locale.toString()] || resources['en-US']
   },
   args: {
     mode: {

package/src/release/v0.27.md

@@ -704,7 +704,7 @@ The i18n plugin comes with additional packages and helper functions to simplify
   // Define new command with i18n support
   const command = defineI18n({
     name: 'deploy',
-    resource: async ctx => ({
+    resource: locale => ({
       /* translations */
     }),
     run: ctx => {
@@ -714,7 +714,7 @@ The i18n plugin comes with additional packages and helper functions to simplify
 
   // Add i18n to existing command
   const enhancedCommand = withI18nResource(existingCommand, {
-    resource: async ctx => ({
+    resource: locale => ({
       /* translations */
     })
   })
@@ -759,14 +759,14 @@ New playground examples demonstrating:
 We'd like to thank all the contributors who made this release possible:
 
 - [@kazupon](https://github.com/kazupon) - Core maintainer, plugin system architect, i18n extraction, lifecycle hooks
-- [@yukukotani](https://github.com/yukukotani) - Fallback to entry command feature (#291)
-- [@sushichan044](https://github.com/sushichan044) - Explicit argument detection feature (#232)
-- [@43081j](https://github.com/43081j) - Exposed `Plugin` type (#159)
-- [@theoephraim](https://github.com/theoephraim) - Documentation improvements (#249)
-- [@lukekarrys](https://github.com/lukekarrys) - Documentation updates (#228)
-- [@BobbieGoede](https://github.com/BobbieGoede) - Fixed FUNDING.yml (#303)
-- [@ryoppippi](https://github.com/ryoppippi) - Docs init CLI feature (#422)
-- [@ota-meshi](https://github.com/ota-meshi) - Multiple positional argument usage display improvement (#432)
+- [@yukukotani](https://github.com/yukukotani) - Fallback to entry command feature ([#291](https://github.com/kazupon/gunshi/pull/291))
+- [@sushichan044](https://github.com/sushichan044) - Explicit argument detection feature ([#232](https://github.com/kazupon/gunshi/pull/232))
+- [@43081j](https://github.com/43081j) - Exposed `Plugin` type ([#159](https://github.com/kazupon/gunshi/pull/159))
+- [@theoephraim](https://github.com/theoephraim) - Documentation improvements ([#249](https://github.com/kazupon/gunshi/pull/249))
+- [@lukekarrys](https://github.com/lukekarrys) - Documentation updates ([#228](https://github.com/kazupon/gunshi/pull/228))
+- [@BobbieGoede](https://github.com/BobbieGoede) - Fixed FUNDING.yml ([#303](https://github.com/kazupon/gunshi/pull/303))
+- [@ryoppippi](https://github.com/ryoppippi) - Docs init CLI feature ([#422](https://github.com/kazupon/gunshi/pull/422))
+- [@ota-meshi](https://github.com/ota-meshi) - Multiple positional argument usage display improvement ([#432](https://github.com/kazupon/gunshi/pull/432))
 
 Special thanks to the community for feedback and bug reports that helped shape v0.27!