🦒

lazy.nvimによるプラグインマネージャ管理

に公開

はじめに

これまでに、Neovim向けの基本設定について説明してきました。

Neovimを使ってみよう
Neovimのインストール(Windowsユーザ向け)
Neovimの基本設定

今回はいよいよ、プラグイン導入にむけてプラグインを管理する、lazy.nvimというプラグインマネージャの導入について説明していきたいと思います。

lazy.nvimとは

lazy.nvimはNeovimのプラグインマネージャです。
Luaで書かれたNeovim用のプラグインマネージャで「高速」「遅延読み込み」「設定の分割しやすさ」が特徴です。

設定ファイル作成

設定ファイル配置ディレクトリ

Neovimが起動時に読み込む、設定ファイルの場所は環境により異なります。

Win:
C:\Users\ユーザ名\AppData\Local\nvim

Mac/Linux:
/Users/ユーザ名/.config/nvim

念のため、Neovimを起動後、以下のコマンドを実行して配置場所を確認しましょう。

:echo stdpath('config')

ディレクトリ構成とファイル構成

以下に

%配置ディレクトリ%/
 ├── lua/
 │    ├─ config/
 │    │  └─ lazy.lua <-新規
 │    └─ plugins/ <-新規ディレクトリ(作成だけしておく)
 └─ init.lua <- 変更

lazy.lua

公式の設定ファイルをからそのまま引用

完成形

-- Bootstrap lazy.nvim
local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not (vim.uv or vim.loop).fs_stat(lazypath) then
  local lazyrepo = "https://github.com/folke/lazy.nvim.git"
  local out = vim.fn.system({ "git", "clone", "--filter=blob:none", "--branch=stable", lazyrepo, lazypath })
  if vim.v.shell_error ~= 0 then
    vim.api.nvim_echo({
      { "Failed to clone lazy.nvim:\n", "ErrorMsg" },
      { out, "WarningMsg" },
      { "\nPress any key to exit..." },
    }, true, {})
    vim.fn.getchar()
    os.exit(1)
  end
end
vim.opt.rtp:prepend(lazypath)

-- Make sure to setup `mapleader` and `maplocalleader` before
-- loading lazy.nvim so that mappings are correct.
-- This is also a good place to setup other settings (vim.opt)
--vim.g.mapleader = " "
--vim.g.maplocalleader = "\\"

-- Setup lazy.nvim
require("lazy").setup({
  spec = {
    -- import your plugins
    { import = "plugins" },
  },
  -- Configure any other settings here. See the documentation for more details.
  -- colorscheme that will be used when installing plugins.
  install = { colorscheme = { "habamax" } },
  -- automatically check for plugin updates
  checker = { enabled = true },
})

説明

local lazypath = vim.fn.stdpath("data") .. "/lazy/lazy.nvim"
if not (vim.uv or vim.loop).fs_stat(lazypath) then
  local lazyrepo = "https://github.com/folke/lazy.nvim.git"
  local out = vim.fn.system({ "git", "clone", "--filter=blob:none", "--branch=stable", lazyrepo, lazypath })
  if vim.v.shell_error ~= 0 then
    vim.api.nvim_echo({
      { "Failed to clone lazy.nvim:\n", "ErrorMsg" },
      { out, "WarningMsg" },
      { "\nPress any key to exit..." },
    }, true, {})
    vim.fn.getchar()
    os.exit(1)
  end
end
vim.opt.rtp:prepend(lazypath)

初回用にこの部分でlazy.nvimがローカルに配置されているかを確認し、なければgitでcloneします。
また、最後のvim.opt.rtp:prepend(lazypath)の部分でlazy.nvimが最初に読み込まれるようにRuntimeパスの先頭にlazy.nvimの設定ファイルを指定しています。
普通はこのまま変更は不要です。

--vim.g.mapleader = " "
--vim.g.maplocalleader = "\\"

公式の状態からコメントアウト。
init.lua設定で行っており、二重設定になってしまうため。
同じ値を指定してるので、コメントアウトしなくてもOk。

- Setup lazy.nvim
require("lazy").setup({
  spec = {
    -- import your plugins
    { import = "plugins" },
  },
  -- Configure any other settings here. See the documentation for more details.
  -- colorscheme that will be used when installing plugins.
  install = { colorscheme = { "habamax" } },
  -- automatically check for plugin updates
  checker = { enabled = true },
})

lazy.nvimの初期設定を行っています。

