Zed から Go のテストを実行するためのカスタム Task 定義

ここ半年ほど、メインのエディタとしてZedを使っている。 動作が軽快で、生成AI関連の機能も標準でサポートされているなど、使い勝手が良いので気に入っている。

Zed - The editor for what's next

Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.

zed.dev

しかし、まだまだ発展途上ということもあり、乗り換え前に使っていたVSCodeと比べると、 どうしても機能的に足りない部分があるのは否めない。

足りないものの一つとして、テスト実行とそのレポート機能が挙げられる。 今回は、これを Zed の Task 定義によって補おうという話。

VSCodeのテスト実行機能 #

VSCode上でテストを実行すると、テストケースごとに成功・失敗が表示され、 各ケースの出力を個別に表示したり失敗したテストコードにジャンプしたりすることができる¹。

一方、Zed にはいまのところテストレポートを表示する機能はない²。

Task 実行機能を使えばシンプルな go test であれば実行できる。 cmd-shift-r (task: spawn) でカーソル行が含まれるテスト関数を対象に実行するメニューが表示される。

これはこれで便利だが、素の go test なので少々出力が見づらい。

Zed のカスタム Task 定義 #

Zed から実行できるTaskには、カスタム定義を加えることができる。

定義はJSONフォーマット。 ~/.config/zed/tasks.json に配置すればグローバルに、 .zed/tasks.json に配置すればプロジェクト固有の Task を定義することができる。

今回はこれを使ってGo用のテスト実行 Task を定義する。

Go 用の Task を定義する #

• Zedが定義する変数を利用してTaskを定義
• キーバインドを定義

Task 定義中では、Zedが用意した変数を参照することができる。 今回はそれらの変数のうち以下の2つを利用する。

Task の定義は以下のようになる。

// ~/.config/zed/tasks.json
[
  {
    "label": "Run Go Test: ${ZED_SYMBOL}",
    "command": "gotestsum --format testname -- ${ZED_DIRNAME} -run ${ZED_SYMBOL}"
  }
]

テスト結果の表示を見やすくするために、gotestsumを使う。 引数として ZED_DIRNAME と ZED_SYMBOL を渡せば、エディタ中のカーソルが含まれるテストを実行することができる。

注意点としては、 ZED_SYMBOL で必ずしもテスト関数を参照できるわけではないということ。 例えば、 struct 定義内にカーソルがあると、そこに定義されているメンバー名が参照されてしまう。 TableDrivenTests方式でテストコードを記述している場合、 テスト関数内で struct を定義することになり、これが引っかかる。

func TestFoo(t *testing.T) {
	specs := []struct {
		name string // この行にカーソルがある場合
		age  int
	}{
			...
	}

	for _, s := range specs {
		t.Run(...)
	}
}

上記コードの name 部分にカーソルがある状態でタスクを実行しようとすると、ZED_SYMBOL の値は name になってしまう。

とはいえ、普段コードを書きながらテストを回している中で煩わしさを感じることはほぼない。 たいていはテストケースの struct 定義部分ではなく、各テストケースを定義する部分を編集しているので。

更にキーバインドを定義してより使いやすくする。

Task を実行するためのキーバインドを定義する #

VSCode に倣って、以下のようにキーバインドを定義した。 cmd-; c でテストを実行。 cmd-; l で前回実行した Task を再実行する。

// ~/.config/zed/keymap.json
[
  {
    "context": "Editor",
    "bindings": {
      "cmd-; c": "editor::SpawnNearestTask",
      "cmd-; l": "task::Rerun",
      ...
    }
  },
  {
    "context": "Editor && (extension == go)",
    "bindings": {
      "cmd-; c": ["task::Spawn", { "task_name": "Run Go Test: ${ZED_SYMBOL}" }]
    }
  },
  ...
]

Go 以外のモードでは最も対象が近い Task を実行する editor::SpawnNearestTask を、 Go モードでは今回定義したタスクを実行するようにしている³。

task::Rerun も定義することで、テストコードから離れた場所にカーソルがあっても、 即座に前回のテストを再実行することができる。

まとめ #

カスタム Task とそれを実行するキーバインドを定義することで、 Go 用のテスト実行環境をある程度満足できるレベルで整えることができた。 それでもやはりテストレポートからテストコードにジャンプする機能などは実現できていないので、今後の Zed の開発に期待したい。

Zed はほぼ毎日アップデートがあり、最近では git 操作機能⁴のプレビューも行われている。 活発に開発されていることが実感できるので期待が持てる。