配置 Vite

当以命令行方式运行 vite 时，Vite 会自动解析项目根目录下名为 vite.config.js 的配置文件（也支持其他 JS 和 TS 扩展名）。

最基础的配置文件是这样的：

vite.config.js

export default {
  // 配置选项
}

注意：要在配置文件中使用 ES 模块语法，该文件应能被 Node.js 识别为 ESM，例如使用 .mjs 扩展名，或使用 .js 扩展名且最近的 package.json 中包含 "type": "module"。

你可以显式地通过 --config 命令行选项指定一个配置文件（相对于 cwd 路径进行解析）。

bash

vite --config my-config.js

在 Scrimba 上观看互动课程

加载配置文件

默认情况下，Vite 使用 Rolldown 将配置文件打包到临时文件中并加载。如果你使用的环境支持 TypeScript（例如 Node.js 22.18 及以上版本），或者只编写纯 JavaScript，可以指定 --configLoader native，使用环境的原生运行时加载配置文件。计划在未来的主要版本中将 configLoader: 'native' 设为默认值。

配置智能提示

因为 Vite 本身附带 TypeScript 类型，所以你可以通过 IDE 和 jsdoc 的配合来实现智能提示：

/** @type {import('vite').UserConfig} */
export default {
  // ...
}

另外你可以使用 defineConfig 工具函数，这样不用 jsdoc 注解也可以获取类型提示：

import { defineConfig } from 'vite'

export default defineConfig({
  // ...
})

Vite 也直接支持 TypeScript 配置文件。你可以在 vite.config.ts 中使用上述的 defineConfig 工具函数，或者 satisfies 运算符：

import type { UserConfig } from 'vite'

export default {
  // ...
} satisfies UserConfig

条件配置

如果配置文件需要基于命令（serve 或 build）或者不同的模式来决定选项，亦或者是一个 SSR 构建（isSsrBuild）、一个正在预览的构建产物（isPreview），则可以选择导出这样一个函数：

export default defineConfig
(({ command
, mode
, isSsrBuild
, isPreview
 }) => {
  if (command
 === 'serve') {
    return {
      // dev 独有配置
    }
  } else {
    // command === 'build'
    return {
      // build 独有配置
    }
  }
})

需要注意的是，在 Vite 的 API 中，在开发环境下 command 的值为 serve（在 CLI 中，vite dev 和 vite serve 是 vite 的别名），而在生产环境下为 build（vite build）。

isSsrBuild 和 isPreview 是额外的可选标志，用于区分 build 和 serve 命令的类型。一些加载 Vite 配置的工具可能不支持这些标志，而会传递 undefined。因此，建议使用 true 和 false 的显式比较。

异步配置

如果配置需要调用一个异步函数，也可以转而导出一个异步函数。这个异步函数也可以通过 defineConfig 传递，以便获得更好的智能提示：

export default defineConfig
(async ({ command
, mode
 }) => {
  const data
 = await asyncFunction()
  return {
    // vite 配置
  }
})

在配置中使用环境变量

在评估配置文件本身时，可用的环境变量仅限于当前进程环境中已经存在的变量（process.env）。Vite 有意推迟加载任何 .env* 文件，直到用户配置解析完成之后，因为要加载的文件集合依赖于配置选项如 root 和 envDir，以及最终的 mode。

这意味着：在你的 vite.config.* 运行时，定义在 .env、.env.local、.env.[mode] 或 .env.[mode].local 中的变量不会自动注入到 process.env 中。它们会在稍后自动加载，并通过 import.meta.env 暴露给应用程序代码（使用默认的 VITE_ 前缀过滤器），正如环境变量和模式中所记录的那样。因此，如果你只需要将 .env* 文件中的值传递给应用程序，则无需在配置中调用任何内容。

但是，如果 .env* 文件中的值必须影响配置本身（例如设置 server.port、条件性启用插件或计算 define 替换），你可以使用导出的 loadEnv 辅助函数手动加载它们。

import { defineConfig
, loadEnv
 } from 'vite'

export default defineConfig
(({ mode
 }) => {
  // 根据当前工作目录中的 `mode` 加载 .env 文件
  // 设置第三个参数为 '' 来加载所有环境变量，而不管是否有
  // `VITE_` 前缀。
  const env
 = loadEnv
(mode
, process
.cwd
(), '')
  return {
    define
: {
      // 提供从 env var 派生的显式应用程序级常量。
      __APP_ENV__
: JSON
.stringify
(env
.APP_ENV
),
    },
    // 例如：使用 env var 有条件地设置开发服务器端口。
    server
: {
      port
: env
.APP_PORT
 ? Number
(env
.APP_PORT
) : 5173,
    },
  }
})

在 VS Code 中调试配置文件

为了获得最可靠的调试体验，请使用原生配置加载器启动 Vite：

bash

vite --configLoader native

原生加载器会直接执行原始配置文件，因此配置文件以及 transform 等插件钩子中的断点都能映射到原始源代码。运行时必须支持配置文件使用的语法，例如，TypeScript 配置文件需要 Node.js 22.18 及以上版本。

使用 --configLoader bundle 时（这是当前的默认值，不过计划在未来的主要版本中改用 native），Vite 会生成内联 source map，并在加载前将打包后的配置写入 node_modules/.vite-temp。如果必须使用打包加载器，请在 .vscode/settings.json 中为 JavaScript 调试终端添加该临时目录：

json

{
  "debug.javascript.terminalOptions": {
    "resolveSourceMapLocations": [
      "${workspaceFolder}/**",
      "!**/node_modules/**",
      "**/node_modules/.vite-temp/**"
    ]
  }
}

此设置仅适用于 JavaScript 调试终端，不会影响从“运行和调试”视图启动的配置。要支持“运行和调试”视图，请在 .vscode/launch.json 中添加该临时目录：

json

{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Vite",
      "runtimeExecutable": "npm",
      "runtimeArgs": ["exec", "vite", "--configLoader", "bundle"],
      "console": "integratedTerminal",
      "sourceMaps": true,
      "resolveSourceMapLocations": [
        "${workspaceFolder}/**",
        "!**/node_modules/**",
        "**/node_modules/.vite-temp/**"
      ]
    }
  ]
}

配置 Vite ​

配置智能提示 ​

条件配置 ​

异步配置 ​

在配置中使用环境变量 ​