CommandKitConfig

CommandKitConfig

commandkittypes.ts

Signature

interface CommandKitConfig {
    plugins?: MaybeArray<CommandKitPlugin>[] | Array<CommandKitPlugin>;
    rolldownPlugins?: any[];
    compilerOptions?: {
    /**
     * Macro compiler configuration.
     */
    macro?: {
      /**
       * Whether to enable macro function compilation in development mode.
       * @default false
       */
      development?: boolean;
    };
  };
    typescript?: {
    /**
     * Whether to ignore type checking during builds.
     */
    ignoreBuildErrors?: boolean;
  };
    static?: boolean;
    env?: Record<string, string>;
    distDir?: string;
    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;
}

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.

compilerOptions

property

{ /** * Macro compiler configuration. */ macro?: { /** * Whether to enable macro function compilation in development mode. * @default false */ development?: boolean; }; }

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.

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.