create-szyy-app
v1.0.5
Published
脚手架:一键创建微前端子应用
Readme
create-szyy-app
微前端子应用脚手架 CLI,一键从 sunyard-szyy-app-template 生成可开发、可联调基座的新项目。
使用
# 交互式创建
npx create-szyy-app my-order-sys
# 非交互
npx create-szyy-app my-order-sys --yes --port 5690
# 精简模式(不保留 Demo 页)
npx create-szyy-app my-order-sys --yes --minimal选项
| 选项 | 说明 |
| ---------------------- | ---------------------------------------------------- |
| [project-name] | 项目名称(kebab-case,小写字母开头) |
| -p, --port <port> | 联调端口,写入 .env / .env.micro 等(默认 5690) |
| --template-tag <tag> | 覆盖模板 Git tag |
| --minimal | 删除 templateSys Demo,仅保留首页菜单 |
| -y, --yes | 跳过交互,使用默认值 |
注意:
pnpm dev独立模式端口固定 3000(.env.development),不受--port影响。pnpm dev:micro使用--port配置的联调端口。
生成后
cd my-order-sys
pnpm install
pnpm dev # 独立模式,端口 3000
pnpm dev:micro # 基座联调
pnpm build:prod # 生产构建环境变量
| 变量 | 说明 |
| -------------------- | --------------------------------------------------------------------------------- |
| SZYY_TEMPLATE_REPO | 覆盖模板 Git 仓库 URL(默认 http://172.1.1.65/RDKit/sunyard-szyy-app-template) |
| SZYY_TEMPLATE_PATH | 使用本地目录作为模板(开发/联调 CLI 时使用) |
| SZYY_TEMPLATE_TAG | 覆盖模板 Git tag |
| SZYY_VERSIONS_URL | 覆盖远程版本配置 URL(默认从模板仓 create-app 分支拉取 versions.json) |
| SZYY_VERSIONS_PATH | 使用本地 versions.json(开发/联调 CLI 时使用) |
版本锁定
版本配置默认从模板仓 create-app 分支 拉取 versions.json(内网 Git 走 git clone,公网 GitLab 等先尝试 Raw URL);拉取失败时使用 npm 包内置配置兜底。更新模板 tag 或依赖版本时,只需修改模板仓 create-app 分支上的 versions.json,无需重新发布 CLI。
生成项目的 package.json 会写死精确版本号(无 ^)。
开发 CLI
pnpm install
pnpm build
# 使用本地模板联调
SZYY_TEMPLATE_PATH=../sunyard-szyy-app-template SZYY_VERSIONS_PATH=../sunyard-szyy-app-template/versions.json node dist/index.js test-app --yes发布
# 日常检查
pnpm check
# 发版(自动生成 CHANGELOG 并 bump 版本)
pnpm release:patch # 或 release:minor / release:major
# 发布前全量门禁
pnpm check:release
# 发布到 npm(默认 registry 可通过 NPM_REGISTRY 覆盖)
pnpm publish:pkg:dry # 预演
pnpm publish:pkg # 正式发布
pnpm publish:pkg --tag=beta故障排查
| 问题 | 处理 |
| ---------------- | ------------------------------------------------------------------------------------------ |
| degit 拉取失败 | 检查内网 Git 连通性,或设置 SZYY_TEMPLATE_PATH 使用本地模板 |
| 占位符残留报错 | 确认模板 tag 与远程/本地 versions.json 中 template 版本一致 |
| 版本配置拉取失败 | 确认模板仓 create-app 分支存在 versions.json 且本机 Git 已登录;CLI 会自动回退内置配置 |
| 联调端口冲突 | 创建时指定 --port,或修改生成项目 .env.micro |
延伸阅读
- 模板仓 README:
sunyard-szyy-app-template(create-app分支) - 团队接入指南:platform
docs/guide/create-app.md - SDK / 基座对接:运营 AI 底座开发平台
