发布时间:2023-05-27 文章分类:WEB开发, 电脑百科 投稿人:王小丽 字号: 默认 | | 超大 打印

初识vite

vite基本配置

当以命令行方式运行 vite 时,vite 会自动解析项目根目录下名为 vite.config.js 的文件。以下是基础的配置文件:

1. IDE智能提示

通过 IDE 和 jsdoc 的配合来实现智能提示

// vite.config.js
/** @type {import('vite').UserConfig} */  
export default {  
    // 一些自定义基础配置  
}  

使用工具函数 defineConfig

import { defineConfig } from 'vite';
export default defineConfig({
    // 一些自定义基础配置
})
2. 开发/生产环境情景配置

使用defineConfig工具函数并以箭头函数作为callback函数接收command, mode, ssrBuild来获取一些基本参数,用于区分环境亦或者是一个 SSR 构建(ssrBuild)

// vite.config.js
export default defineConfig(({ command, mode, ssrBuild }) => {
  if (command === 'serve') {
    return {
      // dev 独有配置
    }
  } else {
    // command === 'build'
    return {
      // build 独有配置
    }
  }
})
3. 引入路径配置

路径配置可以自定义配置或者借助插件

  1. 自定义配置

    // vite.config.js
    import { defineConfig } from 'vite';
    import path from 'path';
    export default defineConfig({
        resolve: {
            alias: {
            '@': path.resolve(__dirname, './src') // 路径别名
            }
        }
    })
    

    假如你的项目使用 typescript 进行开发,则需要在 tsconfig.json 文件中配置paths,否则IDE引入路径飘红

    // tsconfig.json
    {
    "paths": {
    "@src/*": ["./src/*"],
    },
    "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.vue"] // 编译对以下文件进行ts检测
    "exclude": ["dist", "node_modules"] // 编译排除以下文件ts检测
    }
    
  2. 使用 vite-aliases 插件
    默认别名示例:src -> @src; hooks -> @hooks,即使用@符号作为前缀

    import { defineConfig } from 'vite';
    import { ViteAliases } from 'vite-aliases';
    export default defineConfig({
        plugins: [
            ViteAliases()
        ]
    })
    

    使用/引入路径示例:

    import xxx from ‘@src/xxxx’;
    import xxx from ‘@hooks/xxxx’;

4. CSS样式预处理

vite虽然内置了css预处理器,如需要按需引入则需要手动引入css工具

css: {
    preprocessorOptions: {
      scss: {
        additionalData: `@import '/xxx/xx.scss;` // 引入全局变量文件
      }
    },
  },
5. 本地调试代理流量转发
export default defineConfig({
    server: {
        host: true, // 对所有地址进行监听
        proxy: {
            // 字符串 
            '/foo': 'http://localhost:8080',  
            // 选项写法
            '/api': {
                target: 'http://xxxx.xxxx.com',
                changeOrigin: true,
                rewrite: (path) => path.replace(/^\/api/, '')
            },  
            // 正则表达式写法  
            '^/fallback/.*': {
                target: 'http://xxxx.xxxx.com',
                changeOrigin: true,
                rewrite: (path) => path.replace(/^\/fallback/, '')
            },
        }
    },
  },
})

vite服务入口模版

vite默认引用外部index.html,在里面通过type="module"实现ES Module注入模版,如果需要调整则需要在 vite.config.js 添加root属性,也可以配置 build 属性(支持多入口)。

修改root
import { defineConfig } from 'vite';
export default defineConfig({
    root: 'src/packages/index/', // 模版路径
})
多入口配置尝试

rollup打包并不允许相对路径的存在,多入口需要配置不同的npm scripts命令来进入不同的入口(即使这么做是没意义的),试着探索一下可行性,于是有了以下操作:

1. vite.config.js
import { defineConfig } from 'vite';
export default defineConfig({
    build: {
        rollupOptions: {
            input: {
                mono1: path.resolve(__dirname, 'src/packages/template1/index.html'),
                mono2: path.resolve(__dirname, 'src/packages/template2/index.html'),
            },
        },
    },
})
2. package.json 启动脚本配置
// package.json
"scripts": {
    "mono1": "vite serve src/packages/template1/ --config ./vite.config.ts",
    "mono2": "vite serve src/packages/template2/ --config ./vite.config.ts",
}

静态资源管理

  1. vite对大多数静态资源类型进行了内置处理,如果还有不支持的通过assetsInclude添加支持.
  2. 静态资源体积 >= 4KB时会提取成单独的文件, < 4KB时则作为 base64 格式的字符串内联
  3. 通过build.assetsInlineLimit自定义配置
  4. svg属于html类型文件,始终打包成文件
  5. 图片压缩,可借助vite-plugin-imagemin插件
import { defineConfig } from 'vite';
import viteImagemin from 'vite-plugin-imagemin';
export default defineConfig({
    plugins: [
      viteImagemin({
        gifsicle: {
          optimizationLevel: 7,
          interlaced: false
        },
        optipng: {
          optimizationLevel: 7
        },
        mozjpeg: {
          quality: 20
        },
        pngquant: {
          quality: [0.8, 0.9],
          speed: 4
        },
        svgo: {
          plugins: [
            {
              name: 'removeViewBox'
            },
            {
              name: 'removeEmptyAttrs',
              active: false
            }
          ]
        }
      })
    ],
})

后记

这是我第一次写关于vite的文章,由于个人水平有限,也是刚接触到vite,而且每个人的观点和方法可能都存在差异。因此文章中难免会有不严谨甚至不正确的地方,并且每个人的开发环境略有差别,可能会导致代码表现差异,如有发现,欢迎大家指出来并多多交流。