Skip to content

gunshi / plugin

plugin ​

The entry point for Gunshi plugin module.

Example ​

js
import { plugin } from 'gunshi/plugin'

export default yourPlugin() {
  return plugin({
    id: 'your-plugin-id',
    setup: (ctx) => {
      // your plugin setup logic here
    },
  })
}

Variables ​

VariableDescription
CLI_OPTIONS_DEFAULT-

References ​

ANONYMOUS_COMMAND_NAME ​

Re-exports ANONYMOUS_COMMAND_NAME


Args ​

Re-exports Args


ArgSchema ​

Re-exports ArgSchema


ArgToken ​

Re-exports ArgToken


ArgValues ​

Re-exports ArgValues


Awaitable ​

Re-exports Awaitable


Command ​

Re-exports Command


CommandContext ​

Re-exports CommandContext


CommandContextCore ​

Re-exports CommandContextCore


CommandContextExtension ​

Re-exports CommandContextExtension


CommandContextParams ​

Re-exports CommandContextParams


CommandDecorator ​

Re-exports CommandDecorator


CommandExamplesFetcher ​

Re-exports CommandExamplesFetcher


CommandRunner ​

Re-exports CommandRunner


createCommandContext ​

Re-exports createCommandContext


DefaultGunshiParams ​

Re-exports DefaultGunshiParams


ExtendContext ​

Re-exports ExtendContext


GunshiParams ​

Re-exports GunshiParams


GunshiParamsConstraint ​

Re-exports GunshiParamsConstraint


LazyCommand ​

Re-exports LazyCommand


OnPluginExtension ​

Re-exports OnPluginExtension


plugin ​

Re-exports plugin


Plugin ​

Re-exports Plugin


PluginContext ​

Re-exports PluginContext


PluginDependency ​

Re-exports PluginDependency


PluginExtension ​

Re-exports PluginExtension


PluginFunction ​

Re-exports PluginFunction


PluginOptions ​

Re-exports PluginOptions


PluginWithExtension ​

Re-exports PluginWithExtension


PluginWithoutExtension ​

Re-exports PluginWithoutExtension


Prettify ​

Re-exports Prettify


RendererDecorator ​

Re-exports RendererDecorator


ValidationErrorsDecorator ​

Re-exports ValidationErrorsDecorator

Released under the MIT License.