SuperAPI AI 工具集

coding-standards

编程与开发

查看项目

更新于 10-16 07:25

技能介绍

用途:为 TypeScript、JavaScript、React 和 Node.js 项目提供跨项目通用的编码规范与最佳实践,帮助保持代码可读、可维护、可重构。

主要能力:

  1. 代码质量原则:可读性优先、KISS、DRY、YAGNI。
  2. 命名规范:变量使用描述性名称,函数采用动词-名词模式。
  3. 不可变模式:使用展开运算符更新对象与数组,避免直接修改。
  4. 错误处理与异步:完整 try/catch、检查 response.ok,能用 Promise.all 时并行执行。
  5. 类型安全:定义 interface 与联合类型,避免 any。
  6. React 实践:带类型的函数组件、自定义 Hook(如 useDebounce)、函数式状态更新、清晰的条件渲染。
  7. API 设计:REST 路由约定、统一响应结构、使用 zod 做输入校验。
  8. 文件组织与命名:src 目录结构、组件 PascalCase、Hook 以 use 前缀 camelCase。
  9. 注释与 JSDoc:解释为什么而非是什么,公共 API 写 JSDoc。
  10. 性能:useMemo、useCallback、lazy 与 Suspense、只查询所需列。
  11. 测试:AAA 结构、描述性测试名。
  12. 代码坏味道:过长函数、深层嵌套、魔法数字。

使用方式:资料未提供安装命令或调用方式,暂未提供。

适用场景:团队统一前端与 Node.js 代码风格、代码评审、重构与新人上手。

限制:资料未说明支持平台、收费、价格或效果,暂未提供。