vite插件的编写

vite组件插件

这里的 config 方法接收一个参数，通常也是名为 config 的对象，它代表了当前 Vite 项目的配置。该方法返回一个新对象，其中包含对原始配置的修改或扩展。在这个例子中，返回的对象中有一个 define 属性，它是用来定义全局常量的。

vite.config.ts

1
2
3
4
5
6
plugins: [
    uniReadPagesV3Plugin({
        pagesJsonDir: path.resolve(__dirname, './pages.json'),
        includes: ['path', 'aliasPath', 'name', 'meta'],
    }),
],

插件返回值

1
2
3
4
5
6
7
8
9
10
11
12
13
uniReadPagesV3Plugin返回值如下
 return {
    name: 'uni-read-pages-v3',
    config(config) {
      return {
        define: {
          ROUTES: pages.routes,
          ROUTES_MAP: pages.routesMap,
          TABBAR: pages.tabbar,
        },
      };
    },
  };

具体来说：

  1. name: 'uni-read-pages-v3'：这是插件的名称，它通常用于调试和错误消息中，以便开发者知道是哪个插件产生了特定的效果。
  2. config(config)：这是一个函数，它接收当前的 Vite 配置对象 config 作为参数，并返回一个新的配置对象。Vite 会使用这个返回的对象来替换或扩展原始的配置。
  3. define：在返回的配置对象中，define 是一个特殊字段，它允许你定义一些在构建过程中会被替换为实际值的全局常量。
  4. ROUTES, ROUTES_MAP, TABBAR：这些是插件定义的全局常量，它们分别对应于 pages.routes, pages.routesMap, pages.tabbar 的值。这些值可能是从 pages.json 文件解析出来的，或者是由插件逻辑生成的。
  • 插件将被初始化，并且其配置选项（如 pagesJsonDir 和 includes）将被传递给 uniReadPagesV3Plugin 构造函数。
  • 插件将有机会通过其 config 方法修改 Vite 的配置。
  • 插件定义的全局常量 ROUTES, ROUTES_MAP, TABBAR 将被添加到 Vite 的配置中，并且可以在项目的构建过程中被使用。