vite-plugin-miniprogram-tree-shaking

一个用于跨平台小程序框架使用原生小程序组件库时的 Tree Shaking 插件

Install

npm install vite-plugin-miniprogram-tree-shaking --save-dev
# or
yarn add vite-plugin-miniprogram-tree-shaking -D

Usage

这里以uniapp为例（插件执行顺序需要放在跨平台小程序框架相关vite插件之后，建议放在最后）

import { defineConfig } from 'vite'
import uni from "@dcloudio/vite-plugin-uni";
import miniprogramTreeShaking from "vite-plugin-miniprogram-tree-shaking";

export default defineConfig(({ mode }) => {
  return {
    plugins: mode === "production" ? [uni(), miniprogramTreeShaking({
      include: ["pages/**/*", "subpages/**/*", "components/**/*"], // 表示从以下路径中去寻找所使用过的组件
      componentsPlatform: "alipay", // 原生小程序组件库平台
      componentsPrefix: "ant", // pages.json中 要处理的小程序组件库前缀 例如 <ant-button> 中的 ant 默认使用 '-' 拼接
      excludeComponents: [
        "style",
        "_util",
        "mixins",
        "tsxml",
      ], // 支付宝小程序组件库所需要的base内容
      componentsPath:
        "dist/build/mp-alipay/mycomponents/node_modules/antd-mini/es", // 原生小程序组件库编译后的目录路径
      miniprogramComponentsPath: "dist/build/mp-alipay/mycomponents", // 如果是以node_modules的方式引入的话可以填写，用于CI上安装依赖(内部执行npm i)
    })] : [uni()];
  };
});

Options

include

• Type: string | string[]

包括要匹配的路径(必填)

exclude

• Type: string | string[]

包括不匹配的路径

componentsPlatform

• Type: keyof typeof Platform

使用原生小程序组件库的平台(必填)

componentsPrefix

• Type: string

要处理的小程序组件库前缀(必填,需要统一格式), 例如 pages.json中 要处理的小程序组件库前缀 例如 中的 ant 默认使用 '-' 拼接

componentsPath

• Type: string

要处理的小程序组件库路径(必填)

excludeComponents

• Type: string[]

排除的组件或文件夹(必填), 例如 ['style', 'mixins', 'tsxml']

miniprogramComponentsPath

• Type: string

要处理的小程序组件库根路径,有需要在CI上执行npm安装依赖的情况下填写

npm

• Type: boolean
• Default: false

原生小程序组件库是否采用npm的方式, 如果该值设置为true时 miniprogramComponentsPath 为必填

License

MIT