NeovimとLua

luaでのoption設定が2021年7月時点の情報です。それ以外は、2021年2月上旬時点から更新していません。そのため、Neovim v0.5.1以上に対応していません。
この記事の最新版を書くとしても、Zennには投稿しません。MarkdownではなくAsciidocで書くからです。

vim.lsp.diagnostic を vim.diagnostic に移動するなど、HEADのBreaking Changesはこのissueにまとまっています。

NeovimのLuaプラグインを作成する場合、次のtemplateが役に立つはずです。lintとtestの設定をしているtemplate達です。

• nvim-lua-plugin-template
• m00qek/plugin-template.nvim
• ellisonleao/nvim-plugin-template (これだけlinterない)

非公式かつドラフト段階ですが、プラグインのメタデータの仕様を決める計画も進んでいます。

Luaで書かれているNeovimプラグインを沢山発見し、理由が気になり調べた結果をまとめたものです。次の3つを記載しています。

• NeovimとLuaの相性がいい理由
• Luaを利用したNeovimの設定
• Lua製のプラグインの紹介
  プラグインマネージャーやLSP,fuzzy finderなどがあります。

NeovimとLuaの関係

NeovimはLua 5.1を組み込んでおり、Luaを実行できます。そのため、Neovimのコマンドモードで lua print('Hello World') を実行すれば、 Hello world とメッセージを表示します。

NeovimとLuaが相性が良い理由

Neovimの有名なコントリビューターのTJさんは で次の5つといっています。

• 簡単
  Luaの学習コストは低く、誰でもすぐ書けます。
• Luaのサイズが小さい
  バイナリサイズ（linux用）は200KB以下です。
• 移植性
  ISO Cで実装されているため、OS Kernel内でもLuaは実行できます。
• 埋め込みに適している。
  Vim scriptからLuaの関数を呼び出すことができます。その逆もできます。
• Vim scriptよりスピードが早い
  Vim scriptなら約5.5秒かかる処理をLua(LuaJIT)は約0.003秒で処理します。

Lua単体の感想

• 配列とdict両方になるtableは慣れれば見やすい

{1, 2, 3}  -- 配列
{a = 1, b = 2, c = 3}  -- dict
{1, b = 2, 3}  -- 配列とdict

• エスケープシーケンスがいらない [[]] が便利

'a\\a'    -- a\a
[[a\\a]]  -- a\\a

• 配列のindexが1開始は慣れれば気にならない

JavaScriptのTypeScriptのように、Luaのコードに変換するtranspilersがあり、次のようなものがあります。

• TypescriptをLuaに変換するTypeScriptToLua
• coffeescriptと構文が似ているmoonscript
  nvim-moonmakerがあれば、moonscriptでNeovimのプラグイン開発ができます。
• lispと構文が似ているFennel
• Luaに型を付けたtl
• 静的型付けのHaxe

Vim scriptとLuaの比較

Luaの良い点

• 改行時の \ がいらない

Vim script

echo({ 'a': 1,
     \ 'b': 2 })  " `\` を削除するとエラー

Lua

print({ a = 1,
        b = 2 })

• 変数や関数のスコープ周りが楽

Vim script

function s:hoo(num)
  let num = 1
  " 引数の `num` ではなく、関数内で宣言した `num` の値(1)が表示されます。
  " 引数の `num` を表示させたい場合は `echo a:num` と書きます。
  echo num
endfunction

Lua

function hoo(num)
 print(num)  -- 引数の `num` が表示されます。
end

• dict時のkeyが文字列の場合、 '' で囲む必要がない

Vim script

{ 'a' : 1, 2 : 2 }

" `#{}` を使えばいりません。
" ネストする場合は、そのdictも `#{}` にする必要があります。
#{a: 1, 2: 2, d: {'a': 1}}

Lua

-- 数値の場合は `[]` で囲む必要があります。
-- 数値より文字列のkeyを使う場面が多いので、こちらのほうが楽です。
{ a = 1, [2] = 2 }

• 関数を呼ぶときに call がいらない

Vim script

" `echo` は関数ではなくコマンドなので `call` はいりません。
call foo()

Lua

foo()

• 関数やif文などの終わりが end に統一されている

Vim script

function foo()
  ...
endfunction

if i == 0
  ...
endif

for i in [1,2,3]
  ...
endfor

Lua

function foo()
  ...
end

if i == 0 then
  ...
end

for i, val in pairs({'a','b','c'}) do
  ...
end

Luaの気になる点

• ifの then やforの done
  snippetを使えば自動で挿入されるので悪い点とまでは感じません。

Lua

if i == 0 then
  ...
end

for i, val in pairs({'a','b','c'}) do
  ...
end

LuaでのNeovim設定

Vim scriptよりLuaのほうが設定は楽に感じています。大きいのが次の2点です。

• オプション（e.g. set number)やキーマップ（e.g. nnoremap <silent> <C-w>d :delete<CR>)などのコマンドを関数で実行できる
  キーマップなどで変数の値を利用するときに execute コマンドを使う必要がありません。

Lua

-- execute('nnoremap <silent> <leader>' .. l:key .. ' :' .. l:cmd .. '<CR>')
vim.api.nvim_set_keymap('n', '<leader>' .. key, ':' .. cmd .. '<CR>',
                        { noremap = true, silent = true })

• 変数のスコープが楽
  Vim scriptのように引数を参照するため a: をつける必要はありません。l や s, g などを気にするのはVim scriptの変数を利用するときのみです。

学習コスト

Vim scriptを知っている人の場合、slinさんが書いている記事も含む、次の参考資料を読めば30分もあれば理解できる印象です。Luaを知らない場合でも、Luaの文法は簡単なので合わせて1時間もあれば大丈夫な感じです。

• nanotee/nvim-lua-guide: A guide to using Lua in Neovim
• NeovimのためのLua入門 Lua基礎編
• NeovimのためのLua入門 init.lua編

変数やオプションなどの操作

LuaでNeovimの次の要素の管理や操作ができます。

Vim script変数

