GoLandでテンプレート中でも補完を効かせる

こんにちは、マネーフォワードケッサイでバックエンドの開発をしているgarsueです。

みなさんGoの開発環境は何を使ってますか？ ぼくはVim -> Visual Studio Code -> GoLandと移り変わってきましたが、もう5年位はGoLandで開発しています。

そんなGoLandユーザーのぼくから、GoLandでGo標準のテンプレート¹を書く際のちょっと便利な小技をお伝えします。

テンプレート中で補完を効かせる

テンプレートはGoのコードではないため、通常は補完が効きません。 テンプレート中でドット {{ . }} でアクセスできる値の型がわからないためです。

そんなとき、GoLandでは特定の形式のコメントを記述することで対応する型を指定し、補完が効くようにできます。

例えば以下のような型とテンプレートがあるとします。

package models

type Person struct {
	Name string
	Age int
}

Name: {{ .Name }}
Age: {{ .Age }}

このテンプレート中でドットが対応している型は Person です。それを以下のような gotype で始まる特定のコメントで指定してあげます。²

{{- /*gotype: example/models.Person*/ -}}
Name: {{ .Name }}
Age: {{ .Age }}

これでGoLand上ではドットが示す型を認識するようになり、Ctrl + Spaceで補完できるようになります。便利ですね。

コメントを書く位置はドットでアクセスできるスコープの開始直後になります。 {{ with .Foo }} などでスコープを新たに作った場合は再度対応する型を指定してあげましょう。

参考

公式ドキュメントはこちらです。 https://www.jetbrains.com/help/go/integration-with-go-templates.html

GOPATH配下にプロジェクトを置かないと動作しないみたいなことが書かれていますが、そんなことはないので大丈夫です。