gunshi / default
default
The main entry point for Gunshi.
Example
js
import { cli } from 'gunshi'Variables
| Variable | Description |
|---|---|
| DEFAULT_LOCALE | The default locale string, which format is BCP 47 language tag. |
Functions
| Function | Description |
|---|---|
| cli | Run the command. |
| parseArgs | Parse command line arguments. |
| resolveArgs | Resolve command line arguments. |
Classes
| Class | Description |
|---|---|
| DefaultTranslation | Translation 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
| Interface | Description |
|---|---|
| Args | An object that contains argument schema. |
| ArgSchema | An 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 |
| CliOptions | CLI options of cli function. |
| Command | Command interface. |
| CommandContext | Command context. Command context is the context of the command execution. |
| CommandEnvironment | Command environment. |
| TranslationAdapter | Translation 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. |
| TranslationAdapterFactoryOptions | Translation adapter factory options. |
References
define
Re-exports define
lazy
Re-exports lazy
Type Aliases
| Type Alias | Description |
|---|---|
| ArgValues | An object that contains the values of the arguments. |
| Commandable | Define a command type. |
| CommandCallMode | Command call mode. |
| CommandExamplesFetcher | Command examples fetcher. |
| CommandLoader | - |
| CommandResource | Command resource. |
| CommandResourceFetcher | Command resource fetcher. |
| CommandRunner | Command runner. |
| LazyCommand | Lazy command interface. Lazy command that's not loaded until it is executed. |
| TranslationAdapterFactory | Translation adapter factory. |