SuperAPI AI 工具集

scout

编程与开发

查看项目

更新于 10-16 01:11

技能介绍

用途:Scout Rule 遵循“让代码比你发现时更好”的原则,在 diff 触及的文件中识别最多 3 个高影响、低风险的改进机会。它读取整个文件内容,而不只是变更行,关注既有代码质量,帮助下一位开发者。

主要能力:先做前置检查,确认 git 可用且当前目录是 git 仓库,否则停止并报告。随后检测变更文件:默认对比工作区与基础分支,合并已提交、未提交和暂存变更;也可指定目标分支,或直接给出文件路径列表。分析范围覆盖整个文件。

改进类别包括:dead-code(未使用的函数、变量、导入、类型,注释掉的代码,不可达分支,过期的 TODO/FIXME)、naming(名不副实、同文件命名不一致、非平凡作用域的单字母变量、影响可读性的缩写)、magic-values(应命名常量的硬编码值、重复字面量、无解释的超时/限制值)、deprecated-patterns(同代码库已有新替代的旧 API、项目已弃用的模式、旧错误处理约定)、simplification(可更直接表达的复杂逻辑、无价值的包装函数、冗余检查、可用提前返回展平的嵌套条件)。

评分:每个机会按 Impact(1-5)和 Low-Risk(1-5)打分,综合分 = Impact × Low-Risk,只返回前 3 名。输出为汇总表加逐条详情,含文件:行号、类别、描述、工作量(trivial/small/medium)、评分、为何重要、建议改动。若无机会则报告文件状态良好。

限制:不查找 PR 变更中的 bug,不建议架构重设计,不标记代码库未确立的风格偏好,不提议需要新依赖的改动,不重构整个文件或模块,不改公共 API 签名,不涉及超过约 20 行的改动,不报告 linter 能发现的问题。

必要命令保持原样:git --version 2>/dev/null && git rev-parse --is-inside-work-tree 2>/dev/null;BASE_BRANCH=$(git symbolic-ref refs/remotes/origin/HEAD 2>/dev/null | sed 's@^refs/remotes/origin/@@' || echo "main")。