SuperAPI AI 工具集

helpers

通用与其它

查看项目

更新于 10-16 06:16

技能介绍

用途:为 SonarJS 规则实现提供 JavaScript/TypeScript 通用辅助函数,减少重复代码。

主要能力:按类别分为 AST 工具(遍历与查询语法树)、类型检查(借助 TypeScript parser services)、模块辅助(分析 import/export)、字符串与正则工具。常见函数包括 isCallingMethod()(判断调用表达式是否调用特定方法)、getUniqueWriteUsageOrNode()(跟踪变量赋值)、isRequiredParserServices()(判断类型信息是否可用)、isArray()/isString() 等类型判断,以及 getImportDeclarations()。

使用方式:编写新函数前先搜索 packages/analysis/src/jsts/rules/helpers/ 是否已有等价实现,重点查看 ast.ts(通用 AST 工具)、vue.ts(Vue 专用)、react.ts(React/JSX 专用)。可用 ls packages/analysis/src/jsts/rules/helpers/ 浏览现有辅助函数并阅读实现以了解参数与用法。仅操作 estree/TSESTree 节点、不含规则领域逻辑的新工具应放入 helpers/ast.ts(或对应领域文件),不要埋在单个规则文件里。

限制与约定:评审会拒绝重复实现已有辅助函数。反模式是遍历 Object.keys(node) 枚举子节点,应改用 childrenOf(node)。childrenOf(node) 始终返回 estree.Node[],无需再写自定义类型守卫或 Array.isArray() 检查,否则是死代码。

适用场景:实现或修复 SonarJS 规则、需要复用 AST 与类型分析工具时。其余细节暂未提供。