読者です 読者をやめる 読者になる 読者になる

詩と創作・思索のひろば

ドキドキギュンギュンダイアリーです!!!

コード補完もできる Go の REPL「gore」を作った

Go

タイトルの通りです。Go は LL 的に使える、とはよく申しますが、そういう意識で使っていると REPL 的なことをしたいときに困りがちですよね。そこで作りました。gore。いい名前ですね。

motemen/gore · GitHub

以下のスクリーンキャストでだいたいの雰囲気をお察し下さい。

gore screencast

(スクリーンキャストは cho45/KeyCast を使って撮影しました)

特徴

gore の特徴は以下の通りです。

  • ラインエディタと履歴
  • 複数行入力
  • パッケージのインポート、補完つき
  • 式および文を実行可能
  • コード補完(nsf/gocode を利用)
  • プリティプリント(k0kubun/ppdavecgh/go-spew がおすすめ)
  • ドキュメントも引ける(godoc が必要)

以上のように、非常に便利なものになっております。むしろこの程度 REPL には当然あってほしい機能だとも言える。

インストール

利用には Go 本体が必要なため、バイナリの配布はしていません。

go get github.com/motemen/gore

完全な機能のために、以下のライブラリも別途 go get しておくことをお薦めします。

go get github.com/nsf/gocode # 入力補完に
go get github.com/k0kubun/pp # プリティプリントに
go get golang.org/x/tools/cmd/godoc # ドキュメントに

使い方・機能

gore で起動すると、プロンプトが表示されます。Go の式や文を入力してください。入力された内容が値を返す式や変数の代入となる文であった場合には、よしなに値が印字されます。

gore> n := 1
1
gore> n+1
2

入力がうまく解析できなかったときはプロンプトが ..... となり、続けて入力できます。EOF(^D)でキャンセルします。

gore> even := func(n int) bool {
..... return n % 2 == 0
..... }
func(int) bool {...}
gore> even(4)
true

Go のコードではない指示は、コロンで始まるコマンドで入力できます。:help ですべてのコマンドを一覧できますが、よく使うのはパッケージのインポートを行う :import でしょう。

gore> :import strings
gore> strings.TrimSpace(" foo ")
"foo"

また :write コマンドで、REPL セッションで生成されたコードをファイルに保存することができます。

コード補完

エディタで Go を書いている人は gocode をインストールしていることと思いますが、gore もこれを利用してコード補完を行います。スクリーンキャストにあるように、適当なところで Tab キーを押すことでコードの補完がいい感じになされます。

プリティプリント

ppspew がインポートできる環境であれば、これらを利用して値の表示をおこないます。なければ fmt.Printf("%#v", ...) にフォールバックします。

ドキュメントを引く

:doc コマンドでドキュメントを引けます。名前だけでなく型も見てるので、ある変数のメソッドからドキュメントを引くということもできます。godoc コマンドが必要。

gore> :import encoding/json
gore> :doc json.Decoder
(godoc encoding/json Decoder)
gore> d := json.NewDecoder(nil)
...
gore> :doc d.Decode
(godoc encoding/json Decode)

他の REPL 実装との比較

Go の REPL を作ろうという試みは人類共通のようで、すでにいくつかの実装が存在しています:

以下、これらにの機能について簡単に gore と比較をした表です。

実装 値の表示 インポート 文の入力 アンドゥ 行編集 複数行入力
gore
go-repl
rango
igo
play.golang.org

補足

  • 「値の表示」とは 1 + 1 などと入力したときにその値が表示できること。対応していない実装では "1 + 1 evaluated but not used" などのエラーが表示され、fmt.Println(1 + 1) などとしなければいけません。
  • コード補完、色付きプリティプリントに対応しているのは gore のみです。

注意点

  • REPL といいつつ実は裏ではそれまでの入力を順番に実行するソースコードを生成して go run しているだけなので、どこかの時点で評価に時間のかかるコードを入力すると、その後の入力の評価にも時間がかかるようになります。

以上

紹介した機能のほかに、Go ではインポートしたパッケージが利用されていなかったり未使用の変数があったりするとエラーになる件の回避など、快適な REPL 体験のために細かく調整しています。どうぞご利用下さい。

いつも通りコードは GitHub 上にあります。不審な挙動があったら Issues よりお知らせください。

https://github.com/motemen/gore