Skip to content

项目结构 ​

text
kevairy-admin-workspace/
├── apps/
│   ├── components-smoke-test/ # 组件安装、类型和 tree-shaking 消费验证
│   ├── docs/                 # @kevairy/docs,VitePress 文档站
│   └── template/             # @kevairy/admin-template,后台模板
├── packages/
│   ├── components/           # @kevairy/components,业务组件库
│   ├── cli/                  # @kevairy/cli,提供项目创建等命令
│   └── template-package/     # @kevairy/template,独立发布模板
├── package.json              # workspace 统一命令与工程工具
├── pnpm-workspace.yaml       # pnpm workspace 范围
├── pnpm-lock.yaml            # 全仓唯一依赖锁文件
└── vercel.json               # 文档站自动构建与产物目录

Workspace 职责 ​

根目录只管理跨项目工程能力,包括依赖锁定、格式化、Lint、Git hooks 和统一命令。应用自身的运行配置、源码、测试和构建产物留在对应的 apps/* 项目中。

常用命令 ​

命令作用
pnpm dev启动后台模板
pnpm docs:dev启动文档站
pnpm build构建当前所有 workspace 项目
pnpm build:template仅构建后台模板
pnpm docs:build仅构建文档站
pnpm lint检查模板、文档配置和主题代码
pnpm test运行脚手架、组件、消费验证与 E2E
pnpm create:app使用脚手架创建独立项目

自动化职责 ​

  • .github/workflows/ci.yml 在 Pull Request 和 main 分支 push 时运行全仓发布检查;
  • vercel.json 指定文档站安装、构建和产物目录;
  • Vercel Git 集成监听 GitHub push:功能分支生成预览部署,main 生成生产部署。

首次绑定和排查步骤见文档部署。

包命名 ​

品牌展示统一使用 Kevairy。npm package scope 遵循注册表规范使用小写 @kevairy/*。