配置 Vite

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

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

vite.config.js

export default {
  // 配置选项
}

注意，即使项目没有使用原生 Node ESM（例如 package.json 中的 "type": "module"），Vite 也支持在配置文件中使用 ES 模块语法。在这种情况下，配置文件在加载前会自动进行预处理。

你也可以通过 --config CLI 选项显式指定要使用的配置文件（相对于 cwd 解析）：

bash

vite --config my-config.js

在 Scrimba 上观看互动课程

配置加载

默认情况下，Vite 使用 Rolldown 将配置打包到一个临时文件中并加载它。这在单体仓库（monorepo）中导入 TypeScript 文件时可能会导致问题。如果你遇到此方法的问题，可以指定 --configLoader runner 来使用模块运行器，它不会创建临时配置，而是即时转换任何文件。注意，模块运行器不支持配置文件中的 CJS，但外部 CJS 包应该照常工作。

或者，如果你使用的环境支持 TypeScript（例如 node --experimental-strip-types），或者你只编写纯 JavaScript，你可以指定 --configLoader native 使用环境的原生运行时来加载配置文件。注意，配置文件导入的模块的更新不会被检测到，因此不会自动重启 Vite 服务器。

配置智能提示

由于 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 {
      // 开发环境特定配置
    }
  } else {
    // 命令 === 'build'
    return {
      // 构建特定配置
    }
  }
})

重要的是要注意，在 Vite 的 API 中，开发期间 command 值为 serve（在 cli 中 vite、vite dev 和 vite serve 是别名），而为生产构建时值为 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。

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

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

import { defineConfig
, loadEnv
 } from 'vite'

export default defineConfig
(({ mode
 }) => {
  // 基于当前工作目录中的 `mode` 加载 env 文件。
  // 将第三个参数设置为 '' 以加载所有 env，无论
  // `VITE_` 前缀如何。
  const env
 = loadEnv
(mode
, process
.cwd
(), '')
  return {
    define
: {
      // 提供一个源自环境变量的显式应用级常量。
      __APP_ENV__
: JSON
.stringify
(env
.APP_ENV
),
    },
    // 示例：使用环境变量有条件地设置开发服务器端口。
    server
: {
      port
: env
.APP_PORT
 ? Number
(env
.APP_PORT
) : 5173,
    },
  }
})

在 VS Code 上调试配置文件

使用默认的 --configLoader bundle 行为时，Vite 会将生成的临时配置文件写入 node_modules/.vite-temp 文件夹，并且在设置断点调试 Vite 配置文件时会发生文件未找到错误。要解决此问题，请将以下配置添加到 .vscode/settings.json：

json

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

配置 Vite ​

配置智能提示 ​

条件配置 ​

异步配置 ​

在配置中使用环境变量 ​