VitePress

Appearance

@snailicide/build-config / vite / ViteUserConfig

ViteUserConfig ​

Defined in: node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3130

Extends ​

  • DefaultEnvironmentOptions

Properties ​

PropertyTypeDescriptionOverridesInherited fromDefined in
define?Record<string, any>Define global variable replacements. Entries will be defined on window during dev and replaced during build.-DefaultEnvironmentOptions.definenode_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3086
dev?DevEnvironmentOptionsDev specific options-DefaultEnvironmentOptions.devnode_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3110
build?BuildEnvironmentOptionsBuild specific options-DefaultEnvironmentOptions.buildnode_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3114
resolve?AllResolveOptions--DefaultEnvironmentOptions.resolvenode_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3128
root?stringProject root directory. Can be an absolute path, or a path relative from the location of the config file itself. Default process.cwd()--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3136
base?stringBase public path when served in development or production. Default '/'--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3141
publicDir?string | falseDirectory 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'--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3150
cacheDir?stringDirectory 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'--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3160
mode?stringExplicitly 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.--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3165
plugins?PluginOption[]Array of vite plugins to use.--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3169
html?HTMLOptionsHTML related options--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3173
css?CSSOptionsCSS related options (preprocessors and CSS modules)--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3177
json?JsonOptionsJSON loading options--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3181
esbuild?false | ESBuildOptionsTransform options to pass to esbuild. Or set to false to disable esbuild.--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3186
assetsInclude?string | RegExp | (string | RegExp)[]Specify additional picomatch patterns to be treated as static assets.--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3190
builder?BuilderOptionsExperimental Builder specific options--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3195
server?ServerOptions$1Server specific options, e.g. host, port, https...--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3199
preview?PreviewOptionsPreview specific options, e.g. host, port, https...--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3203
experimental?ExperimentalOptionsExperimental 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.--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3211
future?FutureOptionsOptions to opt-in to future behavior--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3215
legacy?LegacyOptionsLegacy 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.--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3222
logLevel?LogLevelLog level. Default 'info'--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3227
customLogger?LoggerCustom logger.--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3231
clearScreen?booleanDefault true--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3235
envDir?string | falseEnvironment files directory. Can be an absolute path, or a path relative from root. Default root--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3241
envPrefix?string | string[]Env variables starts with envPrefix will be exposed to your client source code via import.meta.env. Default 'VITE_'--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3246
worker?{ format?: "es" | "iife"; plugins?: () => PluginOption[]; rollupOptions?: Omit<RollupOptions, "plugins" | "input" | "onwarn" | "preserveEntrySignatures">; }Worker bundle options--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3250
worker.format?"es" | "iife"Output format for worker bundle Default 'iife'--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3255
worker.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.--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3261
worker.rollupOptions?Omit<RollupOptions, "plugins" | "input" | "onwarn" | "preserveEntrySignatures">Rollup options to build worker bundle--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3265
optimizeDeps?DepOptimizationOptionsDep optimization optionsDefaultEnvironmentOptions.optimizeDeps-node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3270
ssr?SSROptionsSSR specific options We could make SSROptions be a EnvironmentOptions if we can abstract external/noExternal for environments in general.--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3276
environments?Record<string, EnvironmentOptions>Environment overrides--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3280
appType?AppTypeWhether 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'--node_modules/.pnpm/vite@7.0.6_@types+node@24.1.0_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vite/dist/node/index.d.ts:3287
test?InlineConfigOptions for Vitest--node_modules/.pnpm/vitest@3.2.4_@types+debug@4.1.12_@types+node@24.1.0_@vitest+ui@3.2.4_jiti@2.5.1_terser@5.43.1_yaml@2.8.0/node_modules/vitest/dist/chunks/vite.d.CMLlLIFP.d.ts:18