mcpField
V
vercel-react-best-practices

vercel-react-best-practices

github.com/vercel-labs开发8118 次安装38 周前更新
代码仓库

关于 vercel-react-best-practices

面向编写、审查或优化 React 与 Next.js 应用的开发者,提供按影响优先级组织的性能规则。内容覆盖 8 类优化,并可按规则或完整指南查阅示例。

主要功能

  1. 0157 条性能规则
  2. 02按优先级划分的 8 类主题
  3. 03涵盖异步与代码包优化
  4. 04包含服务端和客户端数据获取建议
  5. 05支持按规则查阅示例

适用场景

  1. 01审查 React 代码的性能问题
  2. 02优化 Next.js 数据获取
  3. 03减少应用代码包体积

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/vercel-labs/cursor-plugin --skill vercel-react-best-practices

安装后在 Claude Code 中输入/vercel-react-best-practices确认已加载。

详细介绍

Vercel React 最佳实践

面向 React 和 Next.js 应用的全面性能优化指南,由 Vercel Engineering 维护。指南包含 8 个类别中的 57 条规则,并按影响程度排序,用于指导自动化重构和代码生成。

加载完整指南

包含所有代码示例的完整规则文档位于:

https://raw.githubusercontent.com/vercel-labs/agent-skills/main/skills/react-best-practices/AGENTS.md

需要详细了解规则时,请使用网页抓取工具从上述 URL 获取完整文档。该文档约 80 KB,包含全部 57 条规则的错误和正确代码示例。

如需查看单条规则,请获取:

https://raw.githubusercontent.com/vercel-labs/agent-skills/main/skills/react-best-practices/rules/{rule-name}.md

适用场景

在以下情况下,请参考这些指南:

  • 编写新的 React 组件或 Next.js 页面
  • 实现数据获取(客户端或服务器端)
  • 检查代码中的性能问题
  • 重构现有 React/Next.js 代码
  • 优化打包体积或加载时间

按优先级划分的规则类别

优先级类别影响前缀
1消除瀑布式等待CRITICALasync-
2优化打包体积CRITICALbundle-
3服务器端性能HIGHserver-
4客户端数据获取MEDIUM-HIGHclient-
5优化重新渲染MEDIUMrerender-
6渲染性能MEDIUMrendering-
7JavaScript 性能LOW-MEDIUMjs-
8高级模式LOWadvanced-

快速参考

1. 消除瀑布式等待(CRITICAL)
  • async-defer-await — 将 await 移到实际使用它的分支中
  • async-parallel — 使用 Promise.all() 执行相互独立的操作
  • async-dependencies — 使用 better-all 处理部分依赖
  • async-api-routes — 在 API 路由中尽早启动 Promise,延后 await
  • async-suspense-boundaries — 使用 Suspense 流式传输内容
2. 优化打包体积(CRITICAL)
  • bundle-barrel-imports — 直接导入,避免使用汇总文件
  • bundle-dynamic-imports — 对较大的组件使用 next/dynamic
  • bundle-defer-third-party — 在 hydration 后加载分析和日志记录工具
  • bundle-conditional — 仅在功能启用时加载模块
  • bundle-preload — 在悬停或聚焦时预加载,提升感知速度
3. 服务器端性能(HIGH)
  • server-auth-actions — 像 API 路由一样验证服务器操作
  • server-cache-react — 使用 React.cache() 在每个请求内去重
  • server-cache-lru — 使用 LRU 缓存实现跨请求缓存
  • server-dedup-props — 避免在 RSC props 中重复序列化
  • server-serialization — 尽量减少传递给客户端组件的数据
  • server-parallel-fetching — 重构组件以并行获取数据
  • server-after-nonblocking — 使用 after() 执行非阻塞操作
4. 客户端数据获取(MEDIUM-HIGH)
  • client-swr-dedup — 使用 SWR 自动去重请求
  • client-event-listeners — 对全局事件监听器去重
  • client-passive-event-listeners — 为滚动事件使用被动监听器
  • client-localstorage-schema — 对 localStorage 数据进行版本管理并尽量精简