vim.{g|b|w|t|v|env}.<variable_name>でVim script変数を管理できます。

-- let g:hoo = 1
vim.g.hoo = 1
-- unlet g:hoo
vim.g.hoo = nil
-- let b:hoo = 1
vim.b.hoo = 1

-- let g:filename#variablename = 0
-- `''` で囲まないとエラーになります。
vim.g['filename#variablename'] = 0

-- エラーになります。
vim.b[1].hoo = 1

vim.g.hoo = {}
vim.g.hoo.key = 1
-- {} になります。 { key = 1 } にはなりません。
print(vim.inspect(vim.g.hoo))

-- 一時的な変数を使用すれば、回避できます。
vim.g.hoo = {}
local hoo = vim.g.hoo
hoo.key = 1
vim.g.hoo = hoo
-- { key = 1 } になります。
print(vim.inspect(vim.g.hoo))

vim.api.nvim_***_{set|get|del}_varでも、Vim script変数を管理できます。
vim.{b|w|t} と違い、バッファ/ウィンドウ/タブを指定できます。

• グローバル（g:): nvim_set_var
• バッファ（b:): nvim_buf_set_var
• ウィンドウ（w:): nvim_win_set_var
• タブ（t:): nvim_tabpage_set_var
• Vimの定義済（v:): nvim_set_vvar

option

vim.{o|go|bo|wo}.<option_name>でoptionの値を変更・取得できます。

-- set cmdheight=2
vim.o.cmdheight = 2
-- set cmdheight?
print(vim.o.cmdheight)

-- 切り替えオプションはbooleanを利用します。
-- set noruler
vim.o.ruler = false

-- 略名も使えます。
-- set slm=""
vim.o.slm = ""

-- optsには {cmdheight = 2, ...} のようなオプションと値のobjectが格納されています。
for opt, val in pairs(opts) do vim.o.[opt] = val end

setのようにグローバルとローカル両方変変更したい場合は o を使います。

-- set cmdheight=1
vim.o.winminheight = 1

setglobal のようにグローバルの値だけを変更する場合は go
setlocal のようにローカルの値だけを変更する場合は bo or wo を使います。
:help '<option-name>' で表示されるhelpに
global ならグローバル、local to {window|buffer} ならローカルオプションです。

-- setglobal laststatus=0
vim.go.laststatus = 0
-- setlocal nonumber
vim.wo.number = false

ローカル（bo or wo)の場合は、バッファとウィンドウの番号を指定できます。
0の場合は、カレントバッファ/ウィンドウを指定します。

vim.bo[0].tabstop = 2

opt も o と同じように set のように動作します。
オプションの値を返すとき、o と opt で値が違います。
o の場合は文字列、数値、真偽値を返します。
opt の場合はoption objectを返します。

-- set showtabline=0
vim.opt.showtabline = 0

print(vim.o.colorcolumn)                       -- 80
print(vim.inspect(vim.opt.colorcolumn))        -- { _info = {  ... },  _name = "colorcolumn", _value = "80", <metatable> = <1>{ ... } }
print(vim.inspect(vim.opt.colorcolumn:get()))  -- { "80" }

set+= set-= set^= と同じ動作をするメソッドが opt にはあります。

-- set tabstop+=10
vim.opt.tabstop:append(10)
vim.o.tabstop = vim.opt.tabstop + 10
-- set tabstop-=10
vim.opt.tabstop:remove(10)
vim.o.tabstop = vim.opt.tabstop - 10
-- set backupdir^='~/.config/nvim'
vim.opt.backupdir:prepend('~/.config/nvim')

opt は set に対応しており、
opt_global は setglobal、opt_local は setlocal に対応しています。

-- setlocal foldlevel+=2
vim.opt_local.foldlevel:append(2)
lua vim.wo.foldlevel = vim.wo.foldlevel + 2

vim.api.nvim_***_{set|get}_optionでも、optionの値を変更・取得できます。
ただ、set や vim.o のようにグローバル・ローカル両方の値を変更できません。

• go: nvim_set_option
• bo: nvim_buf_set_option
• wo: nvim_win_set_option

Keymap

vim.api.nvim_set_keymapとvim.api.nvim_buf_set_keymapを使います。

-- nnoremap <silent> <C-w>d :bdelete<CR>
vim.api.nvim_set_keymap('n', '<C-w>d', ':bdelete<CR>',
                        { noremap = true, silent = true })

-- mapsには {l = 'Lint', ...} のようなkeyとコマンドのdictが格納されています。
for key, cmd in pairs(maps) do
  vim.api.nvim_set_keymap(
    'n',
    '<leader>' .. key
    ':ALE' .. cmd .. '<CR>',
    { noremap = true, silent = true }
  )
end

vim.keymap.nnoremap { '<leader>h', function() print("Hello world") end } のような書き方ができるAPIを開発中です。astronauta.nvimをインストールすると、開発中のAPIを使用できます。

関数

vim.fn.<func_name>を使います。

-- call abs(1)
vim.fn.abs(1)

-- call filename#funcname(1)
vim.fn['filename#funcname'](1)

Vim script実行

vim.cmdを使います。

-- echo 123
vim.cmd('echo 123')

次の設定のinterfaceは現在実装されていませんが、実装される予定はあります。
vim.cmd でVim scriptを書いても設定できます。

• User commandの作成
• autocmdの定義
• Syntax/Highlightの定義
  colorbuddy.nvim: Your color buddy for making cool neovim color schemes

Luaファイルの読み込み

Vim scriptで書かれた設定 init.vim の代わりに、luaで書かれた設定 init.lua を読ませることができます。 init.lua を置く場所は init.vim と同じです。両方は読み込めず、両方ある場合は Conflicting configs: ... のメッセージが表示されます。

require

require('file_path') でluaファイルをモジュールとして読み込みます。Neovimの runtimepath ディレクトリ内の lua ディレクトリに格納されているLuaファイルを require で読み込めます。

例

init.vim

