SuperAPI AI 工具集

coding-standards

编程与开发

查看项目

更新于 10-15 20:35

技能介绍

用途:为 TypeScript、JavaScript、React 和 Node.js 项目提供统一的编码规范、最佳实践与模式,帮助团队写出可读、可维护、可重构的代码。

主要能力:

  • 代码质量原则:可读性优先、KISS、DRY、YAGNI。
  • 命名规范:变量用描述性名称,函数用动词-名词模式。
  • 不可变模式:始终用展开运算符更新对象与数组,禁止直接修改。
  • 错误处理:检查 response.ok,捕获并重新抛出带上下文的错误。
  • 异步实践:无依赖时用 Promise.all 并行执行。
  • 类型安全:定义接口与联合类型,避免 any。
  • React:带类型的函数组件、自定义 Hooks(如 useDebounce)、函数式状态更新、清晰的条件渲染。
  • API 设计:REST 约定、统一响应结构、用 zod 做输入校验。
  • 文件组织:给出 src 目录结构示例与文件命名约定。
  • 注释与 JSDoc:解释为什么而非是什么,公共 API 写 JSDoc。
  • 性能:useMemo、useCallback、lazy 与 Suspense、只查询所需列。
  • 测试:AAA 结构、描述性测试名。
  • 代码坏味道:长函数、深层嵌套、魔法数字。

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

适用场景:TypeScript/JavaScript/React/Node.js 项目的编码、评审与重构。

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