SuperAPI AI 工具集

dx-code-analyzer-custom-rule-create

编程与开发

查看项目

更新于 10-15 21:43

技能介绍

用途:当内置规则无法覆盖某类模式时,用本技能为 Code Analyzer 编写自定义规则,例如封禁 System.debug、硬编码 ID、TODO,或对元数据(API 版本、字段描述、危险权限)做治理。

主要能力:支持 Regex 引擎做文本模式匹配,PMD 引擎用 XPath 查询 Apex AST 或元数据 XML,ESLint 用于 LWC/JavaScript/TypeScript。可覆盖内置规则阈值、把多条规则组织成共享规则集,并迭代修正不匹配的规则。

使用方式:先明确要捕获的模式、例外、文件范围与严重级别。写 XPath 前必须运行 sf code-analyzer ast-dump 读取真实 AST,不得凭记忆写节点名。创建规则必须用脚本:Regex 用 create-regex-rule.js,PMD 用 create-pmd-rule.js,不要手改 code-analyzer.yml。--regex 必须为 /pattern/flags 且无空格,g 标志必填。创建后用 sf code-analyzer rules --rule-selector <engine>:<name> 校验,再对正负样本各跑一次 sf code-analyzer run 确认命中与零误报。规则需逐条创建,完成一条再下一条。

适用场景:团队专属静态分析标准、封禁特定代码模式、Apex 结构检测(如循环内 SOQL)、元数据治理、LWC/JS 自定义 ESLint 插件。

限制:JS/LWC/TS 必须用 ESLint,不能用 Regex。Regex 排除测试类需用 ignores.files(全局生效),regex_ignore 仅按行过滤。PMD 可用 XPath 结构排除测试类。ESLint 应先查内置与可配置规则再建插件。样本文件测试后需删除。具体安装与依赖细节资料未提供。