Add Neovim Guide

src/blog/2023-04-nvim-guide.md

@@ -0,0 +1,212 @@
+---
+title: Neovim クイックスタートガイド
+date: 2023-04-12T21:30:00.000Z
+dateUpd: 2023-04-12T21:30:00.000Z
+author: Mido (仮)
+---
+
+プログラミングをする人向け
+
+## はじめに
+
+ソースコードを書くにはエディターが必要です。
+プログラミングに慣れ始めてくると、エディター自身のこともよく知るようになり、使っているうちに便利な部分・不便な部分を洗い出せるようになってくるでしょう。  
+そこで、ふと思ったことはありませんか？
+
+「他のエディターってどうなの？」
+
+と。（強引）  
+
+Visual Studio Code あるいは JetBrains IntelliJ IDEA など、リッチな編集環境を使用している人もいれば、
+Sublime Text や適度にセットアップされた Vim など、過剰に機能が搭載されていないようなエディターを使用している人もいるかと思います。  
+今回はそのような方々向けに、私から [Neovim](https://neovim.io) と呼ばれるエディターを紹介します。~~ついでに乗り換えてくだされば筆者が大喜びします~~
+
+[Neovim](https://neovim.io) とは、[Vim](https://www.vim.org) から派生されて、さまざまな独自機能が盛り込まれたテキストエディター又はコードエディターです（未設定の状態でコードエディターと言える性能かどうかは諸説あり）。  
+そのため大半の挙動や設定方法は Vim に似ていて、互換性も*ある程度*保たれていました。
+
+最近の Neovim の進化は凄まじく、changelog に含まれる新機能も、最近のエディターに必要とされるようなリッチな機能が増えてきました。  
+今までは IDE ほどの機能を有するには複雑で大きなプラグインでの機能拡張が必要で、機能が標準化されていないことから各プラグインでの独自実装が乱立するような状況になることもありました（例：[闇の力を得たプラグインシリーズ](https://github.com/Shougo/dein.vim)）。  
+それが昨今の Neovim では改善の方向に進んでいるのです。それもターミナル上で動くエディターに搭載されているとは思えない機能群を連れて。  
+しかしながら、Neovim（ないし Vim 系統のツール）は初期状態ではほとんど設定がされていない状態で、誰しもが必要である機能をもデフォルトで切られているオプションとして提供することもあります（それでも簡潔な編集は可能なほど質は高い状態にありますが）。  
+今回は、そんな Neovim を他のエディターに負けないようなオリジナルの PDE (Personal Development Environment) にするために、Neovim の設定（特に`$XDG_CONFIG_HOME/nvim`直下）のガイドを紹介します。
+
+このガイドでは、設定の優先順位を次の４つで分類しています。
+また、設定には通常の API を通した設定、およびプラグインの設定が含まれます。
+Neovim の推奨バージョンは`>= 0.9`です。
+
+1. Must-have: Neovim 本体の利便性に深く関わる機能。DX を間違いなく向上させる。
+2. Recommended: 必ずとまではいかないが、設定を推奨する機能。多くの場面で DX の向上につながる。
+3. IDE-like Features: ほとんどのIDEやビジュアルエディターについている機能についての設定。人によって好みが分かれることが多い。（ex. ファイルツリー）
+4. Optional: 必要な人のみ使うべき設定。
+
+[早く設定をしたい人向けリンク](#設定)
+
+## Neovim は何ができるようになったか
+
+Neovim は Vim のフォークであり、数年前に分かれてから、良くも悪くも非常に多くの機能が追加されました。
+ここでは、Neovim について知ってもらうために、その中でも特に大きな機能を個人的に紹介します。
+
+### 設定ファイルは VimScript から Lua へ
+
+- 最初の実装: [Neovim 0.5](https://github.com/neovim/neovim/releases/tag/v0.5.0)
+
+従来は`$XDG_CONFIG_HOME/nvim/init.vim`のみが設定ファイルのエントリーポイントでしたが、Neovim 0.5 で [LuaJIT](https://luajit.org) による初の`$XDG_CONFIG_HOME/nvim/init.lua`のサポートが追加されました。
+Just In Time コンパイルにより通常の Lua ランタイムより高速に動作し、FFI やバイトコードへの先行コンパイルもサポートされています。  
+Lua が登場してからは Neovim 界隈では爆発的な人気を誇るようになり、カラースキームやプラグイン、[ファイルタイプ検出スクリプト](https://github.com/neovim/neovim/pull/16600)にも Lua が使用されるようになりました。
+そのような大規模な変更により、Neovim は速度と言語機能の大幅な強化が達成できたのです。  
+直近での Neovim の起動速度を上げるほとんどのテクニックも [Lua ありきのものであり](https://github.com/lewis6991/impatient.nvim)、*Lua の API を使用しないと設定できない項目*（`vim.keymap.set(mode, keymap, opts)`での`opts`内の`desc`の設定など）も作られるようになっています。
+
+> **Note**
+> Neovim 0.9 から、impatient.nvim と同等の Lua バイトコードキャッシュ機能を実装する [`vim.loader`](https://github.com/neovim/neovim/pull/22668) が追加されたため、今後このプラグインを導入する必要はなくなるかもしれません。  
+> そのため、実際のガイド内容からは除外しています。
+
+また、Neovim の Lua には [luv](https://github.com/luvit/luv) と呼ばれる [libuv](https://libuv.org) のバインディングがビルトインで搭載されています（`vim.loop`からアクセス可能）。
+正しく非同期IOをすれば`vim.fn`直下でアクセス可能な Vim 時代のIO関連の関数よりも高速な動作が期待できます。luv をラップした API も Neovim 向けに多く作られているようです（ex. [`vim.defer_fn()`](https://neovim.io/doc/user/lua.html#vim.defer_fn())）
+
+> **Note**
+> Lua はランタイムのバージョンによって API の変更が顕著で、Lua について学ぶ際には注意しなければならないこともいくつかあります。  
+> 例えば、`unpack()`は Lua の[テーブル](https://ja.m.wikibooks.org/wiki/Lua/%E3%83%86%E3%83%BC%E3%83%96%E3%83%AB)の内容を単純な値のリストであるタプルとして返すために使われるグローバル関数ですが、Lua 5.2 以降ではこの関数は`table.unpack()`に変更されています。
+> Lua を使うときには、どのバージョンの Lua を使用しているかをよく理解しておく必要があります。  
+> なお、LuaJIT は [Lua 5.1 相当](http://luajit.org/faq.html#arg)で実装されています。**そのため、`unpack()`を使用しなければなりません**。
+
+### ネイティブ LSP クライアントの実装
+
+- 最初の実装: [Neovim 0.5](https://github.com/neovim/neovim/releases/tag/v0.5.0)
+
+以前にも LSP サーバーを使用する方法として [coc.nvim](https://github.com/neoclide/coc.nvim) がありましたが、Neovim 0.5 から [Lua の API](https://neovim.io/doc/user/lsp.html) を通してネイティブで LSP サーバーを使用できるようになりました。  
+Lua サポートと合わせてこの機能の実装は非常に注目を集め、Neovim LSP 対応のプラグインが多く作成されるようになりました。
+
+### Neovim Python/Node/Ruby/Perl プロバイダーの実装
+
+この機能は Lua の実装により最近はあまり日の目を見ない機能になっていますが、個人的には無限の可能性を秘めた機能だと思っています。
+各言語で主流なライブラリの種類も異なるため、様々なリッチなプラグインが作られました。coc.nvim も Node.js プロバイダーを使用したプラグインの一つです。  
+特に完成度では最強格と言えたのは [wilder.nvim](https://github.com/gelguy/wilder.nvim) です。
+コマンドモードでの補完をとても強化するプラグインですが、一部の fuzzy search やそのハイライティングなどに Python プロバイダーが使用されます。
+見た目はもちろん、API の完成度もとても素晴らしいものです。リンク先READMEでのデモンストレーションを是非覗いてみてください。
+
+## 設定
+
+Linux x86_64 上での動作を想定しています。
+
+### 1. Must-have
+
+必須設定から紹介していきましょう。
+
+#### `vim.loader` の有効化
+
+[`vim.loader`](https://github.com/neovim/neovim/pull/22668) は Neovim 0.9 で実装された新しい Lua モジュールローダーです。
+一度ロードしたモジュールは自動でバイトコードにコンパイルし、以降のロードでは直接バイトコードを読み込むことでロードコストを大幅に低減する仕組みとなっています。
+
+使い方は簡単です。以下の行を`init.lua`に追加します:
+
+```lua
+vim.loader.enable()
+```
+
+#### プラグインマネージャーのセットアップ
+
+Neovim はビルトインで[`packages`](https://neovim.io/doc/user/repeat.html#packages)と呼ばれるプラグイン管理機能を持っています。
+しかしながら、プラグインのインストールには手動で`git clone`で`~/.local/share/nvim/site/pack/*`直下にプラグイン本体を配置する必要があり、ポータブルな設定をするには非常に手間です。
+そのため、基本的に Neovim では専用のプラグインマネージャーを使ってプラグインをインストールすることが多いです。  
+最近(2023)でのプラグインマネージャーのトレンドは [lazy.nvim](https://github.com/folke/lazy.nvim) です。
+Vim 時代でもプラグインのインストールの手法の一つとして使われていた[`runtimepath`](https://neovim.io/doc/user/options.html#'runtimepath')を使用し、可能な限りプラグインを遅延ロードすることで、起動時間の短縮を目指しているようです。  
+プラグインマネージャーのインストールにあたるブートストラップの作業もやり方が非常に豊富ですが、ここでは例として数行で使えるブートストラップコードを紹介します。
+
+```lua
+local function bootstrap()
+  local plugin_manager_path = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
+
+  local stat = vim.loop.fs_stat(plugin_manager_path)
+
+  if stat then
+    return
+  end
+
+  vim.fn.system("git clone https://github.com/folke/lazy.nvim.git --filter=blob:none --branch=stable " .. plugin_manager_path)
+end
+
+bootstrap()
+
+vim.opt.rtp:prepend(plugin_manager_path)
+
+require("lazy").setup("plugins")
+
+-- これらの設定を適用すると、lazy.nvim は自動で ~/.config/nvim/lua/plugins/{*.lua,*/init.lua} のプラグイン設定を読み込みます。
+-- これらの設定ではファイル毎に以下のように記述することでプラグインをロードできます:
+--
+-- return {
+--   "folke/noice.nvim" -- プラグイン名
+-- }
+--
+-- 詳細な設定は https://github.com/folke/lazy.nvim#-plugin-spec 周辺を見るのがおすすめです。
+```
+
+#### `<leader>`, `<localleader>` の設定
+
+`<leader>` は Neovim で使用する、独自の考え方の一つです。プラグインにより拡張されるあらゆる動作は、ほとんど `<leader>` から始まるキーマップに設定されます。  
+そのため、`<leader>` を押しやすい場所に設定することはとても重要です。QoL を左右します。  
+`<localleader>` はファイルタイプ毎、バッファータイプ毎など、全体で使うことがないが動的に設定することがあるキーマップの定義で使用されます。
+`<leader>` の設定には [`mapleader`](https://neovim.io/doc/user/map.html#mapleader) 、`<localleader>` の設定には [`maplocalleader`](https://neovim.io/doc/user/map.html#maplocalleader) を使用します。  
+設定方法とおすすめのキーはこちら:
+
+```lua
+-- <leader>
+vim.g.mapleader = " " -- スペースキーに設定
+
+-- <localleader>
+vim.g.localleader = "," -- カンマに設定
+```
+
+### 4. Optional
+
+やりたい人のみ設定をおすすめします。  
+
+#### 起動時間の短縮: ビルトインプラグインの無効化
+
+Neovim にはビルトインでいくつかのプラグインが導入されていますが、そのほとんどは実際に使うことが少なく、無効化してもいいものが多いです。  
+しかしながら、それらのプラグインが Neovim の起動時間に影響をもたえらす可能性も非常に少ないため、最大効率を目指したい方はやってみることをおすすめします。数ミリ秒程度起動が速くなるかも。  
+設定方法は簡単です。以下の行をロード予定の好きな設定に追加します:
+
+```lua
+-- ノート: これらのプラグインはビルトインにしては珍しく有用なものです。matchit
+--         の競合プラグインですので、matchit を導入せずに似たような機能を使用したい場合はこ
+--         れらの行を削除してください。
+vim.g.loaded_matchit = 1
+vim.g.loaded_matchparen = 1
+
+-- 注意: netrw はビルトインのファイルマネージャーです。場合によっては必要なとき
+--       もあるかもしれませんので、使わない保証があるときのみ以下の4行を追加してください:
+vim.g.loaded_netrw = 1
+vim.g.loaded_netrwPlugin = 1
+vim.g.loaded_netrwSettings = 1
+vim.g.loaded_netrwFileHandlers = 1
+
+-- 注意: Python3 / Node プロバイダーは外部プロバイダーを使用するプラグインの中で
+--       特にメジャーなものの一つです。本ガイドではそのようなプラグインは依存関係の増加を
+--       防ぐためなるべく紹介しないように努めていますが、今後そのようなプラグインを使う見
+--       通しが立っている場合は注意してください。
+vim.g.loaded_python3_provider = 0
+vim.g.loaded_node_provider = 0
+vim.g.loaded_ruby_provider = 0
+vim.g.loaded_perl_provider = 0
+
+-- 以下は無効化してもほぼ支障はありません。
+
+vim.g.loaded_man = 1
+vim.g.loaded_gzip = 1
+vim.g.loaded_zip = 1
+vim.g.loaded_zipPlugin = 1
+vim.g.loaded_tar = 1
+vim.g.loaded_tarPlugin = 1
+
+vim.g.loaded_getscript = 1
+vim.g.loaded_getscriptPlugin = 1
+vim.g.loaded_vimball = 1
+vim.g.loaded_vimballPlugin = 1
+vim.g.loaded_2html_plugin = 1
+vim.g.loaded_tutor_mode_plugin = 1
+vim.g.loaded_spellfile_plugin = 1
+
+vim.g.loaded_logiPat = 1
+vim.g.loaded_rrhelper = 1
+```