SuperAPI AI 工具集

go-code-review

编程与开发

查看项目

更新于 10-16 03:11

技能介绍

用途:审查 .go 文件,检查是否符合 Go 惯用模式、错误处理、并发安全以及常见错误;同时面向 Kubernetes Operator 场景提供专项检查清单。资料还给出何时加载各类参考文档的指引:错误返回模式看 references/error-handling.md,goroutine 与 channel 看 references/concurrency.md,类型定义看 references/interfaces.md,一般 Go 审查看 references/common-mistakes.md。

主要能力:提供审查清单与审查问题,涵盖错误是否检查与包装(不使用 _ = err、用 %w 包装)、资源是否在创建后立即 defer 关闭、goroutine 是否泄漏、接口是否由使用方定义且命名以 -er 结尾、导出名是否有文档注释、长函数是否避免裸返回、context 是否作为首个参数、互斥锁是否保护共享状态。Operator 专项包括:用 controllerutil.SetControllerReference() 设置 Owner 引用,安全处理 Finalizer 并检查 DeletionTimestamp,在 reconcile 循环中传播 context,区分 NotFound 与其他客户端错误,状态更新与 spec 变更分开,确保 reconcile 幂等,更新前用 apiequality.Semantic.DeepEqual 做语义相等判断,临时问题返回 ctrl.Result{Requeue: true},控制器访问资源需有 RBAC 标记。

适用场景:Go 项目代码审查,尤其是 Kubernetes Operator 控制器的审查。

限制与例外:资料列出若干不应报错的合法模式,如带原因注释的 _ = err、预泛型代码中的 interface{}、5 行内短函数的裸返回、通过 context 取消而非关闭 channel、带说明的 //nolint 等;部分规则仅在特定条件下才应标记,如错误返回值可操作、goroutine 无取消路径、接口方法数大于 1 且仅一个使用方。具体安装或调用方式资料暂未提供。