2026-08-04 15:41:38 +08:00
|
|
|
# 应用内 Shared Package Instructions
|
2026-07-30 21:04:28 +08:00
|
|
|
|
|
|
|
|
## 项目定位
|
|
|
|
|
|
2026-08-04 15:41:38 +08:00
|
|
|
- 本包只服务当前前端应用,提供多个业务模块共同使用的 TypeScript 类型、常量和轻量工具。
|
|
|
|
|
- 依赖保持为 `@chongchong/shared: link:./shared`,确保当前应用目录可作为独立容器构建上下文。
|
|
|
|
|
- 不承担 Admin、Client 之间的源码复用;跨应用字段需要分别映射同一份 Java Controller/OpenAPI 契约,不能通过目录外链接耦合两个部署单元。
|
2026-07-30 21:04:28 +08:00
|
|
|
|
|
|
|
|
## 公共 API 与依赖边界
|
|
|
|
|
|
2026-08-04 15:41:38 +08:00
|
|
|
- `src/index.ts` 是当前唯一公共入口;模块专属页面状态、UI 组件和临时业务逻辑留在对应模块。
|
|
|
|
|
- 共享类型保持前端平台无关,不编码鉴权结论;租户隔离、权限、状态机和数据合法性由 `baiyue-firstleg` Java 服务端最终保证。
|
|
|
|
|
- 服务端字段变化先核对 Controller、DTO 和 OpenAPI,再更新本应用的类型、API 适配层和测试;本包不反向定义服务端行为。
|
|
|
|
|
- 避免建立宽泛的万能类型或引入重量级依赖。
|
2026-07-30 21:04:28 +08:00
|
|
|
|
2026-08-04 15:41:38 +08:00
|
|
|
## 兼容性与验证
|
2026-07-30 21:04:28 +08:00
|
|
|
|
2026-08-04 15:41:38 +08:00
|
|
|
- 修改导出名称、字段类型、枚举值或常量语义前,搜索当前应用内全部消费者。
|
|
|
|
|
- 优先采用兼容性新增;破坏性修改必须同步更新当前应用消费者。
|
|
|
|
|
- 本包没有独立质量脚本;变更后运行父应用声明的类型检查、测试或构建命令。
|