LuaSnip技巧：在代码片段中动态获取当前文件名

在LuaSnip代码片段开发过程中，经常需要动态获取当前文件名作为片段内容的一部分。本文将通过一个实际案例，详细介绍如何实现这一功能。

需求场景

在LaTeX文档编写时，我们可能需要创建一个子文件模板，其中需要自动填充当前文件名。例如，在以下模板中：

% !TEX root = ./<subfile>.tex
\documentclass[<mainfile>.tex]{subfiles}

我们希望<subfile>部分能够自动填充为当前文件名，而不是手动输入。

解决方案

LuaSnip支持在代码片段中嵌入Lua代码，我们可以利用Vim的内置函数expand()来获取文件名信息。具体实现如下：

subfile = t(vim.fn.expand("%:t"))

关键点解析

1. vim.fn.expand(): Vim的内置函数，用于展开特殊字符和变量
2. %: 代表当前缓冲区
3. :t修饰符: 表示只获取文件名部分（去除路径）

完整实现示例

以下是一个完整的LaTeX子文件模板代码片段实现：

local ls = require("luasnip")
local fmt = require("luasnip.extras.fmt").fmta

return {
  ls.snippet(
    "latex-template-subfile",
    fmt(
      [[
        % !TEX root = ./<subfile>.tex
        \documentclass[<mainfile>.tex]{subfiles}

        \begin{document}
        <content>
        \end{document}
      ]],
      {
        subfile = t(vim.fn.expand("%:t")),
        mainfile = i(1, "mainfile.tex"),
        content = i(0)
      }
    )
  )
}

扩展知识

除了:t修饰符外，expand()函数还支持其他有用的修饰符：

• :p: 完整路径
• :h: 文件所在目录
• :r: 不带扩展名的文件名
• :e: 文件扩展名

这些修饰符可以组合使用，例如%:t:r可以获取不带扩展名的当前文件名。

最佳实践建议

1. 对于频繁使用的文件名片段，可以考虑将其封装为函数
2. 在团队协作项目中，确保所有成员使用相同的文件名规范
3. 考虑添加错误处理，以防在特殊情况下获取文件名失败

通过掌握这些技巧，可以显著提高代码片段的智能化和自动化程度，提升文档编写效率。