插件管理
本项目插件通过命令行的方式进行管理。整体目录在:
`icegl-three-vue-tres`
├── pluginMaker // 插件管理目录
├── install // 请把需要安装的插件包,放在这里
├── packages // 这里是自制打包好的插件包存放处
└── index.js // 请勿修改,插件的管理脚本
创建插件
TvT.js 可以通过命令行创建一个插件,首先我们将工作目录定位到我们的项目根目录,也就是.env.predev
文件所在的目录。
cd /icegl-three-vue-tres/ #请自行定位到目录
然后我们在命令行输入
yarn plugin.marker create mydemo
即可通过命令行创建一个标识为mydemo的插件,此时我们的项目中就会出现这个插件,对应的文件在:
- 静态资源:
./public/plugins/mydemo/*
- 代码资源:
./src/plugins/mydemo/*
现在启动预览模式,即可看到此插件:
yarn pre.dev
安装插件
首先您从官方渠道下载到插件包例如:pluginA.zip
后,将插件包移动到项目的 pluginMaker -> install
目录下,然后运行:
yarn plugin.marker install pluginA
此时我们的项目中就会出现这个安装了的插件,对应的文件在:
- 静态资源:
./public/plugins/pluginA/*
- 代码资源:
./src/plugins/pluginA/*
现在启动预览模式,即可在左下角菜单中看到此插件:
yarn pre.dev
打包插件
首先确保插件的目录结构有按照单个插件结构章节进行规范设计,且所有插件功能均已完成开发和测试。 我们可以在命令行一键打包插件,首先工作目录定位到我们的项目根目录,也就是.env.predev
文件所在目录,如下
yarn plugin.marker package pluginX
TIP
pluginX 名称请您自行根据您的插件名更改
- 确保如下目录正确
- 静态资源:
./public/plugins/pluginX/*
- 代码资源:
./src/plugins/pluginX/*
- 确保
./src/plugins/pluginX/config.js
配置正确