SuperAPI AI 工具集

code-quality

编程与开发

查看项目

更新于 10-16 06:57

技能介绍

用途

Code Quality 用于跨语言地度量、强制和改进代码质量,支持 JavaScript/TypeScript、Python、Go、Rust。它把静态检查、格式化、覆盖率、复杂度分析和技术债识别组织为一组可直接运行的命令。

主要能力

Linting(静态检查与自动修复)

  • JavaScript/TypeScript:使用 ESLint,可输出 JSON 并用 jq 筛选有错误的文件;支持 --fix 自动修复,也支持只启用指定规则(如 no-unused-vars)。
  • Python:使用 Ruff 做快速检查与格式化,使用 mypy 做类型检查,可两者串联执行。
  • Go:使用 golangci-lint 元检查器,可启用 gosec、govet、errcheck、staticcheck 等具体检查器,并输出 JSON 供 jq 解析。
  • Rust:使用 Clippy,可启用 clippy::all、把警告视为错误(-D warnings),或通过 --fix 应用建议。

Formatting(格式化)

  • Prettier:用于 JS/TS/CSS/JSON/MD,支持 --check 检查与 --write 写入。
  • Ruff format:用于 Python,支持格式化与 --check 检查。
  • gofmt:用于 Go,-l 列出未格式化文件,-w 写回。
  • rustfmt:通过 cargo fmt --check 检查,cargo fmt 格式化。

Code Coverage(覆盖率)

  • Jest(JS/TS):可通过 --coverage --json 与 jq 计算行覆盖,也可直接读取摘要。
  • pytest(Python):--cov=src --cov-report=term-missing。
  • Go:go test -coverprofile 配合 go tool cover -func 输出总覆盖率。
  • Rust:cargo tarpaulin --out stdout。

Complexity Metrics(复杂度度量)

  • Python:radon 计算圈复杂度(radon cc)与可维护性指数(radon mi)。
  • JavaScript/TypeScript:通过 ESLint 的 complexity 规则(阈值 10)检测复杂度。

Tech Debt Indicators(技术债指标)

  • 用 grep 统计和列出 TODO/FIXME/HACK/XXX/TEMP 注释。
  • 用 find + wc 找出超过 300 行的长文件。
  • 可用 pylint 的 duplicate-code 检测重复代码(需 pip install pylint)。

使用方式

技能以命令行片段形式给出,可直接在项目根目录执行,也可组合进脚本或 CI。示例包括只对改动文件运行 ESLint:eslint $(git diff --name-only --diff-filter=ACMR HEAD~1 | grep -E '\.(ts|tsx|js)$')。

适用场景

  • 在本地或 CI 中做代码检查、格式化与自动修复。
  • 生成覆盖率报告与复杂度指标,跟踪技术债。
  • 在多语言仓库中统一检查与格式化流程。

限制与注意事项

  • 覆盖率数字本身可能误导:80% 但缺少边界用例测试,不如 60% 但测试充分。
  • 应增量修复 lint 错误,不要一次提交数百个修复。
  • 圈复杂度大于 10 视为代码坏味道,大于 20 需要重构。
  • 该技能未提供收费、价格或平台支持信息。