Neovim自定义LuaSnipets片段

由于luasnip-snippets与当前最新的Neovim发生了不兼容的情况,于是今天决定删除luasnip-snippets, 但是借助Ai完成了Markdown和latex中的physics宏包片段的编写工作。

Markdown 片段

这个文件使用 Ai 复刻了 luasnip-snippets 中的关于Markdown的片段,其位置为 ~/.luasnip/markdown.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
local ls = require("luasnip")
local s  = ls.snippet
local t  = ls.text_node
local i  = ls.insert_node
local c  = ls.choice_node
local f  = ls.function_node

local date = function() return os.date("%Y-%m-%d") end
local time = function() return os.date("%H:%M") end

-- 生成对称 # 的标题:h = 层级
local function heading(level, default)
  local h = string.rep("#", level)
  return {
    t(h .. " "),        -- 前置 #
    i(1, default),      -- 标题文字
    t(" " .. h),        -- 后置 #,数量与前置一致
    t({ "", "" }),      -- 空行
    i(0),
  }
end

return {
  -- ===== 标题(沿用原 sec 系列,习惯不变)=====
  s("sec",   heading(1, "Section Name")),
  s("ssec",  heading(2, "Section Name")),
  s("sssec", heading(3, "Section Name")),
  s("par",   heading(4, "Paragraph Name")),
  s("spar",  heading(5, "Paragraph Name")),

  -- ===== 链接 / 图片 =====
  s("link",  { t("["), i(1, "text"), t("]("), i(2, "url"), t(")"), i(0) }),
  s("img",   { t("!["), i(1, "alt"), t("]("), i(2, "url"), t(")"), i(0) }),
  s("imgw",  { t("!["), i(1, "alt"), t("]("), i(2, "url"), t(" ="), i(3, "500x"), t(")"), i(0) }),
  s("rlink", { t("["), i(1, "text"), t("]["), i(2, "1"), t("]"), i(0) }),

  -- ===== 行内格式 =====
  s("bold",  { t("**"), i(1), t("**"), i(0) }),
  s("ital",  { t("*"),  i(1), t("*"),  i(0) }),
  s("bi",    { t("***"), i(1), t("***"), i(0) }),
  s("del",   { t("~~"), i(1), t("~~"), i(0) }),
  s("mark",  { t("=="), i(1), t("=="), i(0) }),
  s("code",  { t("`"),  i(1), t("`"),  i(0) }),
  s("cmt",   { t("<!-- "), i(1), t(" -->"), i(0) }),

  -- ===== 块级 =====
  s("codeblock", { t("```"), i(1, "lua"), t({ "", "" }), i(2), t({ "", "```", "" }), i(0) }),
  s("quote",  { t("> "), i(1), t({ "", "" }), i(0) }),
  s("todo",   { t("- [ ] "), i(1), t({ "", "" }), i(0) }),
  s("hr",     { t({ "---", "" }), i(0) }),

  s("table", {
    t("| "), i(1, "Header"), t(" | "), i(2, "Header"), t({ " |", "| --- | --- |", "| " }),
    i(3), t(" | "), i(4), t({ " |", "" }), i(0),
  }),

  -- ===== frontmatter:自动填日期 =====
  s("fm", {
    t({ "---", "title: " }), i(1, "Title"),
    t({ "date: " }), f(date),
    t({ "tags: []", "---", "" }), i(0),
  }),

  -- ===== 脚注 / 目录 =====
  s("fn",  { t("[^"), i(1, "1"), t("]"), t({ "", "" }), i(0) }),
  s("toc", { t({ "<!-- toc -->", "" }), i(0) }),

  -- ===== 折叠 / Callout =====
  s("det", {
    t("<details>"), t({ "", "<summary>" }), i(1, "Summary"),
    t({ "", "</summary>", "" }), i(2),
    t({ "", "</details>", "" }), i(0),
  }),

  s("note",   { t("> [!NOTE]"),   t({ "", "> " }), i(1), t({ "", "" }), i(0) }),
  s("tip",    { t("> [!TIP]"),    t({ "", "> " }), i(1), t({ "", "" }), i(0) }),
  s("warn",   { t("> [!WARNING]"), t({ "", "> " }), i(1), t({ "", "" }), i(0) }),
  s("danger", { t("> [!CAUTION]"), t({ "", "> " }), i(1), t({ "", "" }), i(0) }),

  -- ===== 数学 / mermaid =====
  s("math",  { t("$"), i(1), t("$"), i(0) }),
  s("dmath", { t({ "$$", "" }), i(1), t({ "", "$$", "" }), i(0) }),
  s("mmd", {
    t({ "```mermaid", "graph TD" }), t({ "", "  A[Start] --> B[End]" }),
    t({ "", "```", "" }), i(0),
  }),

  -- ===== 时间 =====
  s("date", { f(date), i(0) }),
  s("time", { f(time), i(0) }),

  -- ===== Obsidian =====
  s("wl",  { t("[["), i(1, "note"), t("]]"), i(0) }),
  s("blk", { t(" ^"), i(1, "blockid"), i(0) }),
}

LaTex 的 Physics 宏包片段

其位置为 ~/.luasnip/tex.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
local ls = require("luasnip")
local s = ls.snippet
local t = ls.text_node
local i = ls.insert_node

