Visual Studio Code との連携

Visual Studio Code の Go 拡張機能と golangci-lint を連携させることで、コードの保存時に自動でフォーマット・静的解析が実行されるようになります。書きながらリアルタイムに指摘を受けられるため、指摘を後回しにせず、コミット前には必ずクリーンな状態を保てるようになります。

1. Go 拡張機能の導入確認

本セクションでは、Goのインストール 章で紹介した Go 拡張機能が Visual Studio Code に導入済みであることを前提とします。導入されていない場合は、先に該当章を実施してください。

導入済みかどうかは、Visual Studio Code の左サイドバーから「拡張機能」アイコン(四角が4つ並んだアイコン)をクリックし、検索ボックスに Go と入力して確認できます。Google が公開している Go(golang.go)に「Uninstall」ボタンが表示されていれば、導入済みです。

この拡張機能により、保存時のフォーマット(gofmt)は既定で有効になります。以降では、これに加えて golangci-lint を保存時に実行するための設定を行います。

2. settings.json への設定追加

golangci-lint を保存時に実行するには、ユーザ設定 settings.json に設定を追加します。

Visual Studio Code の「表示」→「コマンドパレット」を選択(Macでは Cmd + Shift + P、Windowsでは Ctrl + Shift + P)し、Preferences: Open User Settings (JSON) と入力して選択します。ユーザ設定の settings.json が開きます。

開いた settings.json の一番外側の { } の中に、以下の3つのキーを追加して保存します。

{
    "go.lintTool": "golangci-lint",
    "go.lintFlags": ["--fast-only"],
    "go.lintOnSave": "workspace"
}

コードを解説します。

"go.lintTool": "golangci-lint",

Go 拡張機能が保存時に呼び出す静的解析ツールをgolangci-lintに指定します。

"go.lintFlags": ["--fast-only"],

golangci-lint に追加で渡すオプションを指定します。--fast-only は、実行が高速な一部の静的解析ツールだけを実行するモードで、保存のたびに実行する用途に向いています(golangci-lint v1 系では --fast という名前でしたが、v2 系で --fast-only に改名されました)。

"go.lintOnSave": "workspace"

保存時に解析を実行する範囲を指定します。workspace はワークスペース全体、package は保存したファイルが属するパッケージのみが対象です。

3. 動作確認

先ほど整形済みのmain.goを開き、意図的にPrintfの引数を1つ削除して保存します。

package main

import "fmt"

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

保存すると、Visual Studio Code の下部に「問題」タブ(英語表記の場合は PROBLEMS)が表示され、以下のような指摘が並びます。

main.go:6:2  fmt.Printf format %s reads arg #1, but call has 0 args  (govet)

Printfの引数不足がgovetによって検出され、コードを書きながらリアルタイムに指摘を受け取れることが確認できました。指摘を確認できたら、Printfの引数を"world"に戻して保存し直します。「問題」タブから指摘が消えれば、Visual Studio Code との連携は完了です。