SuperAPI AI 工具集

new-rule

通用与其它

查看项目

更新于 10-16 07:57

技能介绍

用途:本技能用于从零实现一条新的 SonarJS 规则,适用于创建新规则、搭建规则文件,或了解完整的规则实现工作流。

主要流程与能力:新规则遵循「RSPEC 描述 → 脚手架 → 实现 → 测试 → ruling」的模式。第一步运行脚手架:npm run new-rule,该交互式脚本会在 packages/analysis/src/jsts/rules/SXXXX/ 下生成 index.ts(规则导出)、rule.ts(ESLint 规则实现骨架)、cb.fixture.js(空的基于注释的测试夹具)、cb.test.js(测试启动器),并自动生成不纳入 git 跟踪的 Java 检查类 SXXXX.java,同时更新 rules/rules.ts、rules/plugin-rules.ts 和 AllRules.java。第二步配置生成的 Java 检查类:核对 @JavaScriptRule 和/或 @TypeScriptRule 注解是否与目标语言匹配;若规则有选项需覆写 configurations() 方法;若规则针对测试文件则应继承 TestFileCheck 而非 Check。第三步实现规则,涉及 rule.ts、meta.ts、config.ts、generated-meta.ts 等文件结构。实现时须保守,不确定时不要报告,漏报优于误报;若缺少类型信息则直接返回不报告。第四步检查共享 helpers(ast.ts、module.ts、package-jsons/dependencies.ts、index.ts 等),新工具若可服务多条规则应加入相应 helper 文件。第五步运行 npm run generate-meta 生成元数据。第六步编写测试,可先写 cb.fixture.js 并用 npx tsx --test packages/analysis/src/jsts/rules/S1234/**/*.test.ts 运行。第七步执行 ruling,新规则或修改规则合并前必须完成。

实现模式:可包装 ESLint 规则(implementation 设为 'decorated',指定 eslintId 与 externalRules)或编写原创规则(implementation 设为 'original')。RSPEC 标签方面,依赖类型信息的规则需打 type-dependent 标签;需要特定导入(如 'react'、'jest')时添加 dependencies 字段;并按需添加 compatibleLanguages。

限制:资料未提供具体收费、价格、平台支持范围及运行环境要求等信息。