SuperAPI AI 工具集

coding-standards

编程与开发

查看项目

更新于 10-15 21:08

技能介绍

用途:提供跨项目通用的基础编码约定,作为团队共享的编码底线,而非具体框架的详细手册。适用于新项目或模块启动、代码质量与可维护性审查、按约定重构、统一命名与格式、配置 lint/格式化/类型检查规则,以及新成员熟悉编码规范。

主要能力:强调可读性优先、KISS、DRY、YAGNI;给出 TypeScript/JavaScript 的变量与函数命名示例(描述性命名、动词-名词模式);不可变默认(用展开运算符而非直接修改对象或数组);错误处理与 async/await 最佳实践(如用 Promise.all 并行);类型安全(避免 any);React 组件结构、自定义 Hook、状态更新与条件渲染;REST API 约定与统一响应格式、Zod 输入校验;文件组织与命名;注释与 JSDoc;性能实践(useMemo、useCallback、懒加载、只查询所需列);测试的 AAA 结构与命名;以及代码坏味道识别(长函数、深层嵌套、魔法数字)。

使用方式:作为技能在相关任务中激活,用于审查或编写代码时对照约定。需要最短可复用规则层时,可改用 rules/common/coding-style.md。

适用场景:通用代码质量把关、规范落地与团队协作。

限制:不用于 React 组合、hooks 或渲染模式,不用于后端架构、API 设计与数据库分层,也不用于已有更窄 ECC 技能覆盖的领域框架指导。具体安装命令与收费信息暂未提供。