SuperAPI AI 工具集

react-design-principles

编程与开发

查看项目

更新于 10-16 07:15

技能介绍

用途:用于 React 高层 API 决策,例如是否该提取抽象、某个 API 是否足够声明式、某个 helper 是否在对抗 React 的模型。若任务落到具体自定义 Hook 的实现或评审,建议搭配 react-hook-writing 或 react-hook-review 使用。

主要能力与原则:

  1. 优先声明式接口。React 最适合描述期望状态而非编排步骤的 API;优先能消除组件中重复的 state 与 effect 协调的抽象。若使用者每次都要手动串联多个 state、handler 和 effect,说明抽象层级偏低;API 应读起来像意图而非流程。
  2. 尊重 React 生命周期。不要引入对抗 React 生命周期模型的抽象;除非有具体的外部同步需求,避免 useMount、useEffectOnce、useLifecycles 等生命周期包装 helper;优先 useWindowSize、useOnlineStatus 这类有明确用途的抽象;与浏览器或网络状态同步时,保持 setup 与 cleanup 显式。
  3. 保持 API 面小。React 已提供最小原语,额外抽象应保持可组合、轻量;优先小 API 面而非功能堆砌的 helper;除非能消除大量复杂度,避免运行时依赖;注入外部客户端或 fetcher,而不是在抽象内部硬耦合。
  4. 为可靠性而设计。好的抽象在 SSR 下可预测、可独立测试、类型层面清晰;共享 Hook 与依赖浏览器的逻辑优先采用 SSR 安全初始化;使用 TypeScript 泛型并避免 any;用 JSDoc 记录公开 API;把 cleanup、测试与边界情况视为 API 设计的一部分。
  5. 零依赖倾向。依赖会带来包体积、版本压力与替换成本;只有在收益大于引入成本时才使用依赖;共享 React 包优先用 peerDependencies 而非运行时依赖;尽可能注入外部客户端而非在 Hook 内 import;让抽象可跨项目与环境移植。

使用方式:在最终确定抽象前,用其评审问题自检:抽象是让组件更声明式,还是只是隐藏命令式代码?是否尊重 React 既有生命周期而非重新造一套?API 是否最小、有类型、易扩展?脱离项目专属 helper 后抽象是否仍成立?是否避免了不必要的运行时依赖?详细理由见其 principles.md。

适用场景:React 组件库或共享包的 API 设计、抽象层评审与取舍、Hook 设计方向判断。

限制:资料未提供安装命令、平台支持、收费与价格信息,暂未提供。