关于 vercel-react-best-practices
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ vercel-labs/ agent-skills --skill vercel-react-best-practices安装后在 Claude Code 中输入/vercel-react-best-practices确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
AGENTS.mdmetadata.jsonREADME.mdrules/_sections.md_template.mdadvanced-effect-event-deps.mdadvanced-event-handler-refs.mdadvanced-init-once.mdadvanced-use-latest.mdasync-api-routes.mdasync-cheap-condition-before-await.mdasync-defer-await.mdasync-dependencies.mdasync-parallel.mdasync-suspense-boundaries.mdbundle-analyzable-paths.mdbundle-barrel-imports.mdbundle-conditional.mdbundle-defer-third-party.mdbundle-dynamic-imports.mdbundle-preload.mdclient-event-listeners.mdclient-localstorage-schema.mdclient-passive-event-listeners.mdclient-swr-dedup.mdjs-batch-dom-css.mdjs-cache-function-results.mdjs-cache-property-access.mdjs-cache-storage.mdjs-combine-iterations.md详细介绍
Vercel React 最佳实践
由 Vercel 维护的 React 和 Next.js 应用全面性能优化指南。包含 8 个类别的 70 条规则,并按影响程度排序,旨在指导自动重构和代码生成。
何时应用
在以下情况下参考这些指南:
- 编写新的 React 组件或 Next.js 页面
- 实现数据获取(客户端或服务端)
- 检查代码中的性能问题
- 重构现有的 React/Next.js 代码
- 优化打包体积或加载时间
按优先级划分的规则类别
| 优先级 | 类别 | 影响 | 前缀 |
|---|---|---|---|
| 1 | 消除瀑布流 | CRITICAL | async- |
| 2 | 打包体积优化 | CRITICAL | bundle- |
| 3 | 服务端性能 | HIGH | server- |
| 4 | 客户端数据获取 | MEDIUM-HIGH | client- |
| 5 | 重新渲染优化 | MEDIUM | rerender- |
| 6 | 渲染性能 | MEDIUM | rendering- |
| 7 | JavaScript 性能 | LOW-MEDIUM | js- |
| 8 | 高级模式 | LOW | advanced- |
快速参考
1. 消除瀑布流(CRITICAL)
async-cheap-condition-before-await- 等待标志或远程值之前,先检查成本低的同步条件async-defer-await- 将 await 移入实际使用它的分支async-parallel- 使用 Promise.all() 并行执行独立操作async-dependencies- 使用 better-all 处理部分依赖async-api-routes- 在 API 路由中尽早启动 Promise,延后等待async-suspense-boundaries- 使用 Suspense 流式传输内容
2. 打包体积优化(CRITICAL)
bundle-barrel-imports- 直接导入,避免使用聚合导出文件bundle-analyzable-paths- 优先使用可静态分析的导入路径和文件系统路径,避免生成宽泛的打包内容和追踪记录bundle-dynamic-imports- 对大型组件使用 next/dynamicbundle-defer-third-party- 在水合后加载分析/日志记录工具bundle-conditional- 仅在功能启用时加载模块bundle-preload- 在悬停/聚焦时预加载,提升感知速度
3. 服务端性能(HIGH)
server-auth-actions- 像 API 路由一样验证服务端操作server-cache-react- 使用 React.cache() 对每个请求进行去重server-cache-lru- 使用 LRU 缓存实现跨请求缓存server-dedup-props- 避免在 RSC 属性中重复序列化server-hoist-static-io- 将静态 I/O(字体、徽标)提升到模块级别server-no-shared-module-state- 避免在 RSC/SSR 中使用模块级可变请求状态server-serialization- 尽量减少传递给客户端组件的数据server-parallel-fetching- 重构组件以实现并行获取server-parallel-nested-fetching- 在 Promise.all 中按项串联嵌套获取server-after-nonblocking- 使用 after() 执行非阻塞操作
4. 客户端数据获取(MEDIUM-HIGH)
client-swr-dedup- 使用 SWR 自动去重请求client-event-listeners- 对全局事件监听器进行去重client-passive-event-listeners- 为滚动事件使用被动监听器client-localstorage-schema- 对 localStorage 数据进行版本管理并尽量精简
5. 重新渲染优化(中)
rerender-defer-reads- 不要订阅仅在回调中使用的状态rerender-memo- 将开销较大的工作提取到经过记忆化的组件中rerender-memo-with-default-value- 将默认的非原始类型属性提取到组件外rerender-dependencies- 在 effect 中使用原始类型依赖项rerender-derived-state- 订阅派生的布尔值,而不是原始值rerender-derived-state-no-effect- 在渲染期间派生状态,而不是在 effect 中rerender-functional-setstate- 使用函数式 setState 来保持回调稳定rerender-lazy-state-init- 对开销较大的值,将函数传给 useStatererender-simple-expression-in-memo- 对简单的原始类型值避免使用 memorerender-split-combined-hooks- 拆分依赖项彼此独立的 hooksrerender-move-effect-to-event- 将交互逻辑放在事件处理程序中rerender-transitions- 对非紧急更新使用 startTransitionrerender-use-deferred-value- 延迟开销较大的渲染,以保持输入响应灵敏rerender-use-ref-transient-values- 对频繁变化的临时值使用 refrerender-no-inline-components- 不要在组件内部定义组件
6. 渲染性能(中)
rendering-animate-svg-wrapper- 为 div 包装元素添加动画,而不是 SVG 元素rendering-content-visibility- 对长列表使用 content-visibilityrendering-hoist-jsx- 将静态 JSX 提取到组件外rendering-svg-precision- 降低 SVG 坐标精度rendering-hydration-no-flicker- 使用内联脚本处理仅限客户端的数据rendering-hydration-suppress-warning- 忽略预期的不匹配rendering-activity- 使用 Activity 组件控制显示和隐藏rendering-conditional-render- 条件渲染使用三元运算符,而不是 &&rendering-usetransition-loading- 加载状态优先使用 useTransitionrendering-resource-hints- 使用 React DOM 资源提示进行预加载rendering-script-defer-async- 在 script 标签上使用 defer 或 async
7. JavaScript 性能(低至中)
js-batch-dom-css- 通过类或 cssText 批量修改 CSSjs-index-maps- 为重复查找构建 Mapjs-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() 保持不可变性js-flatmap-filter- 使用 flatMap 一次完成映射和筛选js-request-idle-callback- 将非关键工作推迟到浏览器空闲时执行
8. 高级模式(低)
advanced-effect-event-deps- 不要将useEffectEvent的结果放入 effect 依赖项advanced-event-handler-refs- 将事件处理程序存储在 ref 中advanced-init-once- 每次应用加载时仅初始化应用一次advanced-use-latest- 使用 useLatest 获得稳定的回调 ref
如何使用
阅读各规则文件,了解详细说明和代码示例:
rules/async-parallel.md
rules/bundle-barrel-imports.md
每个规则文件都包含:
- 简要说明该规则的重要性
- 错误代码示例及其说明
- 正确代码示例及其说明
- 补充背景信息和参考资料
完整汇编文档
如需查看包含所有规则完整说明的指南,请参阅:AGENTS.md
评论
支持 Markdown