关于 beforemerge-react-review
beforemerge-react-review 是面向 React 应用开发者的代码审查规则库,适用于审查或编写 React 和 TypeScript 代码。规则涵盖安全、性能、架构和代码质量,并按影响程度排序,附有示例。
主要功能
- 01映射至 CWE 的安全规则
- 02运行时渲染性能指导
- 03架构与代码组织模式
- 04可维护性与代码健康检查
- 05错误及修正代码示例
适用场景
- 01审查 React/TypeScript 拉取请求
- 02检查组件中的安全问题
- 03重构时检查性能
- 04合并前执行质量检查
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ beforemerge/ beforemerge-skills --skill beforemerge-react-review安装后在 Claude Code 中输入/beforemerge-react-review确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
AGENTS.mdmetadata.jsonREADME.mdrules/_sections.md_template.mdrules/architecture/arch-component-composition.mdarch-custom-hooks.mdarch-prop-drilling.mdarch-state-colocation.mdrules/performance/perf-context-splitting.mdperf-expensive-computations.mdperf-large-lists.mdperf-unnecessary-rerenders.mdrules/quality/qual-controlled-vs-uncontrolled.mdqual-error-boundaries.mdqual-key-prop.mdqual-useeffect-cleanup.mdrules/security/sec-dangerouslysetinnerhtml.mdsec-eval-injection.mdsec-insecure-randomness.mdsec-prototype-pollution.md详细介绍
BeforeMerge:React Review
面向 React 应用的全面代码审查知识库(与框架无关)。包含 4 个类别的规则——安全、性能、架构和质量,并按影响排序。
适用场景
在以下场景中参考这些规则:
- 审查 React/TypeScript 项目的拉取请求
- 编写新组件、钩子或实用工具
- 审查现有代码,查找安全漏洞
- 重构代码以提升性能或可维护性
- 执行合并前质量检查
按优先级划分的规则类别
| 优先级 | 类别 | 影响 | 前缀 | 重点 |
|---|---|---|---|---|
| 1 | 安全 | 严重 | sec- | 映射到 CWE 的反模式 |
| 2 | 性能 | 高 | perf- | 运行时渲染优化 |
| 3 | 架构 | 中 | arch- | 设计模式和代码组织 |
| 4 | 质量 | 中 | qual- | 可维护性和代码健康度 |
使用方法
阅读 rules/ 中的单条规则文件,了解详细说明和代码示例。
每条规则都包含:
- 简要说明其重要性
- 错误代码示例及说明
- 正确代码示例及说明
- 适用时提供 CWE 映射
- 官方文档参考
完整的汇编指南:AGENTS.md
评论
支持 Markdown