return {
    s("qty",   {t("\\qty("), i(1), t(")"), i(0)}),
    s("pqty",  {t("\\pqty("), i(1), t(")"), i(0)}),
    s("bqty",  {t("\\bqty["), i(1), t("]"), i(0)}),
    s("Bqty",  {t("\\Bqty{"), i(1), t("}"), i(0)}),
    s("abs",   {t("\\abs{"), i(1), t("}"), i(0)}),
    s("norm",  {t("\\norm{"), i(1), t("}"), i(0)}),
    s("eval",  {t("\\eval{"), i(1), t("}_{"), i(2), t("}^{"), i(3), t("}"), i(0)}),
    s("order", {t("\\order{"), i(1), t("}"), i(0)}),
    s("comm",  {t("\\comm{"), i(1), t("}{"), i(2), t("}"), i(0)}),
    s("anticomm", {t("\\anticomm{"), i(1), t("}{"), i(2), t("}"), i(0)}),
    s("vb",    {t("\\vb{"), i(1), t("}"), i(0)}),
    s("va",    {t("\\va{"), i(1), t("}"), i(0)}),
    s("vu",    {t("\\vu{"), i(1), t("}"), i(0)}),
    s("vbv",   {t("\\vb*["), i(1, "v"), t("]{"), i(2), t("}"), i(0)}),
    s("vav",   {t("\\va*["), i(1, "v"), t("]{"), i(2), t("}"), i(0)}),
    s("vuv",   {t("\\vu*["), i(1, "v"), t("]{"), i(2), t("}"), i(0)}),
    s("grad",      {t("\\grad"), i(0)}),
    s("divg",      {t("\\div"), i(0)}),
    s("curl",      {t("\\curl"), i(0)}),
    s("laplacian", {t("\\laplacian"), i(0)}),
    s("dv",    {t("\\dv{"), i(1), t("}{"), i(2), t("}"), i(0)}),
    s("dvn",   {t("\\dv["), i(1, "n"), t("]{"), i(2), t("}{"), i(3), t("}"), i(0)}),
    s("dvs",   {t("\\dv*{"), i(1), t("}{"), i(2), t("}"), i(0)}),
    s("pdv",   {t("\\pdv{"), i(1), t("}{"), i(2), t("}"), i(0)}),
    s("pdvn",  {t("\\pdv["), i(1, "n"), t("]{"), i(2), t("}{"), i(3), t("}"), i(0)}),
    s("pdvm",  {t("\\pdv{"), i(1), t("}{"), i(2), t("}{"), i(3), t("}"), i(0)}),
    s("pdvms", {t("\\pdv*{"), i(1), t("}{"), i(2), t("}{"), i(3), t("}"), i(0)}),
    s("var",   {t("\\var{"), i(1), t("}{"), i(2), t("}"), i(0)}),
    s("bra",    {t("\\bra{"), i(1), t("}"), i(0)}),
    s("ket",    {t("\\ket{"), i(1), t("}"), i(0)}),
    s("braket", {t("\\braket{"), i(1), t("}{"), i(2), t("}"), i(0)}),
    s("dyad",   {t("\\dyad{"), i(1), t("}{"), i(2), t("}"), i(0)}),
    s("expval", {t("\\expval{"), i(1), t("}"), i(0)}),
    s("mel",    {t("\\mel{"), i(1), t("}{"), i(2), t("}{"), i(3), t("}"), i(0)}),
    s("mqty",  {t("\\mqty("), i(1), t(")"), i(0)}),
    s("pmqty", {t("\\pmqty("), i(1), t(")"), i(0)}),
    s("bmqty", {t("\\bmqty["), i(1), t("]"), i(0)}),
    s("vmqty", {t("\\vmqty|"), i(1), t("|"), i(0)}),
    s("imat",  {t("\\imat"), i(0)}),
    s("imatn", {t("\\imat*{"), i(1), t("}"), i(0)}),
    s("xmat",  {t("\\xmat"), i(0)}),
    s("xmatn", {t("\\xmat*{"), i(1), t("}"), i(0)}),
    s("dmat",  {t("\\dmat"), i(0)}),
    s("dmatn", {t("\\dmat*{"), i(1), t("}"), i(0)}),
    s("tr",  {t("\\tr{"), i(1), t("}"), i(0)}),
    s("Tr",  {t("\\Tr{"), i(1), t("}"), i(0)}),
    s("erf", {t("\\erf{"), i(1), t("}"), i(0)}),
    s("Res", {t("\\Res{"), i(1), t("}"), i(0)}),
    s("pv",  {t("\\pv{"), i(1), t("}"), i(0)}),
    s("PV",  {t("\\PV{"), i(1), t("}"), i(0)}),
    s("qq",  {t("\\qq{"), i(1), t("}"), i(0)}),
    s("qc",  {t("\\qc{"), i(1), t("}{"), i(2), t("}"), i(0)}),
    s(
        { trig = "`a", snippetType = "autosnippet", wordTrig = false },
        { t("\\alpha"), i(0) }
    ),
    s(
        { trig = "`b", snippetType = "autosnippet", wordTrig = false },
        { t("\\beta"), i(0) }
    ),
}
注意

这段代码必须保存在tex.lua中,我发现保存成latex.lua并不能顺利载入到Neovim.

快捷键绑定

文件位于 ~/.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
53
54
55
56
57
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
注意

最初发现使用<Tab>并不能跳转,比如在 LaTeX 文件中输入 pdv, 则自动展开为 \pdv{}{}, 同时光标位于第一个花括号内,但是按<Tab>时其并不能跳转到第二个花括号内,使用命令:verbose imap <Tab> 查询到其被 Ultisnips占用,于是删除这个老旧的插件后恢复正常。最后该文件需要在~/.config/nvim/init.lua中使用require('plg/luasnip')调用才行。

参考文章