export showHelp/showVersion function in ctx

[ryoppippi]

Clear and concise description of the problem

Sometimes I'd like to show help with not implemented subcommand.

Suggested solution

like cleye, export showHelp / showVersion function from command context

https://github.com/privatenumber/cleye#clioptions-callback-argvs

https://github.com/unjs/citty#renderusage

Alternative

No response

Additional context

No response

Validations

• Read the Contributing Guide.
• Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

[43081j]

it seems you can already do this:

import {renderUsage} from 'gunshi/renderer';

// ...
const command = define({
  args: {},
  async run(ctx) {
    const usage = await renderUsage(ctx);
    console.log(usage);
  }
});

[theoephraim]

I just tried this - it renders the help info for that command. Often we want to implement a mycli help subcommand which shows the help info for the main command.

related - #69

[kazupon]

v0.27 beta has introduces a plugin system.
Please refer to the documentation for details.

• about plugin-system: https://gunshi.dev/guide/essentials/plugin-system

gunshi plugins can extend the CommandContext (ctx). By exporting a plugin as an extension in extensions, it can be used via ctx.extensions.

• about context extensions: https://gunshi.dev/guide/advanced/context-extensions

gunshi v0.27 includes @gunshi/plugin-global and @gunshi/plugin-renderer by default.
We can use @gunshi/plugin-renderer extensions, such as renderUsage

https://github.com/kazupon/gunshi/tree/main/packages/plugin-renderer#exported-functions