SuperAPI AI 工具集

coding-standards

编程与开发

查看项目

更新于 10-15 20:35

技能介绍

用途:为 TypeScript、JavaScript、React 和 Node.js 开发提供一套通用编码规范、最佳实践与模式,用于约束代码质量并支撑重构与协作。

主要能力: 一、代码质量原则:可读性优先、KISS、DRY、YAGNI。 二、TS/JS 规范:变量与函数命名(动词-名词)、不可变模式(优先展开运算符,禁止直接修改对象与数组)、错误处理(含响应状态校验)、async/await(可并行时用 Promise.all)、类型安全(避免 any)。 三、React 实践:带类型的函数组件、自定义 Hook、基于前值更新状态、条件渲染避免三元嵌套。 四、API 设计:REST 路由约定(GET/POST/PUT/PATCH/DELETE 及过滤查询参数)、统一响应结构、使用 zod 做输入校验。 五、文件组织:给出 src 目录结构,以及组件 PascalCase、Hook 与工具 camelCase、类型 .types 后缀的命名约定。 六、注释与文档:注释解释为什么而非是什么,公开 API 使用 JSDoc。 七、性能:useMemo/useCallback 记忆化、lazy 与 Suspense 懒加载、数据库仅选择所需列。 八、测试:AAA 结构与描述性测试名;并列出长函数、深层嵌套、魔法数字等代码坏味道。

使用方式:作为开发参考规范或技能指引,在编写与评审 TypeScript、JavaScript、React、Node.js 代码时对照执行;文中示例为示范性代码片段,具体项目中的落地方式与工具链配置暂未提供。

适用场景:前端 React 应用与 Node.js 后端服务开发、API 设计、代码评审与重构、单元测试编写。

限制:资料未提供安装命令、版本依赖、许可、收费与平台信息,暂未提供。