用途:审计组件库的公共 API 表面,检查 prop 命名一致性、类型覆盖率、默认值模式、破坏性变更以及与设计到代码契约的符合度。把组件 API 当作基础设施对待。
主要能力:跨库一致性检查(同一概念的不同命名如 variant/type/appearance、布尔默认模式、默认值、类型覆盖、事件处理器命名、组合模式如 ref 转发、children/slots);破坏性变更检测(对比发布版本类型声明,识别移除/重命名/类型收窄/默认值变更/新增必填项);设计到代码契约对齐(仅在设计源可达时,检查 prop 覆盖、状态覆盖、令牌对齐、无障碍属性);输出验证报告,含 API 清单、一致性表格、变更分析、问题汇总(按严重级)和修复建议。
使用方式:先确认 frontmatter 中引用的路径存在,否则停止并要求重新安装。读取 package.json、入口、tsconfig 或类型方式;使用 react-docgen-typescript、vue-component-meta、Custom Elements Manifest 等工具提取 prop,手工解析仅在无工具时。可按配置读取 system.framework、system.styling 及 integrations.github/storybook/figma,支持自动拉取。可选提供上一版本源码用于对比。
适用场景:组件库维护者或设计系统团队系统性审查 API 表面。
限制:不用于决定 semver 版本升级或单组件设计规范核查;无设计源时跳过设计契约对齐;不检查运行时行为;无法从描述推断设计变体;资料中未提供具体安装命令、收费与平台信息。