Skip to main content
Version: Next

CommandKitConfig

CommandKitConfig​

commandkittypes.ts
Signature
interface CommandKitConfig {
    plugins?: MaybeArray<CommandKitPlugin>[] | Array<CommandKitPlugin>;
    rolldownPlugins?: any[];
    entrypoints?: string[];
    compilerOptions?: CommandKitCompilerOptions;
    typescript?: {
    /**
     * Whether to ignore type checking during builds.
     */
    ignoreBuildErrors?: boolean;
  };
    static?: boolean;
    env?: Record<string, string>;
    distDir?: string;
    antiCrashScript?: {
    /**
     * Whether to enable the anti-crash script in development mode.
     * @default true
     */
    development?: boolean;
    /**
     * Whether to enable the anti-crash script in production mode. Usually, you should use other means to handle errors.
     * @default false
     */
    production?: boolean;
  };
    sourceMap?: {
    /**
     * Whether to enable source map generation in development mode.
     */
    development?: boolean;
    /**
     * Whether to enable source map generation in production mode.
     */
    production?: boolean;
  };
    typedCommands?: boolean;
    disablePrefixCommands?: boolean;
    showUnknownPrefixCommandsWarning?: boolean;
}

plugins​

property
MaybeArray<CommandKitPlugin>[] | Array<CommandKitPlugin>

The plugins to use with CommandKit. Can be a single plugin, an array of plugins, or a nested array of plugins.

rolldownPlugins​

property
any[]

The rolldown plugins to use with CommandKit.

entrypoints​

property
string[]

The list of additional entrypoints to compile. Eg, dir or dir/index.ts or dir/*.ts, etc. Similarly, negative patterns can be used to exclude files. Eg, !dir/index.ts or !dir/*.ts, etc.

compilerOptions​

property
CommandKitCompilerOptions

The compiler options to use with CommandKit.

typescript​

property
{ /** * Whether to ignore type checking during builds. */ ignoreBuildErrors?: boolean; }

The typescript configuration to use with CommandKit.

static​

property
boolean

Whether to generate static command handler data in production builds.

env​

property
Record<string, string>

Statically define the environment variables to use.

distDir​

property
string
default:
`dist`

The custom build directory name to use.

antiCrashScript​

property
{ /** * Whether to enable the anti-crash script in development mode. * @default true */ development?: boolean; /** * Whether to enable the anti-crash script in production mode. Usually, you should use other means to handle errors. * @default false */ production?: boolean; }

The anti-crash script configuration.

sourceMap​

property
{ /** * Whether to enable source map generation in development mode. */ development?: boolean; /** * Whether to enable source map generation in production mode. */ production?: boolean; }

Whether or not to enable the source map generation.

typedCommands​

property
boolean
default:
true

Whether or not to enable the typed commands.

disablePrefixCommands​

property
boolean
default:
false

Whether or not to disable the prefix commands.

showUnknownPrefixCommandsWarning​

property
boolean
default:
true

Whether or not to show a warning when a prefix command is not found. This only affects development mode.