用途:这是一套 React 组合模式(Composition Patterns)指南,用于重构和设计组件 API,避免布尔属性泛滥,提升可复用性与可维护性。适合重构含大量布尔属性的组件、构建可复用组件库、设计灵活的组件 API、审查组件架构,以及使用复合组件或 context provider 的场景。
主要能力(按优先级分级):
- 组件架构(HIGH):architecture-avoid-boolean-props 建议不要通过布尔属性定制行为,改用组合;architecture-compound-components 用共享 context 组织复杂组件。
- 状态管理(MEDIUM):state-decouple-implementation 让 provider 成为唯一知晓状态如何管理的地方;state-context-interface 定义包含 state、actions、meta 的通用接口以支持依赖注入;state-lift-state 将状态提升到 provider 组件供兄弟组件访问。
- 实现模式(MEDIUM):patterns-explicit-variants 用显式变体组件替代布尔模式;patterns-children-over-render-props 用 children 组合替代 renderX 属性。
- React 19 API(MEDIUM):react19-no-forwardref 在 React 19 中将 ref 作为 prop 使用,普通 context 读取仍用 useContext();该部分仅适用于 React 19+。
使用方式:查阅各规则文件获取详细说明与代码示例,例如 rules/architecture-avoid-boolean-props.md、rules/state-context-interface.md;每个规则文件包含原因说明、错误代码示例、正确代码示例及补充参考。完整指南见 AGENTS.md。
限制:官方资料未提供安装命令、收费信息、具体平台要求或量化效果;React 19 相关规则仅适用于 React 19 及以上版本,使用 React 18 或更早版本应跳过。以上内容均依据公开资料整理,缺失事实暂未提供。