go repo质量管理之静态扫描 -- golangci-lint + reviewdog

背景

笔者在旷视公司，从事私有开发，使用语言为go。为了提升代码质量，给一个存在一段时间的Go代码仓库添加静态扫描，最终使用golangci-lint + reviewdog增加代码质量。

为什么选用golangci-lint

golangci-lint 速度快，可选linters多，另外我看golint风格不爽。
golangci-lint最喜欢的点是可以配置多种linters，详见官网文档。
https://golangci-lint.run/usage/linters/

如何选择linters

golangci-lint 有50+ linters，如何选择golinters。
这里引用GopherCon 2019 俄罗斯小哥的一个分享，虽然linters有50+但是有用的就2，3个。
ppt见： https://drive.google.com/file/d/1XhIshGdMMq2KxDdOIh100eYnXsQbm0fE/view
那么笔者是如何选择golinters的呢？是如何给一个存在了两年以上的go仓库添加Golint呢。

先回答第二个问题，如何给一个存在两年的代码仓库添加golint。不管选用哪种golinters组合，对于一个这样的代码仓库都会有大量的修改，那么最好的办法是做增量修改，然后再慢慢改已有的代码，这样避免了大量修lint的冲击，也实现了代码质量的迭代提升。
如何做代码的增量golint检查呢？如何集成到gitlab-ci中呢？
这里引入了第二个重量嘉宾: reviewdog
https://github.com/reviewdog/reviewdog

截屏2020-11-14 下午9.41.22.png

上图为reviewdog效果图。可以通过reviewdog把golint检查的问题，直接commit到gitlab或者github中。

export REVIEWDOG_GITLAB_API_TOKEN=xx
export CI_COMMIT_SHA=xxx
export GITLAB_API=xxx
export CI_REPO_NAME=xxx
golangci-lint run ./... | reviewdog -f=golangci-lint -reporter=gitlab-mr-discussion

通过声明gitlab ci中的变量就可以把golangci-lint的结果直接发送到git diff上的comment种。注：上面的reviewdog是笔者根据公司gitlab 的api情况调整过源码。
实现了git diff的增量golint后。那么回到了第一个问题如何选择golinters。
关于对golinters的选择非常痛苦，通过各种Linters的描述，和测试效果来看，linters分为如下几类

1. 完美符合，exp: bodyclose, deadcode不管改动多少代码都要使用
2. 部分符合，有些检查很好，有些检查不认可。exp: gosimple, govet弃之可惜，用之难受，代码改动破坏较大
3. 这个linters是强迫症晚期吧，还有点搞笑。不会选择

笔者采用的方法为1，2都选择，3不选择，然后1, 2的lint会comment到gitlab上。这样golint不是一个必须要过的选项，而是comment到MR上后根据实际情况选择修改还是resolve。

优点

最大限度的利用已有的linters发现隐藏的问题，通过迭代的方式剔除不需要的linters

缺点

由于Linters选用较多，一个MR的comment会很多，需要手动resolve

最后

上干货， 笔者的golangci-lint配置：

 enable:
    - bodyclose
    - deadcode
    - varcheck
    - ineffassign
    - scopelint
    - sqlclosecheck
    - structcheck
    - typecheck
    - unused
    - gofmt
    - goimports
    - misspell
    - unconvert
    - staticcheck
    - govet
    - gosimple
    - unparam
    - gocritic
  disable:
    - errcheck
    - noctx
    - goconst
    - gosec
    - exhaustive

结束语

爱上写作