• lua require('plugins')
~/.config/nvim/lua/plugins/init.lua を読み込みます。
• lua require('plugins.completion')
~/.config/nvim/lua/plugins/completion.lua を読み込みます。
• lua require('plugins/completion')
. or / どっちでもOKです。 . のほうがよく見ます。

# `~/.config/nvim` は `runtimepath` に含まれるディレクトリです。
~/.config/nvim
> ls init.vim lua/plugins/
init.vim

lua/plugins/:
completion.lua               finder.lua  linter.lua    parser.lua
download_plugin_manager.lua  git.lua     lsp.lua       status_and_tab_line.lua
filer.lua                    init.lua    markdown.lua  template.lua

require はモジュールをキャッシュします

require でロードしたモジュールを変更した後、変更したモジュールをもう1度 require しても、モジュールは更新されません。どのモジュールをロードしたか require が記憶しているからです。
packer.loaded グローバルテーブルを変更すれば、モジュールを更新できます。

package.loaded['module_name'] = nil
require('module_name')

モジュールを更新するプラグイン

• lreload.nvim
  Luaモジュールのhot-reloadingができます。
• nvim-lua/plenary.nvim
  Luaライブラリで、モジュール更新をする関数があります。

自動で読みこまれるLuaファイル

runtimepath内の特定のフォルダ内にあるluaファイルを自動的に読みこみます。
現在、次のフォルダ内のluaファイルを読みこみます。

• colors
• compiler
• ftplugin
• ftdetect
• indent
• plugin
• syntax

Luaと他言語のプラグインの違い

他言語よりLuaで実装したプラグインのほうが処理速度は速いです。LuaはNeovim内部で動くため、プラグインとNeovim間のRTT(Round-Trip Time)が他の言語より短いです。

Vim scriptやLua以外の言語はRPC(MessagePack-RPC)を使用して、Neovimを動かせます。Luaと違いNeovim内部で完結しているわけではないため、LuaよりRTTが長くなります。

Vim9 script

VimでもVim scriptを改良したVim9 Scriptを開発中です。今までのVim scriptより書きやすく、速度も改善されています。LuaJITが有効ではないLuaより処理速度が速いです。開発中なので処理速度は今より速くなる可能性があります。Vim8.2のhelp fileに記載されている通り、開発中のVim9 scriptはVim8.2で試せます。

NeovimがVim9 Scriptに対応するかどうかは調べておらず、対応するという情報は見つけていません。ただ、NeovimのコントリビューターのTJさんがLuaJITとLPEGを利用してVim9 scriptのparserを開発しているようです。

Lua製のプラグイン

紹介するプラグインの大半は、開発中のv0.5のNeovimであることが必須条件です。

Packer.nvim

emacsのuse-packageに触発されたplugin/package managerです。
Packer.nvimの作者によるdein.vimとの比較

特徴

• Native Packagesを使ってプラグインを読み込む
  プラグインの読み込みは packadd を利用する packages なため、Packer.nvim を利用しないor削除してもプラグインは読み込まれます。
• Luaで設定を書ける
• プラグインの遅延読み込みができる
• プラグインの依存関係を設定できる
• Post-install/update hook対応
• Luarocks対応

# `~/.local/share/nvim/site` はpackpathに含まれます。
# packpathの `~/.local/share/nvim/site` にある `pack` ディレクトリ内の
# `packer` がpacakgesになります。
~/.local/share/nvim/site/pack/packer
> ls opt/ start/
# 起動時に読み込まないプラグイン
opt/:
ale                    neosnippet.vim           popup.nvim            vim-fugitive
auto-pairs             nnn.vim                  preview-markdown.vim  vim-quickrun
completion-buffers     nvim-treesitter          sonictemplate-vim     vim-surround
completion-nvim        nvim-treesitter-context  tcomment_vim
completion-treesitter  packer.nvim              telescope.nvim
neosnippet-snippets    plenary.nvim             undotree

# 起動時に読み込むプラグイン
start/:
indentLine  nvim-lsp  tokyonight-vim  vim-gitgutter  vimdoc-ja

return require('packer').startup(function()
  -- `packer.nvim` を管理するプラグインに追加します。
  -- `opt` はプラグインの設定の1つです。値の意味は後述します。
  use { 'wbthomason/packer.nvim', opt = true }

  -- 1つの `use` で複数のプラグインを追加できます。
  use { 'tpope/vim-fugitive', 'airblade/vim-gitgutter' }
  use {
    {
      'nvim-lua/completion-nvim',
      event = 'InsertEnter *',
      config = function() vim.cmd('packadd completion-buffers') end
    },
    { 'steelsojka/completion-buffers', opt = true },
  }
end)

use {
  'tpope/vim-fugitive',
  config = function()
    local maps = {s = 'status', ... }
    for key, cmd in pairs(maps) do
      vim.api.nvim_set_keymap('n', '[git]' .. key, ':G' .. cmd .. '<CR>',
                              { noremap = true, silent = false })
    end
  end
}

return require('packer').startup(function()
  -- for _, path in pairs{ 'git', ... } do use(require('plugins.' .. path)) end
  -- でもOKです。
  vim.tbl_map(
    function(path) use(require('plugins.' .. path)) end,
    {
      'git', 'template', 'linter', 'status_and_tab_line', 'parser', 'finder',
      'lsp', 'filer', 'completion', 'markdown'
    }
  )
end)

return {
  {
    'tpope/vim-fugitive',
    -- 長いコード
  },
  {
    'airblade/vim-gitgutter'
  }
}

# `~/.config/nvim` はruntimepahtに含まれるディレクトリです
~/.config/nvim
> ls init.vim lua/plugins/
init.vim

lua/plugins/:
completion.lua               finder.lua  linter.lua    parser.lua
download_plugin_manager.lua  git.lua     lsp.lua       status_and_tab_line.lua
filer.lua                    init.lua    markdown.lua  template.lua

