SuperAPI AI 工具集

typescript-naming

编程与开发

查看项目

更新于 10-16 06:48

技能介绍

用途:在当前任务中应用、审查或解释 TypeScript 风格指南的命名约定。会先检查使用方仓库的约定与配置,仓库显式约定优先于本技能的倾向性建议,只应用与任务相关的指导,并在命名依赖上下文或判断时说明权衡。边界:由 ESLint 等工具负责可自动执行的检查,不因技能激活而引入无关约定。\n\n主要约定:使用具名导出(可经 import/no-default-export 强制,例外文件可关闭该规则);局部变量用驼峰,布尔量加 is、has 等前缀;常量全大写;对象与数组常量用单数、全大写并加 const 断言,已有类型时用 as const satisfies 校验。函数用驼峰;类型用帕斯卡;泛型参数以大写 T 加描述性名称,禁止 T、K、U 单字母。缩写按完整单词处理、仅首字母大写,如 FaqList、generateUserUrl;尽量避免非通用缩写。React 组件用帕斯卡,Props 类型为组件名加 Props,回调 prop 用 on*、处理函数用 handle*;Hook 以小写 use 前缀且 useState 保持 [value, setValue] 对称,自定义 Hook 始终返回对象。\n\n注释:优先用表达性命名替代注释,注释主要解释“为什么”或引用 issue、PR、待办;API、库、配置或可复用代码使用 TSDoc 注释。限制:资料未提供安装命令、收费与平台信息,暂未提供。