SuperAPI AI 工具集

lint-and-validate

编程与开发

查看项目

更新于 10-16 10:28

技能介绍

Lint and Validate 是一个面向代码库的验证类技能,用于在行为或配置发生变化后运行仓库既有的 lint 与类型检查,并把“检查失败”和“检查根本没有运行”区分开来,报告具体的验证结果。

何时使用 在行为或配置变更之后,且仓库存在相关的 lint 或类型检查时使用。应先阅读仓库的说明文档与 package 脚本,开发过程中运行聚焦的检查,完成前运行必需的检查。

执行流程

  1. 识别发生变化的语言、已配置的命令以及已安装的工具。在执行脚本前先检查 package 脚本:一个名为 lint 的脚本可能会修改文件或运行任意项目代码。
  2. 运行项目自带的只读 lint/类型检查命令。对 Node 项目,优先使用已声明的脚本,例如 npm run lint 和 npm run typecheck。不要用 npx 静默拉取一个并不存在的检查器。
  3. 对 Python,使用已配置、已安装的工具,例如 ruff check . 或 mypy .。不要假定每个 pyproject.toml 都同时配置了这两者。在没有检查将要产生的改动以及任务是否授权之前,绝不要添加 --fix。
  4. 修复相关失败时,不要删除用户的工作、削弱规则,或仅仅为了通过而调高超时。如果所需的工具不可用,要报告具体哪一项检查没有运行。
  5. 报告命令、退出结果、作用范围以及仍然存在的限制。通过 lint 并不能证明不存在运行时或安全缺陷。

示例 在修正一处 TypeScript 行为后,检查 package.json,运行已配置的聚焦回归测试,然后如果存在相应脚本就运行 npm run lint 和 npm run typecheck。如果 TypeScript 已声明但未安装,应报告本地检查器缺失,不要改用下载来的包,也不要把结果称为通过。

附带辅助脚本

  • python scripts/lint_runner.py /absolute/project:运行一组保守的候选检查。Node 回退检查器必须存在于本地 node_modules/.bin 中;Python 候选工具必须已安装。应先检查项目脚本。命令缺失或检查失败退出码为 1;没有配置任何检查或项目元数据无效退出码为 2。退出码 0 表示所调用的检查通过,并不表示已发现所有需要的检查。Python 检测是启发式的,可能建议未配置的 Ruff/MyPy 命令。
  • python scripts/type_coverage.py /absolute/project:只读的注解清单,尽管保留了兼容性的文件名。每种语言最多采样 30 个文件,跳过链接以及构建/依赖目录,并限制文件读取量。Python 使用 AST 节点以避免重复统计函数。TypeScript 报告词法层面的 : any 出现次数,包括可能出现在注释和字符串中的情况。不推断任何质量百分比或通过/失败阈值。退出码 2 表示没有适用文件;解析或读取错误退出码为 1。

限制 该 runner 会执行受信任的项目命令,这些命令可能会修改文件或访问网络。它不安装依赖、不检测所有 monorepo 配置,也不替代项目自身的 CI 契约。注解清单是有界的源码采样,不是语义层面的类型覆盖率;推断类型、泛型、装饰器行为以及正确性都需要实际的类型检查器。不要把未运行的检查标注为成功。