Neovim配置LuaSnip

今天尝试在 Neovim 中将代码补全插件,由vsnip 转为LuaSnip, 本文记录 LuaSnip 的具体配置。

安装

安装文件在 ~/.config/nvim/lua/lazy-init.lua, 其设置为

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
-- 代码补全最现代配置
{
    "L3MON4D3/LuaSnip",
        dependencies = {
            "rafamadriz/friendly-snippets" ,
            "saadparwaiz1/cmp_luasnip"
        },
        version = "v2.*", -- Replace <CurrentMajor> by the latest released major (first number of latest release)
            build = "make install_jsregexp",
        event = "InsertEnter",
        config = require("plg.luasnip")
},
{
    "iurimateus/luasnip-latex-snippets.nvim",
    dependencies = { "L3MON4D3/LuaSnip", "nvim-treesitter/nvim-treesitter" },
    config = function()
        require("luasnip-latex-snippets").setup({ use_treesitter = true })
        require("luasnip").config.setup({ enable_autosnippets = true })
        end,
},

配置LuaSnip

配置文件在 ~/.config/nvim/lua/plg/luasnip.lua , 其内容为

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
return function()
    local ls = require("luasnip")

    ---------------------------------------------------------------
    -- 1) 基础设置
    ---------------------------------------------------------------
    ls.setup({
            history = true,
            updateevents = "TextChanged,TextChangedI",
            enable_autosnippets = true,
            })

---------------------------------------------------------------
-- 2) 加载 snippet 目录(路径信息在这里)
---------------------------------------------------------------
require("luasnip.loaders.from_vscode").load()
require("luasnip.loaders.from_vscode").load({
        paths = vim.fn.expand("~/.vsnip"),
        })
require("luasnip.loaders.from_lua").load({
        paths = vim.fn.expand("~/.luasnip"),
        })

---------------------------------------------------------------
-- 3) choiceNode 切换键
---------------------------------------------------------------
-- 菜单选择
vim.keymap.set({ "i", "s" }, "<C-e>", function()
        if require("luasnip").choice_active() then
        require("luasnip.extras.select_choice")()
        end
        end, { silent = true })

vim.keymap.set({ "i", "s" }, "<C-l>", function()
        if ls.choice_active() then ls.change_choice(1) end
        end, { silent = true, desc = "LuaSnip: next choice" })

vim.keymap.set({ "i", "s" }, "<C-h>", function()
        if ls.choice_active() then ls.change_choice(-1) end
        end, { silent = true, desc = "LuaSnip: previous choice" })

---------------------------------------------------------------
-- 4) 跳转键
---------------------------------------------------------------
vim.keymap.set({ "i", "s" }, "<Tab>", function()
        if ls.expand_or_jumpable() then ls.expand_or_jump() end
        end, { silent = true, desc = "LuaSnip: expand or jump" })

vim.keymap.set({ "i", "s" }, "<S-Tab>", function()
        if ls.jumpable(-1) then ls.jump(-1) end
        end, { silent = true, desc = "LuaSnip: jump backward" })
end

启用 LuaSnip

启用文件位于 ~/.config/nvim/lua/plg/cmp.lua, 其内容为

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
local cmp = require("cmp")
-- local luasnip = require("luasnip")
local lspkind = require("lspkind")

cmp.setup({
    -- 设置代码片段引擎,用于根据代码片段补全
    snippet = {
        expand = function(args)
            -- For `vsnip` users.
            -- vim.fn["vsnip#anonymous"](args.body)

            -- For `luasnip` users.
            require('luasnip').lsp_expand(args.body)

            -- For `ultisnips` users.
            -- vim.fn["UltiSnips#Anon"](args.body)

            -- For `snippy` users.
            -- require'snippy'.expand_snippet(args.body)
        end,
    },

    window = {
    },

    mapping = {
        -- 选择上一个
        ['<C-p>'] = cmp.mapping.select_prev_item(),
        -- 选择下一个
        ['<C-n>'] = cmp.mapping.select_next_item(),
        -- 出现补全
        ['<A-.>'] = cmp.mapping(cmp.mapping.complete(), {'i', 'c'}),
        -- 取消补全
        ['<A-,>'] = cmp.mapping({
            i = cmp.mapping.abort(),
            c = cmp.mapping.close(),
        }),

        -- 确认使用某个补全项
        ['<CR>'] = cmp.mapping.confirm({
            select = true,
            behavior = cmp.ConfirmBehavior.Replace
        }),

        -- 向上翻页
        ['<C-u>'] = cmp.mapping(cmp.mapping.scroll_docs(-4), {'i', 'c'}),
        -- 向下翻页
        ['<C-d>'] = cmp.mapping(cmp.mapping.scroll_docs(4), {'i', 'c'}),
    },

    -- 补全来源
    sources = cmp.config.sources({
        {name = 'nvim_lsp'},
        -- {name = 'vsnip'},
        -- {name = 'vimtex'},
        {name = 'luasnip'},
        {name = 'buffer'},
        {name = 'path'}
    }),

    --根据文件类型来选择补全来源
    cmp.setup.filetype('gitcommit', {
        sources = cmp.config.sources({
            {name = 'nvim_lsp'},
            -- {name = 'vsnip'},
            {name = 'luasnip'},
            {name = 'buffer'}
        })
    }),

    -- 命令模式下输入 `/` 启用补全
    cmp.setup.cmdline('/', {
        mapping = cmp.mapping.preset.cmdline(),
        sources = {
            { name = 'buffer' }
        }
    }),

    -- 命令模式下输入 `:` 启用补全
    cmp.setup.cmdline(':', {
        mapping = cmp.mapping.preset.cmdline(),
        sources = cmp.config.sources({
            { name = 'path' }
        }, {
                { name = 'cmdline' }
            })
    }),

    -- 设置补全显示的格式
    formatting = {
        format = lspkind.cmp_format({
            with_text = true,
            maxwidth = 50,
            before = function(entry, vim_item)
                vim_item.menu = "[" .. string.upper(entry.source.name) .. "]"
                return vim_item
            end
        }),
    },
})

导入配置文件

1
2
3
-- ~/.config/nvim/init.lua
require('plg/cmp')
require('plg/luasnip')
注意

本文经过两天的研究初步配置成功,但是仍然在 vsnip和luasnip之前思考哪个在配置和使用上更高效的问题,所以粗略记录配置, 后续会详细完善。