[第2回] Neovimのすゝめ – 設定ファイルを作成する

連載

本記事は複数記事の連載記事の１つです。

wonwon eater

 

9 Pockets

Neovimのすゝめ - 連載 セットアップ手順

https://wonwon-eater.com/neovim-susume

はじめに最近、Neovimの環境構築しましたが、UI設定、キーマッピング、オプション、プラグイン...と沢山の設定が必要でした。Vimを使うなら環境構築の壁を自力で乗り越えてこそ！という見方もありますが、LSPでLanguage Serverと連携必須になったり設定ファイルがVim Script(.vimrc)からLua言語になったりと、壁は高くなる一方です。これからVimを始める入門者には厳しいんじゃないかなぁ...と思うので設定したついでに記事に残しておきたいと思います。私自身はVSCodeがベータ版の頃からメインエディタとして使っていた為、VSCodeで出...

設定ファイルとは

Neovimの設定は init.vim というファイル名で所定の場所に配置することで読み込まれます。
バージョン0.5からは init.lua にLua言語で記載することを強く推奨されているため、init.luaで作成していきます。

記述方法が変わり戸惑うことも多いですが、Vim Scriptよりも高速で配列やdict等も記述しやすいので初見の方にはluaの方が分かりやすく感じるかもしれません。

設定ファイルを作成する

OSによって配置する場所が変わります。

Windows

%userprofile%\AppData\Local\nvim\init.lua

※Windows用のNeovim-qtがリリースされていますが実行速度が遅く、今ならWSLにセットアップすることをお勧めします。
その場合、WSLはUbuntuが定番のディストリビューションなのでLinux用の手順に従うことになります。

Mac

touch ~/.config/nvim/init.lua

Linux

touch ~/.config/nvim/init.lua

設定コマンド

init.vimでは、 set number のようにset + option名で記述していましたが、init.luaでは以下のように記載します。
今まで分類なく記述していた設定を global, buffer, window に分類して記述する必要があります。

ここで問題になるのが、どのオプションがそれぞれ何に分類されるのかです。
ヘルプに記載サれているため、以下から調べましょう。

:h option-list

number オプションのヘルプの見方

NeovimのEXコマンドから以下を実行してオプションのヘルプを開きます。
※オプション名をシングルクォートで囲うのがポイントです。

:h 'number'

どのようなオプションであるのか説明が見られます。
その中の ウィンドウについてローカル と記載されているため、numberオプションは vim.wo (ウィンドウローカオプション) であることが分かります。

また、 切替 の記載は値をbool型 (true/false) でセットすることを表します。

'number' 'nu'       切替  (既定ではオフ)
            ウィンドウについてローカル
    毎行の前に行番号を表示する。オプション 'cpoptions' にフラグ 'n' が含ま
    れていないときは、折り返された行の先頭は行番号の表示される桁に入り込ま
    ない ('compatible' がオフのときはこれが既定である)。
    オプション 'numberwidth' で行番号の幅を設定することができる。
    折り返された行が長すぎて {訳注: 行の途中の部分だけで画面一杯になってし
    まい} 行の本当の先頭の文字が表示されていないときは、文字 '-' が行番号
    の前に表示される。行番号に使われる強調表示グループについては
    |hl-LineNr| と |hl-CursorLineNr| を参照。
                        *number_relativenumber*
    'relativenumber' オプションは表示される番号をカーソルからの相対にする。
    'number' と共にこれら4つの組み合わせがある。 (カーソルは3行目):

Vimコマンドを実行する

luaファイルからVimコマンドを実行するには、 vim.cmd を使用します。
これまでの.vimrcやinit.vimで記載された設定も、vim.cmdを使用すれば同じ記述で使用することもできます。

vim.cmd 'set clipboard+=unnamedplus'
vim.cmd 'colorscheme gruvbox'

lua外部ファイルの読み込み

Neovimが読み込むファイルは init.lua ですが、すべての設定を一つのファイルに記載せずに別ファイルに分割できます。

外部ファイルを読み込むには require を使用します。
以下の指定で config.lua が読み込まれます。

init.lua

-- nvim
-- ├ lua
-- │ ├ plugins
-- │ │ └ sample.lua
-- │ └ config.lua
-- └ init.lua

require('config')
require('plugins.sample')

• luaディレクトリのファイルが読み込まれる
• 拡張子.luaは指定しなくて良い
• 階層構造はドット区切りで指定できる

設定一覧

各オプションの簡易説明: option-list