前端 H5 代码审查规范
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_6519e987/h5-code-review。
技能介绍
解决什么问题
前端 H5 代码审查常缺少统一尺度:组件结构、TypeScript 类型、样式命名、性能和安全问题散落在不同 PR 评论里,容易把“可读性建议”与“阻止合并缺陷”混在一起。这份技能把审查目标拆成可执行规则,帮助工程师在 Review React/Vue 组件、公共 API、列表渲染、useEffect 依赖、图片懒加载、dangerouslySetInnerHTML、硬编码密钥等常见场景时,有明确判断依据。
技能如何工作
该技能以规范文档和检查清单为核心,包含 GUIDELINES.md、CHECKLIST.md,以及 .eslintrc.json、.prettierrc、stylelint.config.js 等配置参考。使用时可先把代码按类别归类:
- 必查项:
TypeScript类型错误、使用any、XSS 风险、敏感信息硬编码、未处理异常、内存泄漏风险、关键功能缺少测试。 - 建议项:注释与可读性、性能优化机会、
DRY原则、错误处理、测试覆盖率。 - 框架检查点:函数组件与 Hooks、
useMemo/useCallback、列表唯一key、图片 lazy loading、大组件懒加载、API 防抖与缓存。
它也可以作为项目初始化、新人培训或 CI 规则调整的参考,把“0 个 ESLint/TS 错误”“测试覆盖率高于 80%”等指标写成团队目标。
适用边界
它更适合已有 React、Vue、TypeScript 技术栈的 Web 前端团队,不适合作为替代架构评审或业务验收的标准。规范严格度需要根据项目阶段调整,例如内部工具可降低测试覆盖率要求,核心 H5 业务则应保留安全与性能必查项。若项目已有 ESLint、Prettier、Stylelint 配置,应优先沿用既有规则,再逐步引入清单中的检查项。
使用场景
- 在 React 组件 PR 审查中,检查 Hooks 依赖、列表 key、重渲染和 XSS 风险,输出必查项结论。
- 在 Vue 项目代码评审时,对照组件设计、响应式、样式规范和性能建议,标注阻止合并问题。
- 在 H5 新项目初始化阶段,参考 ESLint、Prettier、Stylelint 配置和检查清单建立团队审查基线。
- 在 CI 接入前,梳理 TypeScript 类型错误、安全硬编码、异常处理和测试缺口,形成 PR 检查清单。
适合人员
- 负责 Web 前端 PR Review 的工程师,需要快速区分必查缺陷和可延后优化项。
- 维护 React/Vue 组件库的前端负责人,需要把类型、性能和安全规则沉淀成团队检查标准。
- 参与 H5 项目初始化的开发或技术负责人,需要为 ESLint、Prettier 和评审流程设定基线。
- 准备前端新人培训的技术导师,需要用检查清单讲解组件、TypeScript 与常见安全问题。