use {
  'skanehira/preview-markdown.vim',

  -- プラグインを読み込むトリガーが2つある場合、
  -- 1つでも条件が成立したときに
  -- プラグインは読み込まれます。
  ft = 'markdown',
  cmd = 'PreviewMarkdown',
  setup = function()
    -- `<M-r>m` で `cmd` のコマンドを実行するので、
    -- `<M-r>m` を押せば、プラグインは読み込まれます。
    -- `setup` ではなく `config` にキーマップのコードを書いた場合、
    -- プラグイン読み込み時にキーマップが登録されるので、
    -- `<M-r>m` を押しても何も反応せず、プラグインも読み込まれません。
    vim.api.nvim_set_keymap('n', '<M-r>m', ':PreviewMarkdown<CR>',
                            { noremap = true, silent = true })
  end,
  config = function()
    vim.g.preview_markdown_parser      = "mdcat"
    vim.g.preview_markdown_vertical    = 1
    vim.g.preview_markdown_auto_update = 1
  end
}

use {
  ...
  requires = { 'depend/plugin' },
},

-- PackerCleanすると両方のプラグインは削除されます。
use {
  'plugin/a',
  opt = true,
  -- プラグインを無効にして利用しないようにします。
  disable = true,
  requires = { 'plugin/a', opt = true },
}

-- 1つの `use` で複数のプラグインを設定している場合
-- `plugin/a` のみ削除されます。
use {
  { 'plugin/a', opt = true, disable = true },
  { 'plugin/b', opt = true },
},

use {
  'iamcco/markdown-preview.nvim',
  -- Install,Update時に実行する処理
  run = 'cd app && yarn install'
}

" `packer_compiled.vim` は `PackerCompile` で生成するファイル
Error detected while processing ... /plugin/packer_compiled.vim:
line  297:
E5108: Error executing lua [string "..."]:0: module 'aaa' not found:
        no field package.preload['aaa']
        no file './aaa.lua'
	...

use {
  -- `{}` に囲まれていないため
  -- `{ 'nvim-lua/completion-nvim', { ... }` と
  -- 同じ設定になります。
  'nvim-lua/completion-nvim',
  event = 'InsertEnter *',
  config = vim.cmd('packadd completion-buffers')
  { 'steelsojka/completion-buffers', opt = true },
}

