好きな言語でNeoVimのプラグイン書きたい！書きたくない？

大LT 2023 春 in Aizuの登壇資料です
https://zli.connpass.com/event/280495/

Transcript

1. 好きな言語でNeoVimのプラグインを書き たい！書きたくない？
 株式会社サイバーエージェント @n04ln

2. 自己紹介
 @n04ln
 • のあって呼んでください
 • noahのleet文字列です
 所属
 • 株式会社サイバーエージェント
 • 新卒4年目
 • 大学はここ、ヅ大（24期生）
 • 部署はAmebaブログ
 ◦ GCP, AWS, Go, Java etc…
 はじめて触ったエディタはVim
 @n04ln
 @n04ln

3. NeoVimのプラグインの話をします

4. NeoVimプラグインって？
 標準の機能を組み合わせ、機能をセットにしたもの
 NeoVimのプラグインはruntimepathに配置したスクリプトが走る
 vimscriptで作る場合、Vimプラグインとほぼ同じ
 
 • autoload/ … 必要時に評価される
 • plugin/ … 最初に読み込まれる
 • doc/ … :h コマンドで表示されるヘルプ
 • lua/ … luaプラグインのスクリプト置き場
 …etc

5. ベーシックなvimプラグイン
 言語はvimscript

6. vimscriptのクセあるとこ(1)
 • 変数のprefixが癖あるなと（個人的意見）
 ◦ a: 関数の引数
 ◦ l, g: ローカルorグローバル変数
 ◦ b, t, w: バッファ, タブ, ウィンドウでのスコープ変数
 ◦ v: vimの定義済み変数。真偽値はv:trueなど
 • モダンな言語にあるような機能がなかったり、追加されたのが最近 だったり。

7. vimscriptのクセあるとこ(2)
 • 遅い
 ◦ めっちゃ遅い。
 ◦ Fib(40)をだしてみる
 ◦ ←Go vimscript→

8. 書きやすい言語で書きたいですよね

9. NeoVim
 • Luaが標準で組み込み
 • vimscriptの代わりに、Luaでプラグインがかける
 ◦ もちろんvimscriptも使える

10. と、いいつつも

11. 好きな言語で書きたいですよね

12. NeoVim - Remote Plugin
 • NeoVimに付属するRemote Plugin機能
 • 好きな言語で書くプラグインで処理
 ◦ I/Oは標準入出力を使ってmsgpack rpcを利用
 ◦ NeoVimから扱う関数、コマンドを定義でき、APIを介して操作が できる
 ◦ NeoVim本体とつなぐ部分でﾁｮｯﾄだけvimscript
 • 仕組み自体はLSPに似ている
 ▪ クライアントはNeoVim以外に互換はない

13. NeoVim - Remote Plugin
 FuncXXX(YYY, ZZZ)
 好きな言語で書いた
 プラグインプロセス
 NeoVim
 manifest(後述)で登録した 
 関数をmsgpack-rpcで呼び出し 

14. NeoVim - Remote Plugin
 FuncXXX(YYY, ZZZ)
 処理
 好きな言語で書いた
 プラグインプロセス
 NeoVim

15. NeoVim - Remote Plugin
 nvim_buf_set_lines(buf, 0, -1, true, "てきすと") 
 FuncXXX(YYY, ZZZ)
 処理
 好きな言語で書いた
 プラグインプロセス
 NeoVim
 処理中もAPI呼び出し 

16. NeoVim - Remote Plugin
 nvim_buf_set_lines(buf, 0, -1, true, "てきすと") 
 FuncXXX(YYY, ZZZ)
 処理
 好きな言語で書いた
 プラグインプロセス
 response
 NeoVim
 関数なので値も返せる 

17. NeoVim - Remote Plugin
 • 比較的実行速度は早い
 • その言語のエコシステムが使えるので慣れた言語ならシュッとかけ る
 • PythonやNodeの場合はそのランタイムが必要
 ◦ Goなどバイナリを吐き出せる言語なら結構楽
 • 仕組みは似ているが、LSPとは違い他エディタでは使えない
 ◦ Vimでももちろん使えない

18. NeoVim - Remote Plugin
 • いろいろな言語でRemote Pluginのライブラリがある
 ◦ Go
 ▪ https://github.com/neovim/go-client
 ◦ Node
 ▪ https://github.com/neovim/node-client
 ◦ Python
 ▪ https://github.com/neovim/pynvim
 • もちろん、ライブラリがなくともmsgpackの実装があれば...!
 

19. AOJ.nvim
 • https://github.com/n04ln/aoj.nvim を例に。
 • 昔、ラボで作ったプラグインの焼き直し

20. (vimscript)Remote Plugin - manifest
 • NeoVim起動時にプラグインバイナリ起動と各種設定

21. (vimscript)Remote Plugin - manifest
 • NeoVim起動時にプラグインバイナリ起動と各種設定
 関数を非同期(async)に 
 msgpack-rpcでstdioを介して通信 

22. (Go)Remote Plugin
 • プラグインとして公開する関数、コマンドの定義
 ◦ 関数名、コマンド名に対応する処理を登録する

23. (Go)Remote Plugin
 • プラグインとして公開する関数、コマンドの定義
 ◦ 関数名、コマンド名に対応する処理を登録する
 NeoVimの関数名
 関数の実装

24. (Go)Remote Plugin
 • v *nvim.Nvimを受け取る
 ◦ NeoVimのRemote Pluginからできる操作は全てそこから

25. (Go)Remote Plugin
 • v *nvim.Nvimを受け取る
 ◦ NeoVimのRemote Pluginからできる操作は全てそこから
 Bufferに値をセットするAPI 呼び出し

26. (Go)Remote Plugin
 • 複数のNeoVimの操作をatomicに実行するためのBatch機能
 カレントウィンドウの他に 諸々設定をした別ウィン ドウを作成

27. (Go)Remote Plugin
 • vimscriptや、Luaの実行もできる
 • remote pluginのAPIとしてなければ定義済み関数をシュッと呼び出 ししたり

28. (Go)Remote Plugin
 • vimscriptや、Luaの実行もできる
 • remote pluginのAPIとしてなければ定義済み関数をシュッと呼び出 ししたり
 文の実行をする。
 
 式（値を返す）も評価できる 
 値をBindする場合はreturnをつける 

29. Remote Pluginで気をつけること
 • 標準入出力をNeoVimとのやりとりで使うので、ログ等は標準エラー 出力に出しておくと吉
 
 
 
 • こうしておくとエラー出力をNeoVimから確認しやすい

30. プラグイン、書いてこうぜ！