gowrtr - goコード生成支援ライブラリ

gowrtr (go writerと発音します) というgoのコード生成支援ライブラリ (ジェネレータ群) を書きました．

github.com

Synopsisに書いたように，

package main

import (
	"fmt"

	"github.com/moznion/gowrtr/generator"
)

func main() {
	generator := generator.NewRoot(
		generator.NewComment(" THIS CODE WAS AUTO GENERATED"),
		generator.NewPackage("main"),
		generator.NewNewline(),
	).AddStatements(
		generator.NewFunc(
			nil,
			generator.NewFuncSignature("main"),
		).AddStatements(
			generator.NewRawStatement(`fmt.Println("hello, world!")`),
		),
	).
		EnableGofmt("-s").
		EnableGoimports()

	generated, err := generator.Generate(0)
	if err != nil {
		panic(err)
	}
	fmt.Println(generated)
}

のようなコード (ジェネレータ) を書いてやると

// THIS CODE WAS AUTO GENERATED
package main

import "fmt"

func main() {
        fmt.Println("hello, world!")
}

というようなコードが生成されるというようなライブラリです．
この例だと生成結果があまりにシンプルなので，逆に記述量が増えてアレな感じになっていますが，ある程度生成結果が大きくなるようなものだと便利に使えるはず……です (後述のImmutabilityの話題もご覧ください)．詳細につきましてはGoDocをご覧ください (Exampleも示してあります)．

特徴としては

• 生成したコードにコードフォーマッタ (gofmt, goimports) を適用することができる
• ライブラリの各メソッドはimmutableに振る舞う

というものが挙げられます．

前者は生成結果にgofmtをかけることによって「生成コードのフォーマットが統一される」というメリットと「Syntaxチェックができる」というメリットを享受できることに加え，goimportsを適用することによって「コード生成のためのジェネレータを書いているときに『何をimportするか』を考えなくても (記述しなくても) 良くなる」というメリットを得ることができます．

後者については各ジェネレータの各メソッドが暗黙的に内部状態を変更しないので，利用者はジェネレータのスナップショットを任意のタイミングで取得することができます．これによりジェネレータの再利用が可能になると同時に，そこからジェネレータを派生させていくようなコードが書きやすくなるというメリットがあります．

---

さて，Javaにはsquare/javapoetというライブラリがあって，これはJavaコードの生成支援を行うライブラリなのですが，gowrtrはこのライブラリに着想を得て作られました．
まだできたてのライブラリなのですが，一部の自前環境に適用したところうまくワークしているのである程度動くのではないでしょうかというステータスです．が，もしかしたら足りない機能や記法のサポートがあるかもしれません．ご意見・ご要望をお待ちしております．

ぜひご利用くださいませ．