Neovim 0.8以降のビルトインLSPについて
実は Neovim 0.8 以降でいろいろと進化した LSP on Neovim についての記事がなかったので、書いてみます。
長らく Neovim で LSP を導入するには nvim-lspconfig を使うことが推奨されてきました。
というか、nvim-lspconfig を使う前提の解説がほとんどでした。
これを使うと LSP の設定を簡単に行うことができます。
例えば、lua のサーバーであるlua_lsを使う場合は以下のように設定します。
local lspconfig = require("lspconfig")
lspconfig.lua_ls.setup({})
この設定を行うことで、lua のファイルを起動すれば自動的にサーバーが立ち上がり、lua ファイルのバッファに対して補完や Diagnostic などの処理を行ってくれます。
またバッファを閉じればサーバーも自動的に閉じます。
今回は nvim-lspconfig ではなく、Neovim 0.8 以降に LSP に関していくつかの標準搭載された機能を紹介していきます。
LspAttach/LspDetach
これがユーザーにとっては大きな影響を持つと思います。
Neovim 0.8 より、LspAttach、そしてLspDetachというautocmdが追加されました。
LspAttach は、LSP Server が開いた Buffer に Attach されたときに発火します。
これをうまく使うと、設定ファイルを書くのが楽になります。
さて、Neovim 0.7 以前で LSP Server の Attach 時に何か処理を行いたい場合は、nvim-lspconfig のon_attachオプションに関数を渡していました。
つまり、巨大なon_attach関数を書いて、それを渡す必要があったのです(keymap から外部プラグインの設定から)。
そのため、LSP Server 起動時の設定は LSP の設定とまとめて１箇所に記述しなければなりませんでした。
local lspconfig = require("lspconfig")
-- キーマップを設定する
function setKeymap(client, buffer)
vim.keymap.set('n', 'gd', '<cmd>lua vim.lsp.buf.definition()<CR>', { silent = true, buffer = buffer })
end
-- 外部プラグインをlsp serverを連携させる
function setPlugin(client, buffer)
require("illuminate").attach(client, buffer)
end
function on_attach(client, buffer)
setKeymap(client, buffer)
setPlugin(client, buffer)
end
lspconfig.lua_ls.setup({
on_attach = on_attach
})
しかも、このon_attach関数は、LSP Server ごとに設定する必要がありました。
まあめんどくさいですよね。
これが、LspAttach が追加されたことで、設定ファイルをうまく分割することができるようになりました。
試しに書いてみましょう。
local lspconfig = require("lspconfig")
function on_attach(on_attach)
vim.api.nvim_create_autocmd("LspAttach", {
callback = function(args)
local buffer = args.buf
local client = vim.lsp.get_client_by_id(args.data.client_id)
on_attach(client, buffer)
end,
})
end
-- キーマップを設定する
on_attach(function(client, buffer)
vim.keymap.set('n', 'gd', '<cmd>lua vim.lsp.buf.definition()<CR>', { silent = true, buffer = buffer })
end)
-- 外部プラグインをlsp serverを連携させる
on_attach(function(client, buffer)
require("illuminate").attach(client, buffer)
end)
lspconfig.lua_ls.setup({})
上のコードでは、on_attach関数で autocmd をラップして使いやすくしています。
0.7 以前のコードと違って、このラップ関数を用いれば LSP Server 起動時の処理を設定ファイルのどこに書いても良くなりました。
また、LSP Server ごとに設定する必要もなくなりました。
特定の LSP Server に対して何か特別に処理を行いたい場合は、on_attach関数の引数を使ってclient.name == 'lua_ls'などのような条件分岐を使うこともできます。
自分は lazy.nvim を用いてプラグインを管理しています。そして設定ファイルはプラグインごとに分割しています。
そのため、LspAttachを用いることで綺麗に設定ファイルを分割することができました。
また、LspDetach は LSP Server が開いた Buffer から Detach されたときに発火します。
これのうまい使い所は... 今のところ思いついていません。誰か教えて下さい
追記 2023/05/02
さて、上ではLspAttachを使ったon_attach関数を紹介しました。
ではこれまで LSP Server に直接渡していたon_attachはもう不要なのかというとそうではありません。
Server に直接指定するon_attachは特定の Server でのみ有効にしたい設定を渡すのには都合が良いです。
たとえば、自分の設定ではこのon_attachを使って、特定の Server でのみファイルの Format を無効にする設定を渡しています。
vim.lsp.start/vim.lsp.buf_attach_client
Neovim 0.8 以降では、vim.lsp.start、そしてvim.lsp.buf_attach_clientという関数が追加されました。
この 2 つは
-
vim.lsp.start: LSP Server を起動する -
vim.lsp.buf_attach_client: LSP Server を Buffer に Attach する
実は、現在の nvim-lspconfig は、この２つの関数をラップしたものになっています。
先ほどの例にあったlspconfig.lua_ls.setup({})では、これらの関数をうまいこと駆使して、Buffer の種類によって最適なサーバーを選んで起動し、プロセスを管理してくれます。
しかし、中には一部挙動が気に食わない場面も出てくるかもしれません。
そんな時に、vim.lsp.startをそのまま呼び出すことで、完璧に LSP を制御できるかもしれません。
以下に lua_ls の設定例を示します。
vim.api.nvim_create_autocmd('FileType', {
pattern = 'lua',
callback = function()
vim.lsp.start({
name = 'lua_ls',
capabilities = vim.lsp.protocol.make_client_capabilities(),
cmd = {'lua-language-server'},
root_dir = vim.fs.dirname(vim.fs.find({'.git'}, { upward = true })[1]),
})
end,
})
このように、Filetypeの autocmd を用いて、luaファイルが開かれたときにlua_lsを起動しています。
また、例えばftplugin/python.luaというファイルを作成して、そこに設定を書くこともできますね。
メリット・デメリットは以下の通りです。
メリット
- 挙動をコントロールできること
デメリット
- 有効にするファイルの種類から、root 判定のファイルの指定、さらにそもそもの LSP Server の起動コマンドの指定までが必要になること
nvim-lspconfig はこの設定が大変な部分をうまくやってくれているので、基本的には nvim-lspconfig を使うのが良いと思います。
ただ、いくつかの Server のデフォルトでの挙動の一部が自分にとってはしっくりきていない部分があるので(tsserver と denols の共存等)、その部分のみvim.lsp.startを使って書き直そうかなと思っています。
(締め切りまでに間に合わなかったので、後日追記します）
まとめ
Neovim 0.8 以降で可能な LSP の設定方法を紹介してみました。
参考になれば幸いです。
Discussion