一套 Web 内核、四种形态交付的多平台插件开发模板。用它快速搭建自己的插件项目,一次开发,同时产出 Web 应用、浏览器插件、VSCode 插件与 uTools 插件。
此框架实践项目:
模板内置三个页面作为示例骨架:首页、关于、变量格式转换。开发者可参照
变量格式转换页扩充自己的工具。
| 形态 | 目录 | 运行环境 | 打包产物 |
|---|---|---|---|
| Web 应用 | plugin-forge/ |
浏览器 | dist/(静态文件) |
| 浏览器插件 | plugin-forge-browser/ |
Chrome / Edge(MV3) | dist/ + .zip |
| VSCode 插件 | plugin-forge-vscode/ |
VSCode ≥ 1.85 | .vsix |
| uTools 插件 | plugin-forge-utools/ |
uTools ≥ 5.0.0 | .upxs |
所有形态共享同一份 Web 内核,本地运行、数据不上传。
plugin-forge/
├── plugin-forge/ # Web 内核(Vue 3 + Vite + Element Plus)
├── plugin-forge-browser/ # 浏览器插件(Chrome / Edge,MV3)
├── plugin-forge-vscode/ # VSCode 插件(扩展外壳 + Webview 内嵌)
├── plugin-forge-utools/ # uTools 插件(plugin.json + Web 嵌入)
├── plugin-forge-doc/ # 文档站点(VitePress)
├── LICENSE
└── README.md
- Node.js ≥ 22.18.0 或 ≥ 24.12.0
- 推荐 Node.js 26.7.0(我本地使用此版本,未发现问题)
cd plugin-forge
npm install
npm run dev # 开发服务器(端口 7011)
npm run build # 构建生产版本cd plugin-forge-browser
npm install
npm run package # 构建 webview 并打包成 .zip产物为 plugin-forge-browser/dist/(可加载目录)与 plugin-forge-browser/plugin-forge-browser-<version>.zip(分发包)。安装方式:chrome://extensions 打开「开发者模式」→「加载已解压的扩展程序」→ 选择 dist/。
cd plugin-forge-vscode
npm install
npm run package # 构建 webview 并打包成 .vsix打包产物为 plugin-forge-vscode/plugin-forge-vscode-<version>.vsix,在 VSCode 扩展面板「从 VSIX 安装」即可。
cd plugin-forge-utools
npm install
npm run package # 构建 web 并组装 dist/(不再产 .upx)产物为 plugin-forge-utools/dist/(核心交付物)。uTools v5.0.0 起将安装包格式升级为 .upxs(加密 + 开发者信息签名),任何普通 zip 工具改名的 .upx 在 v5.0.0 及之后版本均不会被识别为插件安装包。.upxs 需用「uTools 开发者工具」导入 dist/plugin.json,点「打包 UPXS」生成。安装方式任选其一:① 在文件资源管理器中左键单击选中 .upxs,按鼠标中键(默认触发键,未修改设置时)呼出超级面板 → 「安装插件应用」(超级面板已关闭则用方式②);② 复制 .upxs,按 Alt + Space(默认快捷键,未修改设置时)呼出搜索框,粘贴 → 「安装插件应用」。
基于 VitePress 的模板使用文档,介绍四种形态与如何扩展新工具:
cd plugin-forge-doc
npm install
npm run docs:dev # 本地预览
npm run docs:build # 构建静态站点(产物 docs/.vitepress/dist/)- Web 内核:Vue 3.5 / Vite 8 / Pinia / Element Plus / Vue Router
- 浏览器插件:Chromium MV3(manifest v3 + service worker)
- VSCode 插件:TypeScript + esbuild(扩展端)/ @vscode/vsce(打包)
- uTools 插件:plugin.json(uTools 清单)+ uTools 开发者工具(v5.0.0+ 打包为加密签名的
.upxs;官方未提供命令行打包工具)
本项目主仓库位于 Gitee,GitHub 为自动单向同步的只读镜像。
- 你可以自由 Fork GitHub 上的代码副本,但所有代码提交、Bug反馈、功能建议、Pull Request,请前往 Gitee 主仓库。
- GitHub仓库所有文件由Gitee自动同步覆盖,任何在此处的手动修改都会丢失。
👉 Gitee主仓库地址:https://gitee.com/miaoaa66/plugin-forge