5. 优化重新渲染(MEDIUM)
  • rerender-defer-reads — 不要订阅仅在回调中使用的状态
  • rerender-memo — 将开销较大的操作提取到记忆化组件中
  • rerender-memo-with-default-value — 将默认的非基本类型 props 提取到组件外部
  • rerender-dependencies — 在 effects 中使用基本类型依赖项
  • rerender-derived-state — 订阅派生布尔值,而不是原始值
  • rerender-derived-state-no-effect — 在渲染期间派生状态,而不是在 effects 中
  • rerender-functional-setstate — 使用函数式 setState 创建稳定的回调
  • rerender-lazy-state-init — 将函数传给 useState,以初始化开销较大的值
  • rerender-simple-expression-in-memo — 简单的基本类型值无需使用 memo
  • rerender-move-effect-to-event — 将交互逻辑放入事件处理器中
  • rerender-transitions — 使用 startTransition 处理非紧急更新
  • rerender-use-ref-transient-values — 使用 ref 保存频繁变化的临时值
6. 渲染性能(中)
  • rendering-animate-svg-wrapper — 为 div 包装元素添加动画,而不是 SVG 元素
  • rendering-content-visibility — 对长列表使用 content-visibility
  • rendering-hoist-jsx — 将静态 JSX 提取到组件外部
  • rendering-svg-precision — 降低 SVG 坐标精度
  • rendering-hydration-no-flicker — 使用内联脚本处理仅客户端数据
  • rendering-hydration-suppress-warning — 忽略预期中的不匹配
  • rendering-activity — 使用 Activity 组件控制显示和隐藏
  • rendering-conditional-render — 条件渲染使用三元运算符,而不是 &&
  • rendering-usetransition-loading — 加载状态优先使用 useTransition
7. JavaScript 性能(低至中)
  • js-batch-dom-css — 通过类或 cssText 批量修改 CSS
  • js-index-maps — 为重复查找构建 Map
  • js-cache-property-access — 在循环中缓存对象属性
  • js-cache-function-results — 在模块级 Map 中缓存函数结果
  • js-cache-storage — 缓存 localStorage/sessionStorage 的读取结果
  • js-combine-iterations — 将多个 filter/map 合并为一个循环
  • js-length-check-first — 在进行耗时比较前检查数组长度
  • js-early-exit — 尽早从函数中返回
  • js-hoist-regexp — 将 RegExp 创建移到循环外
  • js-min-max-loop — 使用循环查找最小值/最大值,而不是排序
  • js-set-map-lookups — 使用 Set/Map 实现 O(1) 查找
  • js-tosorted-immutable — 使用 toSorted() 保持不可变性
8. 高级模式(低)
  • advanced-event-handler-refs — 将事件处理函数存储在 ref 中
  • advanced-init-once — 每次应用加载时只初始化一次应用
  • advanced-use-latest — 使用 useLatest 获取稳定的回调 ref

使用方法

当用户询问 React/Next.js 性能相关问题,或编写/审查 React 代码时:

  1. 从上面的优先级表中确定相关类别
  2. 从 GitHub 获取具体规则,查看详细指导:
    https://raw.githubusercontent.com/vercel-labs/agent-skills/main/skills/react-best-practices/rules/{rule-name}.md
    
  3. 或获取完整指南,进行全面审查:
    https://raw.githubusercontent.com/vercel-labs/agent-skills/main/skills/react-best-practices/AGENTS.md
    
  4. 应用规则中的正确模式,并说明其重要性

每个规则文件都包含:

  • 简要说明其重要性
  • 错误代码示例及说明
  • 正确代码示例及说明
  • 补充背景信息和参考资料

来源

由 Vercel Engineering 维护,地址为 github.com/vercel-labs/agent-skills。

评论

支持 Markdown