magic_admin_web/build/plugins.ts

import {resolve} from "path";
import {PluginOption} from "vite";
import {VitePWA} from "vite-plugin-pwa";
import {createHtmlPlugin} from "vite-plugin-html";
import {visualizer} from "rollup-plugin-visualizer";
import {createSvgIconsPlugin} from "vite-plugin-svg-icons";
import vue from "@vitejs/plugin-vue";
import vueJsx from "@vitejs/plugin-vue-jsx";

import viteCompression from "vite-plugin-compression";
import vueSetupExtend from "unplugin-vue-setup-extend-plus/vite";
import NextDevTools from "vite-plugin-vue-devtools";
import {codeInspectorPlugin} from "code-inspector-plugin";

/**
 * 创建 vite 插件
 * @param viteEnv
 */
export const createVitePlugins = (viteEnv: ViteEnv): (PluginOption | PluginOption[])[] => {
  const {VITE_GLOB_APP_TITLE, VITE_REPORT, VITE_DEVTOOLS, VITE_PWA, VITE_CODEINSPECTOR} = viteEnv;
  return [
    vue(),
    // vue 可以使用 jsx/tsx 语法
    vueJsx(),
    // devTools
    VITE_DEVTOOLS && NextDevTools({launchEditor: "code"}),
    // esLint 报错信息显示在浏览器界面上

    // name 可以写在 script 标签上
    vueSetupExtend({}),
    // 创建打包压缩配置
    createCompression(viteEnv),
    // 注入变量到 html 文件
    createHtmlPlugin({
      minify: true,
      inject: {
        data: {title: VITE_GLOB_APP_TITLE}
      }
    }),
    // 使用 svg 图标
    createSvgIconsPlugin({
      iconDirs: [resolve(process.cwd(), "src/assets/icons")],
      symbolId: "icon-[dir]-[name]"
    }),
    // vitePWA
    VITE_PWA && createVitePwa(viteEnv),
    // 是否生成包预览，分析依赖包大小做优化处理
    // VITE_REPORT && (visualizer({filename: "stats.html", gzipSize: true, brotliSize: true}) as PluginOption),
    // 自动 IDE 并将光标定位到 DOM 对应的源代码位置。see: https://inspector.fe-dev.cn/guide/start.html
    VITE_CODEINSPECTOR &&
    codeInspectorPlugin({
      bundler: "vite"
    })
  ];
};

/**
 * @description 根据 compress 配置，生成不同的压缩规则
 * @param viteEnv
 */
const createCompression = (viteEnv: ViteEnv): PluginOption | PluginOption[] => {
  const {VITE_BUILD_COMPRESS = "none", VITE_BUILD_COMPRESS_DELETE_ORIGIN_FILE} = viteEnv;
  const compressList = VITE_BUILD_COMPRESS.split(",");
  const plugins: PluginOption[] = [];
  if (compressList.includes("gzip")) {
    plugins.push(
      viteCompression({
        ext: ".gz",
        algorithm: "gzip",
        deleteOriginFile: VITE_BUILD_COMPRESS_DELETE_ORIGIN_FILE
      })
    );
  }
  if (compressList.includes("brotli")) {
    plugins.push(
      viteCompression({
        ext: ".br",
        algorithm: "brotliCompress",
        deleteOriginFile: VITE_BUILD_COMPRESS_DELETE_ORIGIN_FILE
      })
    );
  }
  return plugins;
};

/**
 * @description VitePwa
 * @param viteEnv
 */
const createVitePwa = (viteEnv: ViteEnv): PluginOption | PluginOption[] => {
  const {VITE_GLOB_APP_TITLE} = viteEnv;
  return VitePWA({
    strategies: 'generateSW', // 明确指定使用 generateSW
    registerType: 'autoUpdate',
    workbox: {
      maximumFileSizeToCacheInBytes: 10 * 1024 * 1024, // 提升缓存限制至10MB
      // 禁止缓存 CSV（包含 404）
      runtimeCaching: [
        {
          urlPattern: /\/admin\/api\/static\/.*\.csv$/,
          handler: "NetworkOnly",
          method: "GET",
          options: {
            cacheName: "no-cache-csv",
            expiration: { maxEntries: 0 }
          }
        }
      ]
    },
    manifest: {
      name: VITE_GLOB_APP_TITLE,
      short_name: VITE_GLOB_APP_TITLE,
      theme_color: "#ffffff",
      icons: [
        {
          src: "/logo.svg",
          sizes: "24x24",
          type: "image/svg+xml"
        },
      ]
    }
  });
};