参加しているプロジェクトでurfave/cliを使っている。使い方はExampleにあるのと同じ書き方で使っている。 大半のバッチ処理をコマンドとして記述しているので、Exampleの書き方だとだいぶ見辛くなってきた。縦長のコマンド定義とオプション説明で目的の処理を探すのにもページ送りを何度もする。なんとかしたい。

golangを書き始めてそろそろ1年になり少し慣れてきたし、大好きなコマンドghqがv1.0.0を迎えたりドメイン変更したのを機にソースを読み始めた。 このghqもurfave/cliを使っているのだけど、読み始めてすぐになんて読みやすいんだ!と感激して、その書き方を踏まえてこう書いたらもっと読みやすくなるんじゃないかっていうのを残す。

まず、ghqのソース大まかに下記のようになっている。 main.goではentrypointとしてのみあり、実装するコマンドと各コマンドの実装も別ファイルに分けている。読みやすい!!

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

// main.go
func main() {
	if err := newApp().Run(os.Args); err != nil {
		os.Exit(i1)
	}
}

func newApp() *cli.App {
	app := cli.NewApp()
	app.Name = "ghq"
	app.Commands = commands
	return app
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

// commands.go
var commands = []*cli.Command{
	commandGet,
	commandList,
  ...
}

var commandGet = &cli.Command{
	Name:  "get",
	Action: doGet,
}

1
2
3
4

# cmd_get.go
func doCreate(c *cli.Context) error {
  ...
}

今のままでも十分読みやすいんだけど、コマンドが増えていくと同じ階層に同じprefixのファイルも増える。そうなるとディレクトリを掘りたくなったので下記のようにしてみた。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

x-motemen/ghq/
　├ cmd/
　│　└ common.go
　│　└ get.go
　│　└ list.go
　│　└ root.go
　├ repository/
　│　└ local.go
　│　└ remote.go
...
　├ main.go
　├ vcs.go
　└ url.go

urfave/cliのstruct階層とディレクトリ構成が似ていて、個人的にはとっつきやすいし読みやすいし、まとまっているのでこの書き方が好きだなって感じた。 他にurfave/cliを使っているコマンドも見ていこう。オプションの初期化も気になる…やりたいことは多いなぁ。