Interface UserWorkspaceConfig

interface UserWorkspaceConfig {
    appType?: AppType;
    assetsInclude?: string | RegExp | (string | RegExp)[];
    base?: string;
    build?: BuildOptions;
    cacheDir?: string;
    clearScreen?: boolean;
    css?: CSSOptions;
    customLogger?: Logger;
    define?: Record<string, any>;
    envDir?: string;
    envPrefix?: string | string[];
    esbuild?: false | ESBuildOptions;
    experimental?: ExperimentalOptions;
    json?: JsonOptions;
    legacy?: LegacyOptions;
    logLevel?: LogLevel;
    mode?: string;
    optimizeDeps?: DepOptimizationOptions;
    plugins?: PluginOption[];
    preview?: PreviewOptions;
    publicDir?: string | false;
    resolve?: ResolveOptions & {
        alias?: AliasOptions;
    };
    root?: string;
    server?: ServerOptions;
    ssr?: SSROptions;
    test?: ProjectConfig;
    worker?: {
        format?: "iife" | "es";
        plugins?: (() => PluginOption[]);
        rollupOptions?: Omit<RollupOptions, "input" | "plugins" | "onwarn" | "preserveEntrySignatures">;
    };
}

Hierarchy

  • UserConfig
    • UserWorkspaceConfig

Properties

appType? assetsInclude? base? build? cacheDir? clearScreen? css? customLogger? define? envDir? envPrefix? esbuild? experimental? json? legacy? logLevel? mode? optimizeDeps? plugins? preview? publicDir? resolve? root? server? ssr? test? worker?

Properties

Optional appType

appType?: AppType

Whether your application is a Single Page Application (SPA), a Multi-Page Application (MPA), or Custom Application (SSR and frameworks with custom HTML handling)

Default

'spa'

Optional assetsInclude

assetsInclude?: string | RegExp | (string | RegExp)[]

Specify additional picomatch patterns to be treated as static assets.

Optional base

base?: string

Base public path when served in development or production.

Default

'/'

Optional build

build?: BuildOptions

Build specific options

Optional cacheDir

cacheDir?: string

Directory to save cache files. Files in this directory are pre-bundled deps or some other cache files that generated by vite, which can improve the performance. You can use --force flag or manually delete the directory to regenerate the cache files. The value can be either an absolute file system path or a path relative to project root. Default to .vite when no package.json is detected.

Default

'node_modules/.vite'

Optional clearScreen

clearScreen?: boolean

Default

true

Optional css

css?: CSSOptions

CSS related options (preprocessors and CSS modules)

Optional customLogger

customLogger?: Logger

Custom logger.

Optional define

define?: Record<string, any>

Define global variable replacements. Entries will be defined on window during dev and replaced during build.

Optional envDir

envDir?: string

Environment files directory. Can be an absolute path, or a path relative from root.

Default

root

Optional envPrefix

envPrefix?: string | string[]

Env variables starts with envPrefix will be exposed to your client source code via import.meta.env.

Default

'VITE_'

Optional esbuild

esbuild?: false | ESBuildOptions

Transform options to pass to esbuild. Or set to false to disable esbuild.

Optional Experimental experimental

experimental?: ExperimentalOptions

Experimental features

Features under this field could change in the future and might NOT follow semver. Please be careful and always pin Vite's version when using them.

Optional json

json?: JsonOptions

JSON loading options

Optional legacy

legacy?: LegacyOptions

Legacy options

Features under this field only follow semver for patches, they could be removed in a future minor version. Please always pin Vite's version to a minor when using them.

Optional logLevel

logLevel?: LogLevel

Log level.

Default

'info'

Optional mode

mode?: string

Explicitly set a mode to run in. This will override the default mode for each command, and can be overridden by the command line --mode option.

Optional optimizeDeps

optimizeDeps?: DepOptimizationOptions

Dep optimization options

Optional plugins

plugins?: PluginOption[]

Array of vite plugins to use.

Optional preview

preview?: PreviewOptions

Preview specific options, e.g. host, port, https...

Optional publicDir

publicDir?: string | false

Directory to serve as plain static assets. Files in this directory are served and copied to build dist dir as-is without transform. The value can be either an absolute file system path or a path relative to project root.

Set to false or an empty string to disable copied static assets to build dist dir.

Default

'public'

Optional resolve

resolve?: ResolveOptions & {
    alias?: AliasOptions;
}

Configure resolver

Type declaration

  • Optional alias?: AliasOptions

Optional root

root?: string

Project root directory. Can be an absolute path, or a path relative from the location of the config file itself.

Default

process.cwd()

Optional server

server?: ServerOptions

Server specific options, e.g. host, port, https...

Optional ssr

ssr?: SSROptions

SSR specific options

Optional test

test?: ProjectConfig

Optional worker

worker?: {
    format?: "iife" | "es";
    plugins?: (() => PluginOption[]);
    rollupOptions?: Omit<RollupOptions, "input" | "plugins" | "onwarn" | "preserveEntrySignatures">;
}

Worker bundle options

Type declaration

  • Optional format?: "iife" | "es"

    Output format for worker bundle

    Default

    'iife'
  • Optional plugins?: (() => PluginOption[])

    Vite plugins that apply to worker bundle. The plugins returned by this function should be new instances every time it is called, because they are used for each rollup worker bundling process.

      • (): PluginOption[]

      • Vite plugins that apply to worker bundle. The plugins returned by this function should be new instances every time it is called, because they are used for each rollup worker bundling process.

        Returns PluginOption[]

  • Optional rollupOptions?: Omit<RollupOptions, "input" | "plugins" | "onwarn" | "preserveEntrySignatures">

    Rollup options to build worker bundle

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc