SuperAPI AI 工具集

guardrail

编程与开发

查看项目

更新于 10-16 03:41

技能介绍

用途:把团队的架构决策固化为可自动执行的 lint 规则,在代码写入时立即发现违规,而非仅靠文档约定。

主要能力:接收自然语言描述、错误代码示例或代码库扫描结果,生成规则实现、规则元数据和测试用例。支持两种引擎:JS/TS 用 ESLint 本地插件(flat config,零 npm 依赖),Python/Go/Rust 等用 ast-grep YAML 规则。两者均支持自动修复。典型场景包括导入边界、API 路径约定、废弃写法拦截、鉴权强制和命名约定。

使用方式:通过 /guardrail 调用,按阶段先解析约束(明确要标记什么、正确写法、例外文件),再按语言选择引擎(未指定时 JS/TS 用 ESLint,其余用 ast-grep),然后读取模板生成规则与测试,最后安装到 guardrails/ 目录并更新 README 记录。测试命令:ESLint 用 node guardrails/rules/<rule-name>.test.js,ast-grep 用 sg scan --config guardrails/sgconfig.yml --test。

限制:仅依据资料说明,未提供收费、平台与性能数据。规则若命中超过 20% 文件可能约束过宽;无测试或无清晰错误信息的规则不可取;应避免与 ESLint/Ruff 内置规则重复,也避免只匹配单个文件的过细规则(此类宜用 CLAUDE.md)。