用途:这是一套 React 组件组合模式(Composition Patterns)指南,帮助构建灵活、可维护的 React 组件,避免通过大量布尔属性(boolean prop)来定制行为,从而让代码库在规模扩大时更便于人和 AI 智能体协作。
适用时机:重构含大量布尔属性的组件、构建可复用组件库、设计灵活的组件 API、审查组件架构,以及使用复合组件(compound components)或 context provider 时。
规则分类(按优先级):
- 组件架构(HIGH,前缀 architecture-):architecture-avoid-boolean-props 建议不要用布尔属性定制行为而改用组合;architecture-compound-components 用共享 context 组织复杂组件。
- 状态管理(MEDIUM,前缀 state-):state-decouple-implementation 让 Provider 成为唯一知晓状态管理方式的地方;state-context-interface 定义含 state、actions、meta 的通用接口以支持依赖注入;state-lift-state 将状态上移到 provider 组件以便兄弟组件访问。
- 实现模式(MEDIUM,前缀 patterns-):patterns-explicit-variants 用显式变体组件替代布尔模式;patterns-children-over-render-props 用 children 组合替代 renderX 属性。
- React 19 API(MEDIUM,前缀 react19-):react19-no-forwardref 建议不使用 forwardRef,并用 use() 替代 useContext()。注意此节仅适用于 React 19 及以上,React 18 或更早版本请跳过。
使用方式:阅读各规则文件获取详细说明与代码示例,例如 rules/architecture-avoid-boolean-props.md、rules/state-context-interface.md。每个规则文件包含:为何重要的简要说明、带解释的错误代码示例、带解释的正确代码示例,以及补充背景与参考。完整指南见 AGENTS.md。
限制:资料未提供安装命令、收费信息、支持平台或具体版本兼容细节;React 19 相关规则不适用于 React 18 及更早版本。