vite.config.ts

当以命令行方式运行 vite 时,Vite 会自动解析 项目根目录下名为 vite.config.js(或 vite.config.ts) 的文件。

一、使用 vite 创建的项目里默认的配置

使用 vite 创建项目完成后会自动生成 一个 vite.config.js 文件,当然你可以将其名重定义为 vite.config.ts 文件。其默认代码如下:

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

export default defineConfig({
 plugins: [vue()],
})

二、vite 区分不同环境的配置

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

如果配置需要调用一个异步函数,也可以转而导出一个异步函数:

export default defineConfig(async ({ command, mode }) => {
  const data = await asyncFunction()
  return {
    // 构建模式所需的特有配置
  }
})

三、vite 基本配置汇总

1. 配置本地服务(开发服务器选项)

本地运行时的服务设置,包括:

  • host:string | boolean,服务器 IP 地址。
  • port:number,服务器端口号。
  • strictPort:boolean,设为 true 时若端口已被占用则会直接退出,而不是尝试下一个可用端口。
  • https:boolean | https.ServerOptions,是否启用 https。
  • open:boolean | string,设置服务器启动时自动在浏览器中打开的应用程序。
  • proxy:Record<string, string | ProxyOptions>,为开发服务器配置自定义代理规则。
  • cors:boolean | CorsOptions,为开发服务器配置 CORS。默认启用并允许任何源。
  • headers:OutgoingHttpHeaders,指定服务器响应的 header。
  • force:boolean,设置为 true 强制使依赖预构建。
  • hmr:boolean | { protocol?: string, host?: string, port?: number, path?: string, timeout?: number, overlay?: - - boolean, clientPort?: number, server?: Server },禁用或配置 HMR 连接。
  • watch:object,传递给 chokidar 的文件系统监听器选项。
  • middlewareMode:‘ssr’ | ‘html’,以中间件模式创建 Vite 服务器。(不含 HTTP 服务器)
  • base:string | undefined,在 HTTP 请求中预留此文件夹,用于代理 Vite 作为子文件夹时使用。应该以 / 字符开始和结束。
  • fs
    strict:boolean,限制为工作区 root 路径以外的文件的访问。
    allow:string[],限制哪些文件可以通过 /@fs/ 路径提供服务。
    deny:string[],用于限制 Vite 开发服务器提供敏感文件的黑名单。
    origin:string,用于定义开发调试阶段生成资产的 origin。

例如:

export default defineConfig({
  server: {
    host: '0.0.0.0',
    port: '3000',
    proxy: {
      // 字符串简写写法
      '/foo': 'http://localhost:4567',
      // 选项写法
      '/api': {
        target: 'http://jsonplaceholder.typicode.com',
        changeOrigin: true,
        rewrite: (path) => path.replace(/^\/api/, '')
      },
      // 正则表达式写法
      '^/fallback/.*': {
        target: 'http://jsonplaceholder.typicode.com',
        changeOrigin: true,
        rewrite: (path) => path.replace(/^\/fallback/, '')
      },
      // 使用 proxy 实例
      '/api': {
        target: 'http://jsonplaceholder.typicode.com',
        changeOrigin: true,
        configure: (proxy, options) => {
          // proxy 是 'http-proxy' 的实例
        }
      },
      // 代理 WebSocket 或 socket
      '/socket.io': {
        target: 'ws://localhost:3000',
        ws: true
      }
   }
})

2、配置 @ 符号

需要先安装 @types/node 插件:

npm i -D @types/node

然后,在 vite.config.ts 文件中增加以下配置:

import { resolve } from "path"
 
export default defineConfig({
  // 配置 @ 符号
  resolve: {
    alias: {
      "@": resolve(__dirname, "src")
    }
  }
})

如果你用到了 ts,需要在 tsconfig.json 的配置文件中增加以下配置:

{
  "compilerOptions": {
   "baseUrl": "./",
    "paths": {
      "@/*": ["src/*"],
      "#/*": ["types/*"]
    },
  },

以上配置完成后,凡是在 src 文件下的相对路径都可以写成 @ 符号了。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,552评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,666评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,519评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,180评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,205评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,344评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,781评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,449评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,635评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,467评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,515评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,217评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,775评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,851评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,084评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,637评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,204评论 2 341

推荐阅读更多精彩内容