Zenn
🐶

Go の linter を golangci-lint から staticcheck に変更を検討してやめた話

2024/02/05に公開
Golang
#
linter
tech

はじめに

チームの Go プロジェクト linter には golangci-lint が採用され、GitHub Actions Workflow で golangci-lint が実行されています。新規 Go プロジェクト作成時に「golangci-lint のどの linter を有効にしようか？チームにとって良い golangci-lint 設定とは？」を検討した結果、新しいプロジェクトでは staticcheck を採用しようと思ったけどやめて golangci-lint を使い続けようとなった話です。

結論

golangci-lint を使い続けることにしました。

golangci-lint をやめようと思った理由

  • 多くの linter を設定した golangci.yml のメンテナンスコストがかかりそう
    • 設定ファイルのメンテナンスコストは最小にしたい
  • いろいろなプロジェクトを見てみたが「これが良さそう」という設定を導き出せなかった
    • 各チームで「linter に求めるものが違う」ため当たり前なんだと思う
    • 取捨選択をあきらめ golangci-lint に採用された linter を全てクリアすることは正義だ！として enable-all: true することは、モブプログラミングで開発するチームには「過剰」になりそう

staticcheck へ変更しようと思った理由

  • チームで利用の多い VSCode + vscode-go に staticcheck がデフォルトで採用されている
  • Go チームが開発している vscode-go が staticcheck を採用している(Go チームへの信頼)
  • VSCode + vscode-go + staticcheck の結果に満足できている (結果論)
  • 弊社 Yakumo チームが staticccheck を採用している

golangci-lint を継続利用しようと思った理由

理由はそれなん？のツッコミ歓迎！みなさんの golang linter 話聞かせてほしいです。

現状

チームの既存 Go プロジェクトから golangci.yml を拝借して作成した設定ファイルは次の通りです。

golangci.yaml

linters:
  enable:
    - revive
    - gofmt
    - govet

golangci-lint の default(errcheckm, gosimple, govet, ineffassign, staticcheck, unused) + 3 つ(revice, gofmt, govet)の linter が有効になっている状態です。VSCode + vscode-go で開発してるメンバーが多いため、手元開発環境では staticcheck で linter が走っている状態です[1]。

検討

golangci-lints のどの linter を有効にしようか？

golangci-ling: Linters を 1 つ 1 つ理解して試して取捨選択していくのは厳しいため、「Go を採用していて、かつチームで利用している OSS や Go と言えば!で著名なチーム(会社) のリポジトリを見ながら良い感じの linter を選択できないか」という方法で検討しリストアップしました。

  • Docker
    • Go といえば Docker でしょう
  • Terraform
    • 毎日お世話になっている
  • Kubernetes
    • 界隈で著名
  • GitLab
    • Go の標準とスタイルガイドラインを書いてあり参考になりそう
  • golangci
    • 本家のリポジトリ

各 OSS/チーム(会社)内のリポジトリ内でも設定が違うものもありますが、アクティブなリポジトリから 1 つ選出しています。

docker/cli

https://github.com/docker/cli/blob/master/.golangci.yml#L1-L43

hashicorp/terraform

https://github.com/hashicorp/terraform/blob/main/Makefile

  • golangci-lint じゃなくて staticcheck だった

kubernetes/kubernetes

https://github.com/kubernetes/kubernetes/blob/master/hack/golangci.yaml#L130-L142

mercari/grpc-federation

https://github.com/mercari/grpc-federation/blob/main/.golangci.yml#L63-L98

gitlab

https://gitlab.com/gitlab-org/language-tools/go/linters/goargs/-/blob/master/.golangci.yml?ref_type=heads#L69-93

golangci/golangci-lint

https://github.com/golangci/golangci-lint/blob/master/.golangci.yml#L79-L130

各リポジトリを眺めて「各チームの思惑があって設定されおり(予想通りの千差万別)」、どこかのチームを参考に決めるのは難しいと感じました。

今まで golang を使った開発の中で発生した「入れておきたい制約、チェック」の集合知として設定ファイルが作れると良いと思いましたが、現状は難しい状況です。

チームにとって良い golangci-lint 設定とは？

「どこかのチームを参考に決めるのは難しい」という結論は出ましたが、であれば一番最初に調べた docker/cli を参考に設定を考えてみますか、とチーム用の golangci.yml 設定は作ってみた。

設定ファイルを作るために書いたメモです。
linters:
  enable-all: false
  disable-all: true
  enable:
    - bodyclose # Checks whether HTTP response body is closed successfully.
      http 通信書くときに close 見てくれる、見てほしい

    - depguard
      利用してほしくないパッケージをガードしたい

    - gofmt # go fmt
      go fmt チェックはいる, vscode-go で入るので合わせたい

    - goimports # goimport
      goimports かけておきたい。vscode-go で入るので合わせたい gci にするか？悩む

    - gosec # Inspects source code for security problems.
      セキュリティチェックしてくれる

    - gosimple # default
      不要なコードを教えてくれる

    - govet # default
      コンパイラが検出しない疑わしい構文をチェックしてくれる

    - ineffassign # default
      不要な代入が行われている箇所を報告してくれる

    - misspell # Finds commonly misspelled English words in comments.
      僕はほしい

    - nakedret # Checks that functions with naked returns are not longer than a maximum size (can be zero).
      naked return はやめたい(みんなはどう？)

    - revive # Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint.
      golint のかわり,,,なんだけど revive, staticcheck, gocritic が被ってる気がする。golangci-lint がうまく設定で調整してくれてるのだろうか。ちょっと微妙だな。

    - staticcheck # default
      linter

    - unconvert # Remove unnecessary type conversions.
      不要な型キャストをチェック

    - unparam # Reports unused function parameters
      未使用パラメータチェック

    - unused # default
      未使用な変数/型を教えてくれる

    - errcheck # default
      error チェックをしてないことを教えてくれる

    - gocritic # chekers (diagnostic, style, performance)
      いろいろ checker

    - sqlclosecheck
    - rowserrcheck
      bodyclose 入れるならこいつも入れたいな

golangci.yml

linters:
  enable-all: false
  disable-all: true
  enable: # please keep this alphabetized
    - depguard # Go linter that checks if package imports are in a list of acceptable packages.
    - gofmt # go fmt
    - goimports # goimport
    - gosec # Inspects source code for security problems.
    - gosimple # [default] Linter for Go source code that specializes in simplifying code.
    - govet # [default] Vet examines Go source code and reports suspicious constructs, such as Printf calls whose arguments do not align with the format string.
    - ineffassign # [default] Detects when assignments to existing variables are not used.
    - misspell # Finds commonly misspelled English words in comments.
    - nakedret # Checks that functions with naked returns are not longer than a maximum size (can be zero).
    - revive # Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint.
    - staticcheck # [default] staticcheck
    - unconvert # Remove unnecessary type conversions.
    - unparam # Reports unused function parameters
    - unused # [default] Checks Go code for unused constants, variables, functions and types.
    - errcheck # [default] Errcheck is a program for checking for unchecked errors in Go code. These unchecked errors can be critical bugs in some cases.
    - errorlint # Errorlint is a linter for that can be used to find code that will cause problems with the error wrapping scheme introduced in Go 1.13.
    - gocritic # chekers (diagnostic, style, performance)

run:
  timeout: 10m

linters-settings:
  depguard:
    rules:
      main:
        deny:
          - pkg: io/ioutil
            desc: The io/ioutil package has been deprecated, see https://go.dev/doc/go1.16#ioutil
  revive:
    rules:
      - name: package-comments  # パッケージ/関数コメント disable
        disabled: true
issues:
  # The default exclusion rules are a bit too permissive, so copying the relevant ones below
  exclude-use-default: false

  # Maximum issues count per one linter. Set to 0 to disable. Default is 50.
  max-issues-per-linter: 0

  # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
  max-same-issues: 0

チーム用の golangci.yml 作った上で、チームの Go リポジトリで golangci-lint を動作させチェックしてみた結果「ほとんど何も検出されない」となりました。この結果を見て「モブプログラミングで実施される Go プロジェクトでは、linter が検出しそうな部分はモブの中で解決されている、また、VSCode のでデフォルト linter である staticcheck によってある良い感じになっている」と感じました。

最終結果として golangci-lint を使い続けることに

ローカル環境のみ staticcheck に変更して日々の業務を実施していましたが、早くも staticcheck + 追加制約を入れたくなりました。

  • sqlclosecheck, rowserrcheck, bodyclose のように実装時に忘れがちなチェックを入れたくなった
  • 追加制約(linter)のために make を書くのは本末転倒 → golangci-lint じゃないか

その中で @ma91n さんの「文字数いっぱいまで有効なLinter増やせました。まだまだ功夫積んでいきます！」に共感、ZOZO さんの golangci-lint の linter を増やしていく取り組みに共感し golangci-lint を使い続けようと結論づけました。

追加したくなった linter を含め golangci.yml はこれでスタートします。

linters:
  enable-all: false
  disable-all: true
  enable: # please keep this alphabetized
    - bodyclose # http response が close されているかどうかをチェックします
    - containedctx # struct に Context を持たせないベストプラクティスをチェックします
    - depguard # 利用しないパッケージを定義し確認します
    - errcheck # [default] Go 1.13 で導入されたエラーラッピングで問題を起こすコードをチェックします
    - errorlint # error チェックがされていないコードをチェックします
    - gocritic # 多くのチェック項目を持つ linter
    - gofmt # go fmt がかけられているかをチェックします
    - goimports # goimports がかけられているかをチェックします
    - gosec # セキュリティ観点で様々な観点でチェックします
    - gosimple # [default] 必要のないいくつかのパターンのコードをチェックします
    - govet # [default] 公式の go vet です
    - ineffassign # [default] 不要な代入が行われている箇所をチェックします
    - misspell # スペルチェッカー
    - nakedret # 長い関数における + naked return をチェックします
    - paralleltest # t.Parallel() がついていないテストをチェックします
    - rowserrcheck # database/sqlのRowsのエラーが正しく処理されているかをチェックします
    - sqlclosecheck # sql.Rowsやsql.Stmtがcloseされてるかどうかをチェックします
    - staticcheck # [default] 多くのチェック項目を持つ linter
    - unconvert # 必要のない type 変換をチェックします
    - unparam # 未使用引数をチェックします
    - unused # 未使用変数/定数/関数/型をチェックします

run:
  timeout: 5m

linters-settings:
  depguard:
    rules:
      main:
        deny:
          - pkg: io/ioutil
            desc: The io/ioutil package has been deprecated, see https://go.dev/doc/go1.16#ioutil
  revive:
    rules:
      - name: package-comments  # パッケージ/関数コメント disable
        disabled: true
issues:
  # Maximum issues count per one linter. Set to 0 to disable. Default is 50.
  max-issues-per-linter: 0

  # Maximum count of issues with the same text. Set to 0 to disable. Default is 3.
  max-same-issues: 0

あとがき

golangci-lint の linter を増やす！をコツコツ継続していく、別 linter 探求を継続していきたいと思います。

リンク

最高なのでみんな読みましょう。
https://zenn.dev/sanpo_shiho/books/61bc1e1a30bf27

弊社 Yakumo チームでも staticcheck 採用してるよ
https://blog.cybozu.io/entry/2021/02/26/081013

脚注

  1. ちゃんと golangci-lint の設定をしているメンバーがいるかもしれない ↩︎

GitHubで編集を提案

Discussion