require(xxxx).setup({
 xxxx
})

という記載方法がはじめに違和感があるかもしれませんが、このあと追加するプラグインの初期設定も似たような記載方法となりますので、慣れましょう。
{}の中にkey-value形式で設定を行います。
追加するプラグインは別のLuaファイルにその設定を記載しておきますが、以下でLuaファイルの読み込み先を指定しています。

  spec = {
    -- import your plugins
    { import = "plugins" },
  },

以下ように、プラグイン毎や機能郡ごとにLuaファイルを分けて配置します。

%配置ディレクトリ%/
└─ .config/
   └─ lua/
       └─ plugins/
         ├─ plugin-1.lua
         ├─ plugin-2.lua
         └─ plugin-3.lua         

ディレクトリ名を変えたり、ディレクトリ階層化した場合はspecの設定を変更します。

  checker = { enabled = true },

プラグインの更新設定を自動で行うかの設定です。
現状は有効の状態ですが、使ってみて煩わしい場合はfalseに変更しましょう。

init.lua

完成形

-- leaderの設定
vim.g.mapleader = " "
vim.g.maplocalleader = "\\"
-- configフォルダ配下の各Luaファイルを読み込む
require("config.lazy")      -- <--この行を追加する
require("config.options")
require("config.keymaps")
require("config.autocmd")

説明

lazy.luaを読み込むように変更します。

動作確認

Neovimを起動するとinit.lua経由でlazy.luaが読み込まれ、lazy.nvimがセットアップされます。
※gitがインストールされている必要があります。

まだ、何のプラグイン設定も追加していないので以下のエラーが出れば、動作確認としてはOKです。

利用方法

基本的な利用の流れは以下となります。

  1. インストールするプラグインの選定
  2. プラグインの初期設定を調べる
  3. プラグイン設定用のLuaファイル作成
  4. Neovimの起動(起動時に初期セットアップが行われる)
  5. 必要時に応じて、3の設定ファイルを変更(Neovim再起動時に読み込まれる)
  6. 不要時は設定Luaファイルを削除するだけでOK

となります。
別記事でいくつかおすすめプラグインを紹介しますが、慣れてきたら自身でネットや生成AIなどでプラグインを調べてみましょう。

3を行って、Neovimを起動するとモーダル画面が出てきてインストールが始まります。
インストールといってもGithubから設定したプラグインと依存関係があるプラグインがCloneされるだけです。

以下の画面はlualineというプラグインを設定して最初の起動時の画面です。
この画面は:qで閉じれます。

プラグイン設定の基本

lualineというプラグインを例に設定ファイルの書き方について説明します。
以下はかなりシンプルなパターンです。

return {
  'nvim-lualine/lualine.nvim',
  dependencies = { 'nvim-tree/nvim-web-devicons' },
  opts = {},
}

上記を例えば、lualine.luaというファイル名でpluginsディレクトリに配置します。
luaファイルの記載方法は公式に詳しく書いてますが、ざっくりと説明すると以下の通りです。

まず、luaファイルは

return {
    ****
}

のようにreturnで設定を返却する必要あり。
また、最低限必要の指定として、対象プラグインのgit上の「ユーザ名/リポジトリ名」を指定する必要があります(上記の場合は 'nvim-lualine/lualine.nvim' )。
※ローカルパスや完全URLでも指定可能

dependenciesについては、対象プラグインの利用に別のプラグインが必要な場合に指定します。
optsにはプラグインの設定を指定します。
'opts'の代わりに'config'を使用することもありますが、非推奨とのこと。
大体が上記の指定で事足りますが、その他の指定については公式にて確認してください。

なお、各プラグインの必要な設定は各プラグインのGithubに記載されています。
また、生成AIに聞いてみても、それなりの精度で初期設定を教えてれます、試してみてください。

例)「nvim-lualine/lualine.nvimのlazy.nvim用のおすすめ初期設定を教えて」

プラグイン全般として、設定については、あまり完璧を求めず、最初は公式のサンプルなどを使用して、気になる部分を変更していくほうが良いのかなと個人的には思います。

最後に

本記事はlazy.nvimというプラグインマネージャの導入方法を説明しました。
別記事でおすすめのプラグインの紹介もしていく予定なので、興味があれば見てってください。

Neovim関連記事

以下にこれまでに作成したNeovim関連記事をまとめてます。
よかったらこっちも見ていってください。
https://zenn.dev/kirilab/articles/ba3dba2ba74a0a

Discussion