SuperAPI AI 工具集

naming-conventions

通用与其它

查看项目

更新于 10-16 08:08

技能介绍

用途:系统性地修复代码中的变量命名问题,包括未使用变量、单字母名称和非标准缩写,让名称可搜索、自解释并保持一致。

主要能力:按优先级处理三类问题——未使用变量(P2)、单字母变量名(P3)、非标准缩写(P3);提供检测方式、修复策略与决策指引。例如未使用变量可用下划线前缀(如 error: _error)或从解构中省略;单字母可用描述性名称替换,数组方法用 user、item、order 等;非标准缩写应展开(如 cwd 改为 currentWorkingDirectory、cfg 改为 config、req/res 等按框架约定可保留)。另有未使用 rest 解构的修复方式,以及布尔量加 is/has/can 前缀、函数用动词前缀、集合用复数、避免冗余上下文等命名最佳实践。

使用方式:按“识别问题→判断变量是否必需→应用重命名/删除/前缀→验证无回归”的流程操作;可运行 node scripts/check-naming.js /path/to/src 检查命名问题,或 node scripts/find-short-names.js /path/to/file.ts 查找单字母变量;通过 ESLint 的 @typescript-eslint/no-unused-vars 与 @typescript-eslint/naming-convention 规则进行约束。

适用场景:TypeScript/JavaScript 代码库的重构与代码质量整治,尤其是出现 no-unused-vars 报错或命名不一致时。

限制:资料未说明该技能的安装命令、费用、支持平台与具体生效方式;命名规则示例仅为配置片段,实际项目需按需调整。