Qiankun Sub-App Generator (qiankun 子应用生成器)

这是一个专为团队前端工程化打造的 VS Code 扩展插件。通过右键菜单,一键快速生成基于 Vue 3 + Vite + qiankun 的标准微前端子应用模板,告别繁琐的初始配置与跨域调试,极大提升团队研发效能!
✨ 核心特性 (Features)
- 🚀 极速生成:在资源管理器右键点击目标空文件夹,直接在当前文件夹完成子应用目录结构初始化。
- 🏷️ 动态变量注入:自动将你输入的
appName 注入到 package.json、vite.config.ts、路由前缀、全局通信事件以及 HTML 挂载点中。
- 🔌 端口可指定:生成时可输入本地开发端口,自动写入
vite.config.ts、.env、.env.production 与 Docker 端口映射。
- 🛡️ 智能过滤引擎:内置防卡死机制,自动过滤模板中遗留的
node_modules、.git、dist 等无用目录,保证生成速度与纯净度。
- 🧩 开箱即用:模板内置 Vue Router、Pinia、Element Plus 及自动按需引入配置,生成完毕即可无缝接入主应用。
📦 安装 (Installation)
打包本插件的 .vsix 安装包。
npm run vsix
打开 VS Code,进入左侧的 扩展 (Extensions) 面板。
点击面板右上角的 ... (更多操作) 图标。
选择 从 VSIX 安装... (Install from VSIX...) 并选择下载的安装包。
发布到 Marketplace 时,打包内的文件和目录名统一使用 ASCII 字符(如英文、数字和短横线)。部分上传处理会将中文文件名解析成问号,导致不同文件被判定为重复路径。ai-rules/ 文档采用英文文件名,正文仍使用中文;新增文档时需同步维护引用链接。
💡 使用指南 (Usage)
- 在 VS Code 的资源管理器 (Explorer) 中,找到你想要生成子应用工程的目标空文件夹。
- 右键点击该文件夹,选择 在当前文件夹生成 qiankun 子应用 (Vue3+Vite)。
- 在顶部弹出的输入框中,输入你的子应用英文名称(例如:
sub-app-order)。
- 继续输入本地开发端口号(例如:
888)。
- 按下回车键,等待右下角提示“创建成功”后,标准工程即刻呈现在当前目录中。
插件不会再额外创建 appName 外层目录;请选择最终项目目录执行生成。若目标目录已存在同名文件或目录,插件会中止以避免覆盖。
(建议:这里可以放一张使用步骤的演示 GIF 动图)
⚙️ 依赖环境 (Requirements)
要成功运行生成的模板代码,您的本地环境需要满足以下基本要求:
- Node.js: >= 20.19.0 或 >= 22.12.0
- 包管理器: npm / pnpm / yarn 均可
🐛 已知问题 (Known Issues)
目前仅支持单一种类的预设模板生成。未来计划支持在输入框后加入“选择模板类型(如 React/Vue)”的下拉选项。如果您在使用中遇到问题,欢迎在项目的 GitHub 仓库提交 Issue。
📝 发行说明 (Release Notes)
1.0.0
- 🎉 首次发布!
- 实现右键一键生成 qiankun + Vue 3 + Vite 子应用核心功能。
- 加入全局文件递归扫描与
{{APP_NAME}} 动态插值替换能力。
Enjoy coding with micro-frontends! 🚀
| |