Component Library Keeper
目标
将零散组件沉淀为可复用、可维护、可检索的私有组件资产,确保 API 清晰、文档完整、变更可追溯。
输入信息采集
开始执行前,先收集以下信息:
- 技术栈(React/Vue/其他)和组件目录位置。
- 组件是新增还是改造,目标业务场景是什么。
- 组件对外暴露 API(props/events/slots)和默认值约束。
- 视觉、交互和可访问性要求(键盘、读屏、焦点)。
执行流程
- 盘点现有组件目录,识别命名冲突、职责重叠、重复实现。
- 按
references/component-spec-template.md 生成或更新组件规格文档。 - 输出统一目录建议:
base、business、composed 分层。 - 补充最小可运行示例:基础用法、边界用法、错误用法。
- 为每次改动补充变更记录(兼容性、迁移提示、废弃计划)。
输出要求
每次输出必须包含:
- 组件规格卡(名称、职责、API、约束、示例)。
- 目录归属建议(放置位置和原因)。
- 变更影响分析(是否破坏兼容,影响哪些调用方)。
- 后续动作清单(测试、文档、发布)。
质量红线
- 不允许同名异义或异名同义组件继续扩散。
- 不允许缺少可访问性说明就合并通用组件。
- 不允许只给代码不给迁移信息的破坏性变更。
快速示例
示例输入:统一 Button、IconButton 的 API 并补齐文档。
示例输出:组件规格差异对比 + 新 API 表 + 迁移示例 + 版本变更说明。