Skip to content

QC2168/utools-plugin-template

Repository files navigation

utools-plugin-template

基于Vite+VueUtools插件开发模板,让您更快的开发出一款属于自己的Utools插件

中文文档 | English

✨ 特性

  • 🌈 开箱即用的Vite+Vue3+TSUtools插件开发模板
  • ⚡ 开发环境自动注入HMR字段
  • 🦍 自动构建upx
  • 🧸 构建utools/preload文件,自动处理插件第三方依赖(依赖脚本位于script/build.js
  • 🚀 构建桌面应用(electron 不需要可移除)

🥩 开始使用

🔗 克隆项目

git clone https://github.com/QC2168/utools-plugin-template.git

🔧 安装依赖

推荐使用pnpm包管理工具,如果您还没有安装可以执行npm install -g pnpm进行安装

pnpm install

🛫 启动项目

pnpm dev

📦 打包项目

pnpm build

执行build命令时,会将插件直接构建成upx包,开发者无需在utools开发者工具中二次构建 🚀

多个preload文件处理

原理:通过读取提供的preload.js文件,获取所需的依赖包后,在插件打包目录下执行npm install实现依赖安装

import { install } from '@qc2168/vite-plugin-utools';
// 添加编译后的preload文件
install(['./dist/preload.js']);

如何启动插件

utools中,打开utools开发者工具,并新建一个项目

根据您的实际情况,填写插件所需信息

20231110155724

执行dev指令,生成dist文件夹,将文件路径选中/dist/plugin.json

20231110155834

20231110155947

启动插件,并触发插件第一个关键字

20231110160045

20231110160101

20231110160121

开始你的开发之旅吧~

🍭 最后

如果您有更好的想法,欢迎提交issue或者pr 🥰🥰

如果您觉得这个项目对您有帮助,可以点击右上角的star按钮支持一下我,谢谢您~ 😘😘

About

📦开箱即用的Utools插件开发模板

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •