golangci-lint による静的解析

Goでは、golangci-lint1つで複数の静的解析を1コマンドに束ねられます。ここではgolangci-lintの位置付け、インストール、実行、設定ファイル.golangci.ymlによる静的解析ツールのカスタマイズまでを扱います。

1. golangci-lint の位置付け

golangci-lint自体は独立した静的解析ツールではなく、複数の静的解析ツールを束ねて並列実行するランナーです。実際に解析を行っているのは、内部で呼び出される個別のツールです。代表的なものは以下です。

静的解析ツール 提供元 役割
gofmt Go公式 インデントや空白、importの並び順を統一する
govet Go標準 fmt.Printfのフォーマット指定と引数のミスマッチなど、コンパイルは通るが疑わしい記述を検出する
staticcheck コミュニティ 未使用変数・非効率なイディオム・潜在的なバグなど、300近い厳格なチェックを提供する
errcheck コミュニティ errorを無視している箇所を検出する
ineffassign コミュニティ 使われない代入を検出する
unused コミュニティ 未使用の関数・変数を検出する

これらを個別にインストールして順番に呼び出すこともできますが、golangci-lintを使えば設定ファイル1つでオン/オフを切り替えつつ1コマンドで実行できます。

2. インストール

Macの場合は、Homebrewからインストールします。

brew install golangci-lint

以下のような実行結果が表示されます(バージョンや依存の解決状況は環境により変わります)。

==> Downloading https://ghcr.io/v2/homebrew/core/golangci-lint/manifests/2.6.1
==> Fetching golangci-lint
...
🍺  /opt/homebrew/Cellar/golangci-lint/2.6.1: 8 files, 60.5MB

Windowsの場合は、公式ドキュメントの Install に記載されている手順に沿ってインストールします。バイナリのダウンロードやパッケージマネージャからのインストールなど、複数の方法が案内されています。

インストールできたことをバージョン表示で確認します。

golangci-lint version

以下のような実行結果が表示されます(バージョンは環境により変わります)。

golangci-lint has version 2.6.1 built ...

3. 実行と警告の確認

golangci-lint runコマンドで、現在のプロジェクトに対して解析を実行します。

golangci-lint run

以下のような実行結果が表示されます。

main.go:8:19: printf: fmt.Printf format %s reads arg #1, but call has 0 args (govet)
fmt.Printf("hello %s\n")
                  ^
main.go:5:5: var unused is unused (unused)
var unused = 42
    ^
2 issues:
* govet: 1
* unused: 1

デフォルトの設定でも複数の静的解析ツールが同時に実行され、以下のような問題が一括で指摘されました。

  • fmt.Printf format %s reads arg #1, but call has 0 args(govet): Printf("hello %s\n")が%sを要求しているのに引数を渡していない
  • var unused is unused(unused): パッケージレベルで宣言したunused変数がどこからも使われていない

指摘に沿ってmain.goを修正します。Printfに引数を渡し、var unused = 42の行を削除します。

package main

import "fmt"

func main() {
    fmt.Printf("hello %s\n", "world")
    x:=10
    if x==10 { fmt.Println("ten") }
}

コードを解説します。

fmt.Printf("hello %s\n", "world")

%sに対応する引数として"world"を渡すようにしました。これでgovetの指摘は解消されます。

    x:=10
    if x==10 { fmt.Println("ten") }

var unused = 42の行を削除しました。x:=10のスペース漏れや一行ifの書き方は、フォーマットとしては望ましくない状態ですが、次のセクションで扱うため、この時点ではそのまま残しておきます。

修正後に再度golangci-lint runを実行し、指摘が消えることを確認します。

golangci-lint run

以下のような実行結果が表示されます。

0 issues.

0 issues. が表示され、デフォルトの静的解析ツールでの指摘は解消されています。ただし、x:=10や一行ifのようなフォーマットの乱れは残ったままです。これらを検出するには、次のセクションでgofmtを明示的に有効化する必要があります。

4. 設定ファイル(.golangci.yml)でのカスタマイズ

プロジェクトごとに使いたい静的解析ツールを.golangci.ymlで指定できます。プロジェクトルートに.golangci.ymlを作成し、以下の内容を書きます。これは、代表的な6つの静的解析ツールを明示的に有効化する設定例です。

version: "2"
linters:
  enable:
    - govet
    - staticcheck
    - errcheck
    - ineffassign
    - unused
formatters:
  enable:
    - gofmt

コードを解説します。

version: "2"

golangci-lint v2 系の設定ファイルは、先頭で version: "2" を宣言する必要があります。指定がないと unsupported version of the configuration エラーで起動時に停止します。

linters:
  enable:
    - govet
    - staticcheck
    - errcheck
    - ineffassign
    - unused

linters.enableに、有効化したい静的解析ツール名をリスト形式で列挙します。それぞれの役割は「golangci-lint の位置付け」で紹介したとおりです。設定ファイルを置くことで、チーム内で誰が実行しても同じ静的解析ツールセットで解析が実行されるようになります。

formatters:
  enable:
    - gofmt

v2 系ではフォーマッタ系(gofmt・goimports など)は formatters セクションに分離されました。gofmt を明示的に有効化すると、整形の乱れも golangci-lint run の指摘として列挙されるようになります。

利用可能な静的解析ツールの一覧や、その他の設定(除外パターン・重大度・特定ルールの無効化など)は公式ドキュメント Configuration に記載があります。

5. 動作確認

.golangci.ymlを配置した状態で、再度golangci-lint runを実行します。

golangci-lint run

以下のような実行結果が表示されます。

main.go:6:1: File is not properly formatted (gofmt)
    fmt.Printf("hello %s\n", "world")
^
1 issues:
* gofmt: 1

先ほどは0 issues.だった状態から、今度はgofmtによる指摘が追加されました。.golangci.ymlでgofmtを明示的に有効化したことで、デフォルトでは検出されなかったフォーマットの乱れ(x:=10のスペース漏れや一行if)が指摘されるようになったことが確認できます。

指摘に沿ってフォーマットを整えます。gofmtは-wオプション付きで実行することで、ファイルを自動的に整形して上書き保存できます。

gofmt -w main.go

実行結果は何も表示されません(成功時は無出力)。整形後のmain.goは以下のようになります。

package main

import "fmt"

func main() {
	fmt.Printf("hello %s\n", "world")
	x := 10
	if x == 10 {
		fmt.Println("ten")
	}
}

x:=10がx := 10に、一行ifが複数行に整形されました。整形後に再度golangci-lint runを実行し、指摘が消えることを確認します。

golangci-lint run

以下のような実行結果が表示されます。

0 issues.

.golangci.ymlで追加したgofmtの指摘も含めてすべて解消されました。設定ファイルの内容を変えるだけで、静的解析でチェックする範囲を柔軟に広げられることが確認できます。