-- `requires` の場合も同じなのでtableにする必要があります。
use {
  ...,
  requires = {{ 'plugin/a', opt = true }, { 'plugin/b', opt = true }}`
}

nvim-lspconfig

v0.5で実装される組込みのLSP(Language Server Protocol)クライアント用の共通設定集です。

組み込みのLSPクライアントの設定が簡単になるだけで、これがないと組み込みのLSPクライアントが使えず、LSPの機能が使えないというわけではありません。クライアントはneovim本体に組み込まれており、Luaで書かれています。なぜNeovimにLSPクライアントが組み込まれたかはtjさんの動画が参考になります。

vim-lspやcoc.nvim,LanguageClient-neovimなどの有名なLSPクライアントとNeovimの組み込みのLSPクライアントとの違いなどは次の記事を参考にしてみてください。

• Vim で使える LSP クライアント各種を使った感想
• Why I still prefer LSC to Neovim LSP + completion.nvim, even as Neovim user : neovim

利用方法

Luaのlanguage serverを利用するには次の手順でやります。

1. nvim-lspconfigをインストール
2. LuaのLSP serverのsumneko_luaをインストール
   両方ともbuild systemのninjaが必要です。
   • 手動
     sumneko_luaのwikiの手順でインストールします。
     CONFIG.mdの設定をそのまま使用したいので git clone https://github.com/sumneko/lua-language-server は git clone https://github.com/sumneko/lua-language-server ~/.cache/nvim/lspconfig/sumneko_lua/lua-language-server に変更します。
   • nvim-lspinstallを利用
     nvim-lspinstallをインストールし、 LspInstall sumneko_lua コマンドを実行します。
     ~/.local/share/nvim/lspinstall/lua-langauge-server に配置されます。
3. init.vim or init.lua にCONFIG.mdの設定を追加
   nvim-lspinstallの場合は sumneko_root_path を vim.fn.stdpath('data') .. '/lspinstall/lua-langauge-server' に変更してください。
4. Neovimを再起動
5. set ft=lua で編集中のバッファをluaに変更する
6. sumneko_lua が起動して、編集中のバッファに接続する
   診断機能が有効になっているのでsyntax errorがあると、syntax errorの診断メッセージがvirtual textで表示されます。
   LspInfo で起動しているLSPクライアントや編集中のバッファと接続しているLSPクライアントの情報がわかります。動かない場合は checkhealth を実行してみましょう。

定義ジャンプやsymbol参照などの方法は help lsp-config やslinさんのNeovimのBuiltin LSPを使ってみるを参照してください。LSPで何ができるかは北川亮さんのvim-lspでできることも参考になります。vim-lspについて書いてますが、大体はNeovimの組み込みのLSPでもできるはずです。

注意事項

LspIntall と LspInstallInfo の廃止

Remove all installers and install logic #498により廃止されました。Pull requestの作成者のmjlbachさんのコメントを読むと次の2点があるようです。

• LSP serverが古いせいで発生するbugを修正する仕組みがない
• LSP serverをインストールできるソース(npm, linux package manager, brew)が多種多様で、全てをサポートするのが大変

今後LSP serverをインストールする際は次の手段があります。

• CONFIG.mdを読みながら手動でする
• vim-lsp-settingsを使う
• nvim-lspinstallを使う
  CONFIG.mdの全てをまだインストールできません。将来的には全てできる予定です。
• nvim-lspupdateを使う
  インストールとアップデート、両方できます。

LSP関連の他のプラグイン

• lspsaga.nvim
  定義や参照一覧、定義やdocument情報をfloating windowで表示できます。
• nvim-lsputils
  使用できるcode actionsをfloating windowで表示したり、定義ジャンプやsymbol参照の一覧とそのpreviewをquickfixを使って表示できます。
• nvim-lspfuzzy
  FZFを利用して、定義ジャンプなどのLSP操作を行います。
• nvim-lightbulb
  現在の行で textDocument/codeAction ができるか表示します。
• aerial.nvim
  Symbolsを目次形式で表示し、選択したsymbolに移動します。
• folding-nvim
  折りたたみにLSPを使います。
• nvim-lsp-smag
  NeovimにLSPをシームレスに統合できるようにして、タグファイルまたは vim.lsp.client を利用する処理全体を単純化します。 tagfunc オプションを利用して、tagの検索方法をカスタマイズできます。
• lsp-status.nvim
  組み込みのLSPクライアントからstatuslineのcomponentを生成します。
• onsails/lspkind-nvim
  VSCode-like iconsを追加します。
• lsp_extensions.nvim

diagnostics

• nvim-ale-diagnostic
  Neovim LSPのdiagnostics結果をaleで表示します。

言語特有のプラグイン

• nvim-lsp-ts-utils
  TypeScriptの開発を支援します。
  • importの整理(LspOrganize)
    未使用importの削除&並べ替えを行ないます。
  • 現在行に利用可能なコードアクション（vim.lsp.buf.code_action())を利用（LspFixCurrent)
    複数ある場合は1番最初のコードアクションを実行します。
  • ファイル名変更とimportの更新（LspRenameFile)
  • 足りないimportを追加（LspImportAll)

組み込みのLSPクライアントとcoc.nvimの違い

nvim-lspconfigのコントリビューターのmjlbachさんのコメントを自分なりに解釈して、それをまとめた文です。

• 組み込みのLSPクライアントは拡張性が高く、neovimの設定を変更すれば多くの点を変更できる
  全てluaで書かれているため、簡単にカスタマイズできます。ハンドラベースで、動作を上書きするのも非常に簡単です。
• nvim-lspconfigはCocプラグインと同等の機能を提供しない
  エコシステムではなく、最低限のdefault機能を提供するのをnvim-lspconfigは目的としているからです。nvim-jdtlsのようなCocプラグインと同等の機能を持ったプラグインは今後増えていく可能性があります。

参考にしたコメント

• Why should I use the in built LSP over coc.vim? : neovim
• How to use (and contribute) to neovim's built-in language server client and nvim-lspconfig : neovim

nvim-treesitter.nvim

Tree-sitterの設定をするプラグインです。Neovimに存在するtree-sitterのlibraryを利用しています。

Tree-sitterとは

機能

• highlight
  今まで色がついてない部分に色がつきます。
• Incemental selection
  textobject単位の選択の拡大ができます。
• Indent
  Indentを整える（={motion})処理をTreesitterのparseをもとにおこないます。

追加モジュールとプラグイン

モジュール

• textobject

  • ip や ap のようにtextobjectを選択します。
  • 前後のtextobjectに移動します。
  • 関数の引数などの順番の前後を交換します。
  • textobject全体をfloating windowを使って表示します。
    Neovimの組み込みのLSPが必要です。
  • textobjectは設定で変えられます。
    言語によって利用できるtextobjectは違います。今後追加される可能性があります。

• refactor

  • カーソルの下にあるsymbolの定義位置に移動したり、定義されているsymbol一覧を表示します。
  • カーソルの下にあるsymbolをrenameします。
    同じスコープ内のsymbolが対象のため、違うスコープ内のsymbolはrenameされません。
  • カーソルの下にあるsymbolをhighlightします。
    同じスコープ内のsymbolが対象のため、違うスコープ内のsymbolはhighlightされません。
    Colorschemeの設定でhighlightされているか分かりづらいことがあります。
  • カーソルが存在するスコープ全体をhighlightします。
    Colorschemeの設定でhighlightされているか分かりづらいことがあります。

• rainbow
  vim-rainbowのように括弧（e.g. {([])})の色をネストごとに変更します。

• nvim-ts-autotag
  HTMLタグの終了タグを自動的に挿入します。rename機能もあります。HTML専用のようです。

プラグイン

• context
  関数の引数部分や直近のif文の条件を常に表示させるようにします。リンク先のgifを見ればどんな機能かわかります。
  tree-sitterなしで同じ機能をcontext.vimでもできますが、信頼性が低く、正しく表示できないことがあるみたいです。 context.vim が nvim-treesitter-context の機能を統合する予定はあるようです。

• sidekick.nvim
  関数や変数一覧を表示し、選択した定義に移動します。

他にも拡張モジュールやプラグインはあります。

Command

• TSInstall {language}
language のparserをインストールします。 TSInstall のときにtabを押せば対応している言語一覧が表示されます。 all の場合全てインストールします。
  checkhealth でインストールしたparserの状態を確認できます。
• TSUninstall {language}
language のparserをuninstallします。
• TSInstallInfo
  対応している言語のparserをインストールしているか確認できます。
• TSUpdate
  インストールしているparser全てをupdateします。
• TSConfigInfo
  tree-sitterの設定情報を表示します。

設定方法

context以外の機能はモジュールにあたり、デフォルトで無効になっているため動きません。動かすには TSEnableAll <機能名> を使うか設定を変えます。contextはデフォルトで有効になっているため動きます。

require'nvim-treesitter.configs'.setup { -- 設定された言語のparserがインストールされていない場合、
  -- インストールします。
  ensure_installed = {'ruby', 'lua'},

  highlight = {
    -- `false` の場合、highlight機能を動かしません。
    enable = true,

    -- highlightの機能を無効にする、filetypeを指定します。
    disable = { "bash", "c" },
  },

  incremental_selection = {
    enable = true,

    keymaps = {
      -- 範囲選択を開始します。
      init_selection = "gnn",

      -- 1つ上のnodeに選択範囲を拡大します。
      node_incremental = "grn",

      -- 1つ上のスコープに選択範囲を拡大します。
      scope_incremental = "grc",

      -- 1つ下のnodeに選択範囲を縮小します。
      node_decremental = "grm",
    },
  },

  indent = {
    enable = true
  },

  textobjects = {
    -- `ip` や `ap` のようにtextobjectを選択します。
    select = {
      enable = true,
      keymaps = {
        ["af"] = "@function.outer",
        ["if"] = "@function.inner",
        ["ac"] = "@class.outer",
        ["ic"] = "@class.inner",
      },
    },
    -- 前後のtextobjectに移動します。
    move = {
      enable = true,
      goto_next_start = {
        ["]m"] = "@function.outer",
        ["]]"] = "@class.outer",
      },
      goto_next_end = {
        ["]M"] = "@function.outer",
        ["]["] = "@class.outer",
      },
      goto_previous_start = {
        ["[m"] = "@function.outer",
        ["[["] = "@class.outer",
      },
      goto_previous_end = {
        ["[M"] = "@function.outer",
        ["[]"] = "@class.outer",
      },
    },

    -- 関数の引数の位置を交換します。
    swap = {
      enable = true,
      swap_next = {
        ["<leader>a"] = "@parameter.inner",
      },
      swap_previous = {
        ["<leader>A"] = "@parameter.inner",
      },
    },

    -- textobject全体をfloating windowを使って表示します。
    lsp_interop = {
      enable = true,
      peek_definition_code = {
        ["df"] = "@function.outer",
        ["dF"] = "@class.outer",
      },
    },
  },
  refactor = {
    -- カーソルの下にあるsymbolの定義位置に移動したり、
    -- 定義されているsymbol一覧を表示します。
    navigation = {
      enable = true,
      keymaps = {
        -- 定義に移動します。
        goto_definition = "gnd",

        -- 定義一覧を表示します。
        list_definitions = "gnD",

        -- 定義一覧を本の目次のようにネストがわかるように表示します。
        list_definitions_toc = "gO",

        -- カーソル下のsymbolの前後の利用位置に移動します。
        goto_next_usage = "<a-*>",
        goto_previous_usage = "<a-#>",
      },
    },

    -- カーソルの下にあるsymbolをrenameします。
    smart_rename = {
      enable = true,
      keymaps = {
        -- `grr` でrename処理が開始できます。
        smart_rename = "grr",
      },
    },
    -- カーソルの下にあるsymbolをhighlightします。
    highlight_definitions = { enable = true },

    -- カーソルが存在するスコープ全体をhighlightします。
    highlight_current_scope = { enable = true },
  },

  -- 括弧の色をネストごとに変更します。
  rainbow = {
    enable = true
  },
}

Colorschemes

nvim-treesitterから定義されたhighlight groupを利用しているcolorschemesがあります。

• nvim-treesitterのWiki
  colorschemeのpreviewがあります。
• awesome-neovim
• nvcode-color-schemes.vim
  

completion-nvim

非同期の補完フレームワークです。組み込みのLSPに補完を提供するのが目的です。

機能

• 選択した補完のドキュメント情報を表示

• Snippet pluginとの連携
  g:completion_enable_snippet で設定できます。デフォルトの値は v:null です。
  新しいsnippet pluginのdeoppet.nvimを開発しているShougoさんのスニペットプラグインについて 2020 年版を読めば利用できるSnippetの特徴がわかります。

  • snippets.nvim
  • Neosnippet
  • UltiSnips
  • vim-vsnip
    vim-vsnip-integがあればLSPを利用したsnippetも利用できます。ただ、neovimのbuilt-inのLSPのsnippetのデフォルト設定が無効に変更されたため、LSPの設定を変更する必要があるようです。また、vim-vsnip作成者の さんも自動補完プラグインのnvim-compeを開発しています。

• 補完のsourceを追加

  • buffer
  • treesitter
  • tags
  • tabnine
  • dadbod

設定方法

• 全てのバッファで機能を有効する場合
  autocmd BufEnter * lua require'completion'.on_attach()
• LSPが有効なバッファ場合のみ機能を有効する場合

" `vimls` の部分は使用するlnaguage serverに変更してください。
lua require'lspconfig'.vimls.setup{on_attach=require'completion'.on_attach}`

telescope.nvim

NeovimのコントリビューターのTJさんが作成している組み込みのLSPやtree-sitterとの連携ができるfuzzy finderです。
fzfやfzy,skとの依存性はありません。fzfやfzyと連携したい場合は拡張機能を利用してください。
プレビュー表示もあり、batがあれば色付きで表示されます。
今回紹介する残りのfuzzy finderと違いtree-sitterと連携できます。

TJさんはこのtelescopeも含むプラグインやneovimの新機能の開発をtwitchで配信しています。redditのneovimのコミュニティでスレッドをたてたりコメントもしています。telescopeの作成理由もyoutubueに投稿しています。

fzfやfzf-preview,denite,ctrlpなどとの違いは、Tips集のKatapediaとプラグインの選択・管理のポイントを記載しているVimプラグイン"の"カテゴリまとめの作者のyutakatayさんのVimにたくさんあるファジーファインダー系プラグインを比較してみるを参考にしてみてください。

Picker

コマンドラインでの使い方

Telescope <piker_name> で実行できます。

• Telescope builtin
  オプションなし
• Telescope git_files cwd=~/dotfiles
  オプションを設定
• Telescope find_files find_command=rg,--ignore,--hidden,--files
  table型のオブションの場合は , で区切る

次のpicker達は全てtelescopeに組み込まれています。独自のpickerを追加したい場合はREADMEのCustomizationやWikiのConfiguration Recipesが参考になります。

組み込まれているpickerの紹介動画一覧

Layout

リストやプレビューなどのレイアウトは設定できます。デフォルトのレイアウトだと、ディスプレイが縦だとプレビューが表示されません。Dropdownを使えば縦画面でもプレビューは表示されます。

デフォルトのレイアウトを変更するには次のようにします。値はsupported layoutsが利用できます。

require'telescope'.setup{
  -- 画面幅に応じたレイアウトになるため、
  -- ディスプレイの向き関係なく、
  -- プレビューが表示されます。
  defaults = {layout_strategy = 'flex'}
}

拡張機能

• DAP(Debug Adapter Protocol)
  • vimspector
    PythonとVim scriptで書かれているvimspectorを利用します。
  • dap
    Luaで書かれているnvim-dapを利用します。
• fuzzy finder
  • fzf
  • fzy
• frecency
  MozillaのFrecencyアルゴリズムを利用して、最近使ったファイルの優先順位を高くします。
• github
  IssueやPull Request,gistを表示します。
• ghq
  ghq list の結果を表示します。

Package Manager

• paq-nvim
  シンプルなwrapperを目指している、小さい(約175行)なpackage managerです。Packerとは目指しているものが違うため、依存関係の設定や遅延読み込みはできません。

Fuzzy Finder

• nvim-fzf
  fzfを利用します。fzf.vimより使いやすく、カスタマイズ性が高いと主張しています。ただ、Files や History などのpickerは標準で実装されていません。Action APIでneovimの関数を利用して、preview windowに表示する情報を変更できます。これを利用するためにfzf.vimを削除する必要はありません。
• fuzzy.nvim
  telescopeから多くのアイデアを取り入れて作成されました。シンプルなAPIなので他のfuzzy finderのバックエンド追加は簡単です。組み込みのLSPを利用するコマンドも実装しています。
• FZTerm
  fzfを利用しています。こちらも組み込みのLSPにも対応しており、git blameのコマンドを実装しています。全てをカスタマイズできることを重視しているため、telescopeより拡張するのは簡単みたいです。
• nvim-fzy
  fzyに依存しています。

Statusline

• express_line.nvim
  Gitの情報を取得する関数が実装されています。組み込みのLSPの情報を取得する場合はlsp-status.nvimを使えばいいようです。
• galaxyline.nvim
  組み込みのLSPやcoc.nvimの診断結果を表示する関数があります。
  Gitの情報を取得する関数がありますが、ブランチ名取得以外は次のgit signを表示するプラグインが必要です。
  • vim-gitgutter
  • vim-sifnify
  • gitsigns
• lualine.nvim
  速さと簡単な設定を売りにしています。lightlineやairlineより速く、0.1秒でプラグインを読み込みます。テーマはいくつか内蔵されており、 lualine.theme = 'onedark' のように設定します。
  galaxylineと比較した際、使いやすさはlualine、カスタマイズ性の高さはgalaxylineが良いと作者がredditでコメントしています。
• neoline.vim
  lightline.vimにインスパイされて作られており、statusとtab両方とも変更できます。
• nvim-hardline
  vim-airlineにインスパイアしており、簡単で軽いのを目標として作られています。statusとtab両方とも変更できます。
• statusline.lua
  設定は必要せず、他のプラグインと連携してgitの情報などを表示します。Tablineも変更できます。
  表示する情報と連携できるプラグイン
  • Git diff: vim-signify
  • Git branch: vim-fugitive
  • Lint status: ale
• bubbly.nvim
  モードやファイル名をbubbleのような丸で表示します。

Tabline

• barbar.nvim
  • 全てのバッファをtablineに表示
  • tabの並び替え
  • ファイル名が同じバッファを開いた場合ディレクトリ名を追加して重複表示を防ぐ
• nvim-bufferline.lua
  バッファ選択や並び替えもできます。barbar.nvimと違う点は、1つのウィンドウで複数のバッファを開いているときにそのバッファだけをタブラインに表示するMulti-window modeがあることです。

補完

• nvim-compe
  vim-vsnip作成者のhrsh7thさんが開発している補完プラグインです。組み込みのLSPやvim-vsnip、hrsh7thさんが開発しているLSPクライアントのvim-lampと連携できます。

括弧・テキストオブジェクト

• nvim-autopairs
  lexima.vimのように閉じ括弧などを自動入力します。
• nvim-ts-autotag
  HTMLタグの終了タグを自動的に挿入します。rename機能もあります。HTML専用のようです。nvim-treesitterに依存しています。
• surround.nvim
  vim-surroundのように括弧や引用符などで囲まれているテキストを編集できます。

インクリメント・デグリメント

• dial.nvim
  日付（日本語も含む）やアルファベット、Markdownのヘッダー(#)をインクリメント・デクリメントできます。独自のインクリメント・デクメントも定義できます。
• nrpattern.nvim
  標準のインクリメント・デクリメントを拡張します。dial.nvimとは違い、日付やアルファベットは自分で拡張しないとできません。独自のインクリメント・デクメントの定義はdial.nvimより設定項目が多いです。

デバック

• nvim-dap
  vimspectorのようにDAP(Debug Adapter Protocol)クライントをneovimに実装します。nvim-dap-virtual-textを使えば結果をvirtual textとして表示できます。また、telescopeと連携する拡張機能があります。

Linter/Formater

• format.nvim
  編集中のバッファをに対してformatを非同期で実行します。Luaで書かれている同じformatterプラグインのformatter.nvimのPRとして最初書いてましたが、アプローチを変えるため全て書き直して作成されました。

REPL

• iron.nvim
  NeovimからREPLを実行できるようにします。

Quickfix

• nvim-bqf
  quickfixを拡張します。
• popfix
  拡張性の高いquickfixとfloating windowのAPIを提供します。

インデント

• indent-guides.nvim
  vim-indent-guidesのようにindentに色をつけて表示します。VSCodeのindent-rainbowのような機能を実装予定です。

検索

• nvim-hlslens
  検索にヒットした行の右にvirtual textで何件目か表示します。virtual textの内容やhighlightは変更できます。

Git

• gitsigns.nvim
  vim-gitgutterのように、diffの結果を記号で行の左端に表示します。
• git-blame.nvim
  git blameをvirtual textとして表示します。
• neogit
  Emacsからgitリポジトリ操作ができるMagitのNeovim版です。Vimの概念に合わせていくつか変更する予定があります。

GitHub

• octo.nvim
  IssueとPRをNeovimから操作できます。 ListIssues <repo> でtelescopeと連携できます。
• codeql.nvim
  コードの脆弱性を発見するCodeQLを実行できます。

コメント

• prodoc.nvim
  コメント化・アノテーション追加します。
• kommentary
  コメントの切り替えを行います。

エクスプローラー

• nvim-tree.lua
  ツリー形式で表示します。ファイルの追加や削除、名前変更ができ、gitとの連携もできます。
• lir.nvim
  シンプルなエクスプロラーで、ディレクトリ表示時(e.g. e .)に Netrw の代わりに利用できます。
• dirbuf.nvim
  nvim-treeやvim-dirvish,vidirにインスパイアされています。
• neofs
  floating windowで表示します。

Colors

• nvim-colorizer.lua
  カラーコードのプレビューができ、外部依存関係はありません。
  同じ機能を持つvim-hexokinaseはGo言語が必要です。
• lush.nvim
  colorscheme作成を支援します。色の変更をリアルタイムで反映します。

プロジェクト管理

• nvim-projectconfig
  ~/.config/nvim/projects/{プロジェクト名} (変更可能）にある、プロジェクト専用の設定ファイル（Vimscript or lua)を読み込みます。
  lua require('nvim-projectconfig').load_project_config() で設定ファイルの読み込み、lua.require("nvim-projectconfig").edit_project_config() で設定ファイルを開きます。

ヘルプ

• nvim-cheat.sh
  cheat.shを利用して、色んなコマンドを表示します。

共同編集

• instant.nvim
  複数人で同じバッファを共有するライブ編集ができます。

コピー/ペースト

• nvim-miniyank
  kill-ringのように、yankの履歴を使えるようにします。

ターミナル

• nvim-toggleterm.lua
  neotermのように複数のターミナルウィンドウを簡単に管理できます。
• FTerm.nvim
  ターミナルをfloating windowで表示します。

アイコン

• nvim-web-devicons
  ファイルタイプのアイコンを追加するvim-deviconsのlua番
• nvim-nonicons
  Noniconsを利用したアイコンセットです。deviconとcodiconはcui用に設計されていないため、ターミナルだと見難いアイコンがあるため使用していないそうです。また、deviconはフォント間の統一性がなく、codiconにはファイルタイプのアイコンがないそうです。
• codicons.nvim
  VSCodeのcodiconを簡単に利用できるようになります。

スクロールバー

• scrollbar.nvim
  スクロールバーの見た目を変更します。

ウィンドウ

• wintablib.nvim
  ウィンドウやタブを操作する関数を提供します。
  • 左 or 右の全てのタブを閉じる
  • 左 or 右のタブのバッファを、現在のタブで開く
  • 編集中のバッファを新規タブで開く
    タブは左右どちらに配置するか決めることができます。
  • 全てのfloating windowを閉じる
  • 上下左右のwindowを全て閉じる

マウス

• gesture.nvim
  マウスジェスチャーができるようになります。

コマンドライン

• cmdbuf.nvim
  q => : で開けるコマンドラインウィンドウをバッファとして開きます。

モーション

• hop.nvim
  vim-easymotionのLua版で、1から書き直しています。
• train.nvim
  モーションを拡張します。

セッション

• auto-session
  自動でセッションを保存、読み込みを行ないます。

Markdown

• glow.nvim
  Floating windowにglowでレンダーしたMarkdownを表示します。glowを使うのでGo言語が必要です。同じ機能を提供するpreview-markdown.vimとは次が違います。
  • Floating windowで表示
  • 対応レンダーはglowのみ
    preview-markdownはmdrとmdcatにも対応しています。ただ、 glow.nvimの open_window 内の api.nvim_call_function("termopen", {string.format("glow %s", path)}) の glow を mdcat にコードを変更すれば mdcat でも動きます。
  • 自動更新機能なし
    preview-markdownは自動更新できますがVimのみでNeovimは対応していません。

設定

• fey_neovim
  Doom Emacsにインスパイアされた設定フレームワークで、minpacをパッケージマネージャーに使っています。

Luaのプラグイン作成に役立つプラグインやドキュメント

プラグイン

• nlua.nvim
  Lua開発に役立つ機能を提供します。
• nvim-luadev
  Luaプラグイン用のREPLとdebug機能を提供します。
• nvim-luapad
  入力しているLuaのコードをリアルタイムで実行します。
• manillua.nvim
  Luaの折りたたみ表示を見やすくします。
• lreload.nvim
  Luaモジュールのhot-reloadingができます。

Library

• plenary.nvim
  Neovim専用のluaライブラリです。Luaモジュール用のpackage mangerのLuaRocksを使ってlua packageをインストールできます。
• popup.nvim
  VimのPopup APIと互換性があるAPIをNeovimに実装します。
• vlog.nvim
  Luaプラグインに簡単にログファイルを実装できます。依存性はありません。
• neovim-plugin
  プラグインのキーマップやコマンド、イベント設定をLuaのtable形式で設定できます。
• impromptu.nvim
  コマンドや関数を呼び出すためのプロンプトを簡単に作成できます。
• sql.nvim
  neovimからSQLiteを操作するwrapperです。

ドキュメント

• nvim-lua-guide
• jacobsimpson/nvim-example-lua-plugin
• How to write neovim plugins in Lua | 2n it sp. z o.o.
• Lua製Neovim pluginのテストをLuaで書く
• Lua製Neovim plugin開発でhot-reloading的な体験を得る
• Neovim Async Tutorial
• anthony-khong/nvim-education

参考資料

本文内でリンクを記載していない資料達です。

NeovimとLuaが相性が良い理由

• Developing plugins for Neovim, is there a guide or how-to? : neovim
• Neovim Development Streams! : neovim

Native Packages

• Vim 8.0 Advent Calendar 6 日目 パッケージ - Qiita
• Vim 8 時代のがんばらないプラグイン管理のすすめ - Humanity
• Vimのパッケージ機能を試してみました - Blank File
• Vim 8.0用のプラグインマネージャを作ってみた話 - Qiita

nvim-lspconfig

nvim-treesitter

• What is Neovim tree sitter : neovim

Tree-sitter

• Atom understands your code better than ever before - The GitHub Blog
• 新しいマークダウンパーサーが必要な理由
• 「Atom 1.32」が正式公開 ～構文解析システム「tree-sitter」をついにデフォルト有効化 - 窓の杜