goreturnsのインストール方法と使用方法を調べました

golangを書いているとビルドしてから 「あっ、フォーマットが揃ってない！」とか「importが余分にあってエラー出てるわ〜」とか・・

誰でも一度が経験があるかと思います。

そんなときに便利なgoreturnsというものを見つけたので紹介します。

目次

goreturnsとは

goreturnsというのは
余分なimportを消す、必要なimportを追加する、フォーマットを揃える、function 内で戻り値に合わせた return の補完(zero value)をしてくれる
といったことを一度に全て行ってくれるものです。

インストール方法

go get -u sourcegraph.com/sqs/goreturns

使用方法

goreturns xxx.go

githubはこちらです。 github.com

試してみる①

test.goというファイルを用意して試してみました。

わざとimportが足りないものを用意しました。 この例ではlogというインポートが足りていません。

package main

func main() {
    log.Println("テスト")
}

次にgoreturnsします。

オプションに-wを必ず付けて下さい。

-wオプションをつけることによってファイルに変更を加えることができる程度に覚えておいて下さい。

逆に-wオプションを付けないと、ファイルが変更されません。

goreturns -w test.go

結果を見ると、ちゃんとlogのインポートが追加されています。

package main

import "log"

func main() {
    log.Println("テスト")
}

試してみる②

今度はわざとフォーマットがバラバラのものを用意しました。

package main

import "log"

func    main() {
           log.Println("テスト")
      }

先程と同じようにgoreturnsします。

goreturns -w test.go

結果です。きちんと揃いましたね。

package main

import "log"

func main() {
    log.Println("テスト")
}