前端工程化 / 系统课时

编写类型安全配置

编写类型安全配置

本课解决 vite.config.ts 容易写错字段、缺少提示和条件配置难维护的问题。完成后,你会得到一份可直接用于 Vite 项目的类型安全配置,并能用构建命令验证它是否真正生效。

学习目标

  • 使用 defineConfig 获得配置函数的参数与返回值提示
  • 使用 satisfies UserConfig 校验配置对象而不丢失类型推断
  • 通过实际构建验证别名、基础路径和源码映射配置

类型安全解决什么问题

Vite 自带 TypeScript 类型。defineConfig 适合包裹静态对象、同步函数或异步函数,编辑器能据此推断 mode、command 等上下文参数;satisfies UserConfig 则适合校验可复用的局部配置对象,同时保留对象自身的精确类型。:contentReference[oaicite:0]{index=0}

类型提示主要在编写阶段阻止字段拼写错误。例如把 strictPort 写成 strictPorts 时,编辑器或 TypeScript 检查会直接指出该属性不属于 ServerOptions。相比之下,直接使用类型断言会弱化检查,因此不应把 as UserConfig 当作修复类型错误的手段。

编写完整配置

下面的 vite.config.ts 同时演示共享配置校验和按模式返回配置。示例假设项目由标准 Vite 模板创建,且存在 src 与 index.html。

ts
import { fileURLToPath, URL } from 'node:url'
import { defineConfig, type UserConfig } from 'vite'

const sharedConfig = {
  resolve: {
    alias: {
      '@': fileURLToPath(new URL('./src', import.meta.url)),
    },
  },
  server: {
    port: 5173,
    strictPort: true,
  },
} satisfies UserConfig

export default defineConfig(({ mode }) => ({
  ...sharedConfig,
  base: mode === 'production' ? '/console/' : '/',
  build: {
    // 非生产模式保留源码映射,便于定位打包后的错误。
    sourcemap: mode !== 'production',
  },
}))

sharedConfig 在声明处完成字段校验;导出的配置函数再根据 mode 决定部署基础路径和源码映射。这里使用 new URL('./src', import.meta.url),避免别名依赖当前工作目录。

运行并验证

在项目根目录执行生产构建:

bash
npx vite build --mode production

预期输出

text
vite v<VERSION> building for production...
✓ <N> modules transformed.
dist/index.html                  <SIZE>
dist/assets/<ID>.js              <SIZE>
✓ built in <TIME>

版本、模块数、文件名、体积和耗时会随项目变化。构建成功后,打开 dist/index.html 或检查生成资源引用,可以看到路径以 /console/ 开头;生产模式下不会生成 .map 文件。若构建仍成功但路径不符合预期,应先确认命令中的 --mode production 是否与配置判断一致。

选择 defineConfig 还是 satisfies

只导出一个简单配置时,直接使用 defineConfig({...}) 最短。需要把服务器、构建或插件选项拆成多个常量时,先让每个局部对象 satisfies UserConfig 或对应子类型,再由 defineConfig 组合,更容易在错误发生的位置得到精确提示。

不要重复写成 const config: UserConfig = {...} satisfies UserConfig。前者已经把变量类型扩大为 UserConfig,会丢失部分字面量信息;通常保留 satisfies 即可。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

编写类型安全配置

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通