vite配置详解

1npm run build 打包构建
2npm run preview 当上一步构建完成后，运行该命令测试应用，会预览 run build 打包结果。
3该命令会在本地启动一个静态 Web 服务器，将 dist 文件夹运行在 http://localhost:4173
4"preview": "vite preview --port 8080" 指定端口号
5"dev": "vite --open", //自动打开浏览器
6"build": "vue-tsc --noEmit && vite build", //noEmit 表示只记录错误，不会进行编译
7"preview": "vite preview --open"

1  .env                # 所有情况下都会加载
2  .env.local          # 所有情况下都会加载，但会被 git 忽略
3  .env.[mode]         # 只在指定模式下加载,如.env.production的优先级比.env高
4  .env.[mode].local   # 只在指定模式下加载，但会被 git 忽略
5
6  VITE_SOME_KEY=123
7  import.meta.env.VITE_SOME_KEY访问
8
9  只有以VITE_为前缀的变量才会暴露给经过vite处理的代码

1///
2<reference types="vite/client" />
3
4interface ImportMetaEnv { readonly VITE_APP_TITLE: string // 更多环境变量... }
5interface ImportMeta { readonly env: ImportMetaEnv }

1  vite build --mode staging
2  .env.staging文件存放相关模式下的环境变量

1默认情况下 Vite 只处理语法转译，且默认不包含任何 polyfill。
2通过引入polyfill
3        可以前往 Polyfill.io 查看，这是一个基于用户浏览器 User-Agent 字符串自动生成 polyfill 包的服务
4通过插件支持:
5       通过插件@vitejs/plugin-legacy来支持，它将自动生成传统版本的 chunk 及与其相对应 ES 语言特性方面的 polyfill
6   兼容版的chunk只会在不支持原生 ESM 的浏览器中进行按需加载

 1(1)esbuild下不支持功能编辑时报错
 2	配置类型导入导出、enum、没有import、export导入导出的非模块文件报错
 3	tsconfig.json
 4	{
 5                "compilerOptions": {
 6                    "isolatedModules":true 上述特性会在编辑时报错，否则会在运行时报错
 7                }
 8	}
 9
10(2)导入vite内置的一些类型定义
11	.资源导入 (例如：导入一个 .svg 文件)
12	.import.meta.env 上 Vite 注入的环境变量的类型定义
13	.import.meta.hot 上的 HMR API 类型定义
14
15	方式一：在.d.ts文件中
16		/// <reference types="vite/client" />
17	方式二：在tsconfig.json中
18		{
19		  "compilerOptions": {
20		    "types": ["vite/client"]
21		  }
22		}

 1├── package.json
 2├── vite.config.js
 3├── index.html
 4├── main.js
 5└── nested
 6    ├── index.html
 7    └── nested.js
 8
 9  build: {
10    rollupOptions: {
11      input: {
12        main: resolve(__dirname, 'index.html'),
13        nested: resolve(__dirname, 'nested/index.html')
14      }
15    }
16  }

  11. 区分不同环境配置
  2    command：根据运行的命令区分配置，serve为开发环境，否则为build生产环境
  3    mode：根据环境区分配置
  4    export default defineConfig(async ({ command, mode }) => {
  5      const config=await fn();	支持使用Promise
  6      if (command === 'serve') {
  7        return {
  8
  9        }
 10      } else if(command='build'){
 11        return {}
 12      }
 13    })
 14
 152. 选项配置
 16export default defineConfig({
 17    root：默认process.cwd(),	index.html所在的位置,绝对位置或相对位置
 18    base：开发或生产环境服务的公共基础路径
 19            绝对 URL 路径名，例如 /foo/
 20            完整的 URL，例如 https://foo.com/
 21            空字符串或 ./（用于开发环境）
 22            通过命令指定：vite build --base=/my/public/path/
 23            代码中获取base：import.meta.env.BASE_URL全局变量在代码中使用，原样出现(例如import.meta.env['BASE_URL']是无效的)
 24    mode：将会把serve和build时的模式都覆盖掉。也可以通过命令行 --mode 选项来重写
 25            'development'（serve）
 26            'production'（build）
 27    define：定义全局常量替换方式。其中每项在开发环境下会被定义在全局，而在构建时被静态替换
 28            {
 29                    __DEV__: 'dev',
 30            }
 31    plugins：[]	插件数组
 32    publicDir：作为静态资源服务的文件夹。该目录中的文件在开发期间在 / 处提供，并在构建期间复制到 outDir 的根目录，并且始终按原样提供或复制而无需进行转换。
 33    该值可以是文件系统的绝对路径，也可以是相对于项目的根目录的相对路径。
 34            默认'public'
 35    cacheDir：存储缓存文件的目录。此目录下会存储预打包的依赖项或 vite 生成的某些缓存文件，使用缓存可以提高性能。
 36    如需重新生成缓存文件，你可以使用 --force 命令行选项或手动删除目录。此选项的值可以是文件的绝对路径，也可以是以项目根目录为基准的相对路径。当没有检测到 package.json 时，则默认为 .vite。
 37            默认"node_modules/.vite"
 38    assetsInclude：解析额外的定义内置type以外的静态导入资源
 39            ['**/*.gltf']
 40    logLevel：调整控制台输出的级别，默认为 'info'
 41            'info' | 'warn' | 'error' | 'silent'
 42    clearScreen：设为 false 可以避免 Vite 清屏而错过在终端中打印某些关键信息。命令行模式下可以通过 --clearScreen false 设置。
 43            默认：true
 44    envDir：用于加载 .env 文件的目录。可以是一个绝对路径，也可以是相对于项目根的路径
 45            默认：根路径
 46    envPrefix：自定义环境变量前缀，以 envPrefix 开头的环境变量会通过 import.meta.env 暴露在你的客户端源码中
 47            默认：VITE_
 48
 49
 50    解析相关
 51    resolve:{
 52      alias:路径别名
 53        {
 54                "@": path.resolve(__dirname, "src"),
 55        }
 56        或
 57        [{
 58                find: '@',  字符串｜正则
 59        replacement: path.resolve(__dirname, 'src')
 60        }]
 61      dedupe:使用此选项强制 Vite 始终将列出的依赖项解析为同一副本
 62              比如当安装了两个不同版本的依赖，如vue2和vue3，通过这个声明最终引入的版本
 63              []
 64      condition:情景导出
 65              [{
 66                "exports": {
 67                  ".": {
 68                    "import": "./index.esm.js",
 69                    "require": "./index.cjs.js"
 70                  }
 71                }
 72              }]
 73      mainFields：根据package.json中的字段，在不同环境中导入库的入口文件位置
 74              import引入的文件对应module中的路径
 75              require引入的文件对应main中的路径
 76              默认：['module', 'jsnext:main', 'jsnext','main']
 77      extensions导入时想要省略的扩展名列表。不建议忽略自定义导入类型的扩展名（例如：.vue），因为它会影响 IDE 和类型支持
 78              默认：['.mjs', '.js', '.ts', '.jsx', '.tsx', '.json']
 79      preserveSymlinks：启用此选项会使 Vite 通过原始文件路径（即不跟随符号链接的路径）而不是真正的文件路径（即跟随符号链接后的路径）确定文件身份
 80              默认：false
 81
 82    }
 83
 84    css相关
 85    css：{
 86        modules:配置 CSS modules 的行为。选项将被传递给 postcss-modules。
 87        postcss:内联的 PostCSS 配置（格式同 postcss.config.js），或者一个（默认基于项目根目录的）自定义的 PostCSS 配置路径
 88        preprocessorOptions:指定传递给 CSS 预处理器的选项。
 89        {
 90          scss: {
 91            additionalData: `$injectedColor: orange;`
 92          }
 93        }
 94    }
 95
 96    JSON相关
 97    json：{
 98      namedExports：是否支持从 .json 文件中进行按名导入。
 99              默认：true
100      stringify：若设置为 true，导入的 JSON 会被转换为 export default JSON.parse("...")
101              默认：false
102    }
103
104    esbuild相关
105    esbuild：{
106      jsxFactory: 'h',
107      jsxFragment: 'Fragment' 以上为自定义JSX
108
109      ESbuild会被应用在 ts、jsx、tsx 文件，以下选项对要处理的文件类型进行配置
110      include：string | RegExp | (string | RegExp)[]
111      exclude：string | RegExp | (string | RegExp)[]
112
113      jsxInject:自动为每一个被 ESbuild 转换的文件注入内容
114          `import React from 'react'`
115    }
116
117    server相关
118    server：{
119      host：指定服务器应该监听哪个 IP 地址， 如果将此设置为 0.0.0.0 或者 true 将监听所有地址，包括局域网和公网地址
120              默认：'127.0.0.1'
121              命令设置：--host 0.0.0.0 或 --host
122      port：指定开发服务器端口。注意：如果端口已经被使用，Vite 会自动尝试下一个可用的端口，所以这可能不是开发服务器最终监听的实际端口
123              默认：3000
124      strictPort：设为true时若端口已被占用则会直接退出，而不是尝试下一个可用端口
125              默认：false
126      https：启用 TLS + HTTP/2。注意：当 server.proxy 选项 也被使用时，将会仅使用 TLS。
127              当为true：启用 TLS + HTTP/2。注意：当 server.proxy 选项 也被使用时，将会仅使用 TLS。
128              这个值也可以是一个传递给 https.createServer() 的 选项对象
129                      https://nodejs.org/api/https.html#httpscreateserveroptions-requestlistener
130      open：在开发服务器启动时自动在浏览器中打开应用程序。
131              '/docs/index.html'
132              设置打开的浏览器：设置环境变量 process.env.BROWSER='firefox'
133              open其他配置：https://github.com/sindresorhus/open#app
134      proxy：服务器代理
135          {
136            '/foo': 'http://localhost:4567',	字符串简写写法
137            '/api': { 以 ^ 开头，将会被解释为正则，如：'^/fallback/.*'
138              target: 'http://jsonplaceholder.typicode.com',
139              changeOrigin: true,
140              rewrite: (path) => path.replace(/^\/api/, ''),
141              configure: (proxy, options) => {
142                // proxy 是 'http-proxy' 的实例
143              }
144            },
145            '/socket.io': { 代理 websockets or socket.io
146              target: 'ws://localhost:3000',
147              ws: true
148            }
149          }
150      cors：为开发服务器配置 CORS。默认启用并允许任何源
151              传递一个 选项对象 来调整行为，https://github.com/expressjs/cors#configuration-options
152              设置false表示禁用
153      force：依赖预构建
154              设置为 true 强制使依赖预构建。
155      hmr：热更新相关
156          false禁用
157          {
158              protocol?: string,  协议
159              host?: string,
160              port?: number,
161              path?: string,
162              timeout?: number,
163              overlay?: boolean, 为 false 可以禁用开发服务器错误的屏蔽
164              clientPort?: number, 只在客户端的情况下覆盖端口，这允许你为 websocket 提供不同的端口，而并非在客户端代码中查找。
165              如果需要在 dev-server 情况下使用 SSL 代理，这非常有用。
166              server?: Server, 当使用 server.middlewareMode 或 server.https 时，你需将 server.hmr.server 指定为你 HTTP(S) 的服务器，
167              这将通过你的服务器来处理 HMR 的安全连接请求。
168              这在使用自签证书或想通过网络在某端口暴露 Vite 的情况下，非常有用。
169          }
170      middlewareMode：以中间件模式创建 Vite 服务器
171              'ssr' | 'html'	在SSR中使用
172      fs.strict：限制为工作区 root 路径以外的文件的访问
173              默认：true
174      fs.allow：限制哪些文件可以通过 /@fs/ 路径提供服务，Vite 将会搜索此根目录下潜在工作空间并作默认使用
175      fs.deny：用于限制 Vite 开发服务器提供敏感文件的黑名单。
176              默认为 ['.env', '.env.*', '*.{pem,crt}']
177      watch：监听文件改变
178          通过命令:vite build --watch
179          {
180              ignored: ['!**/node_modules/your-package-name/**']	默认会忽略对 .git/ 和 node_modules/ 目录的监听,
181              如果需要对 node_modules/ 内的包进行监听，可以为 server.watch.ignored 赋值一个取反的 glob 模式
182              其他选项：使用的是rollup的选项配置:https://rollupjs.org/guide/en/#watch-options
183          }
184    }
185
186    optimizeDeps依赖优化相关
187    optimizeDeps：{
188      entries：依赖入口点
189              默认情况下，Vite 会抓取你的 index.html 来检测需要预构建的依赖项
190              如果指定了 build.rollupOptions.input，Vite 将转而去抓取这些入口点
191              string | string[]：指定自定义条目，该值需要遵循 fast-glob 模式
192    exclude：['your-package-name'] 被watch中手动设置监听的包必须被排除在优化之外，以便它能出现在依赖关系图中并触发热更新
193    include：默认情况下，不在 node_modules 中的，链接的包不会被预构建。使用此选项可强制预构建链接的包。
194            []
195            应用场景：一些第三方插件中的依赖不是node_modules中的并且也不是es module的格式
196    esbuildOptions：在部署扫描和优化过程中传递给 esbuild 的选项。
197
198
199
200}
201
202    build构建相关
203    build：{
204      target：设置最终构建的浏览器兼容目标
205              默认：'modules':指支持原生 ES 模块的浏览器。
206              "esnext" :即假设有原生动态导入支持，并且将会转译得尽可能小：
207                      如果 build.minify 选项为 'terser'， 'esnext' 将会强制降级为 'es2019'。
208                      其他情况下将完全不会执行转译。
209              'es2015'：自定义目标也可以是一个 ES 版本
210              ["chrome58",...]：一个浏览器版本或是多个目标组成的一个数组
211      polyfillModulePreload：用于决定是否自动注入 module preload 的 polyfill.
212              true：此 polyfill 会被自动注入到每个 index.html 入口的 proxy 模块中
213      outDir：指定输出路径（相对于 项目根目录).
214              默认：dist
215      assetsDir：指定生成静态资源的存放路径（相对于 build.outDir）
216              默认：assets
217      assetsInlineLimit：小于此阈值的导入或引用资源将内联为 base64 编码，以避免额外的 http 请求。
218              默认：4096 (4kb)
219              设置为 0 可以完全禁用此项。
220      cssCodeSplit：css代码分割
221              默认：true，在异步 chunk 中导入的 CSS 将内联到异步 chunk 本身，并在其被加载时插入。
222              false：整个项目中的所有 CSS 将被提取到一个 CSS 文件中
223      cssTarget：允许用户为 CSS 的压缩设置一个不同的浏览器 target
224              默认值和配置与target一致
225      sourcemap：构建后是否生成 source map 文件
226              默认：false
227              true：创建一个独立的 source map 文件
228              'inline'：source map 将作为一个 data URI 附加在输出文件中
229              'hidden'：与 'true' 相似，只是 bundle 文件中相应的注释将不被保留
230      rollupOptions：自定义的 Rollup 打包配置，并将与 Vite 的内部 Rollup 选项合并
231              https://rollupjs.org/guide/en/#big-list-of-options
232      commonjsOptions：传递给 @rollup/plugin-commonjs 插件的选项。
233      dynamicImportVarsOptions：传递给 @rollup/plugin-dynamic-import-vars 的选项。
234      lib：打包库
235          {
236                  entry: string,
237                  name?: string, 	暴露的全局变量
238                  formats?: ('es' | 'cjs' | 'umd' | 'iife')[], 	包含 'umd' 或 'iife' 时是必须的。默认 formats 是 ['es', 'umd']
239                  fileName?: string | ((format: ModuleFormat) => string) 	输出的包文件名
240                          默认 fileName 是 package.json 的 name 选项
241          }
242      manifest：包含了没有被 hash 过的资源文件名和 hash 后版本的映射。
243              true：包含了没有被 hash 过的资源文件名和 hash 后版本的映射。
244              字符串：作为 manifest 文件的名字
245      ssrManifest：生成 SSR 的 manifest 文件，以确定生产中的样式链接与资产预加载指令
246              配置和manifest一致
247      ssr：生成面向 SSR 的构建
248              默认：undefined
249              字符串：用于直接定义 SSR 的入口
250              true：需要通过设置 rollupOptions.input 来指定 SSR 的入口
251      minify：压缩相关
252              默认：'esbuild'
253              false：禁用
254              'terser'
255              在lib模式下使用 'es' 时，build.minify 选项将失效
256      terserOptions：传递给 Terser 的更多 minify 选项。
257      write：磁盘写入相关
258              默认：true
259              false：禁用将构建后的文件写入磁盘
260      emptyOutDir：关闭警告
261              默认：若 outDir 在 root 目录下，则为 true，Vite 会在构建时清空该目录
262              outDir在根目录之外：会抛出一个警告避免意外删除掉重要的文件。可以设置该选项来关闭这个警告
263              通过命令： --emptyOutDir 来使用
264      reportCompressedSize：启用/禁用 gzip 压缩大小报告。压缩大型输出文件可能会很慢，因此禁用该功能可能会提高大型项目的构建性能。
265              默认：true
266      chunkSizeWarningLimit：chunk 大小警告的限制（以 kbs 为单位）
267              默认：500
268      watch：构建监听器
269              默认：null
270              {}：启用 rollup 的监听器。在涉及只用在构建时的插件时和集成开发流程中很常用。
271
272    }
273
274    构建预览preview相关
275    preview：{
276        host：为开发服务器指定 ip 地址，默认取server.host
277                0.0.0.0 或 true：监听所有地址，包括局域网和公共地址。
278                通过命令：--host 0.0.0.0 或 --host
279        port：指定开发服务器端口
280                默认：4173
281        strictPort：默认取server.strictPort
282        https：默认取server.https
283        open：默认取server.openy
284        proxy：默认取server.proxy
285        cors：默认取server.cors
286    }
287
288    SSR相关
289    ssr：{
290      external：为 SSR 强制外部化的依赖。
291              []
292      noExternal：防止被 SSR 外部化依赖项
293              string | RegExp | (string | RegExp)[]
294              true：将没有依赖被外部化
295      target：SSR 服务器的构建目标。
296              默认：'node'
297              'webworker'
298    }
299
300    Worker相关
301    worker：{
302      format：worker bundle 的输出类型。
303          默认：'iife'
304          'es'
305      plugins：适用于 worker bundle 的 Vite 插件。
306              []
307      rollupOptions:用于构建 worker bundle 的 Rollup 配置项
308    }
309
310})