Skip to content

gunshi / default

default

The main entry point for Gunshi.

Example

js
import { cli } from 'gunshi'

Variables

VariableDescription
DEFAULT_LOCALEThe default locale string, which format is BCP 47 language tag.

Functions

FunctionDescription
cliRun the command.
parseArgsParse command line arguments.
pluginCreate a plugin with extension capabilities
resolveArgsResolve command line arguments.

Classes

ClassDescription
DefaultTranslationTranslation adapter. This adapter is used to custom message formatter like Intlify message format, `Intl.MessageFormat` (MF2), and etc. This adapter will support localization with your preferred message format.

Interfaces

InterfaceDescription
ArgsAn object that contains argument schema.
ArgSchemaAn argument schema This schema is similar to the schema of the node:utils. difference is that: - required property and description property are added - type is not only 'string' and 'boolean', but also 'number', 'enum', 'positional', 'custom' too. - default property type, not support multiple types
CliOptionsCLI options of cli function.
CommandCommand interface.
CommandContextCommand context. Command context is the context of the command execution.
CommandContextExtensionCommand context extension
CommandEnvironmentCommand environment.
GunshiParamsGunshi unified parameter type. This type combines both argument definitions and command context extensions.
PluginOptionsPlugin definition options
TranslationAdapterTranslation adapter. This adapter is used to custom message formatter like Intlify message format, `Intl.MessageFormat` (MF2), and etc. This adapter will support localization with your preferred message format.
TranslationAdapterFactoryOptionsTranslation adapter factory options.

References

define

Re-exports define


lazy

Re-exports lazy

Type Aliases

Type AliasDescription
ArgValuesAn object that contains the values of the arguments.
Awaitable-
CommandableDefine a command type.
CommandCallModeCommand call mode.
CommandContextCoreCommandContextCore type (base type without extensions)
CommandDecoratorCommand decorator. A function that wraps a command runner to add or modify its behavior.
CommandExamplesFetcherCommand examples fetcher.
CommandLoaderCommand loader. A function that returns a command or command runner. This is used to lazily load commands.
CommandResourceCommand resource.
CommandResourceFetcherCommand resource fetcher.
CommandRunnerCommand runner.
DefaultGunshiParamsDefault Gunshi parameters
ExtendContextExtend command context type. This type is used to extend the command context with additional properties at CommandContext.extensions.
LazyCommandLazy command interface. Lazy command that's not loaded until it is executed.
PluginGunshi plugin, which is a function that receives a PluginContext.
PluginExtensionPlugin extension for CommandContext
RendererDecoratorRenderer decorator type. A function that wraps a base renderer to add or modify its behavior.
TranslationAdapterFactoryTranslation adapter factory.
ValidationErrorsDecoratorValidation errors renderer decorator type. A function that wraps a validation errors renderer to add or modify its behavior.

Released under the MIT License.