跳转至

Api

vim.api.nvim_create_augroup#

vim.api.nvim_create_augroup 是 Vimscript 中的一个函数,用于创建一个自动命令组。自动命令组是一组自动执行的 Vim 命令,当指定的事件发生时会自动触发执行。例如,当打开一个文件时,我们可以将一组命令组合成一个自动命令组,以便在打开文件时自动执行这些命令。
该函数的返回值为一个整数 ID,用于标识创建的自动命令组。它有两个参数,第一个参数是自动命令组的名称,第二个参数是一个包含自动命令的 Lua 表格。该表格包含了一系列键值对,键用于指定自动命令要监听的事件,值则表示在该事件发生时要执行的 Vim 命令。

例如,下面的代码创建了一个自动命令组,它会在打开一个新的 Markdown 文件时自动为其设置语法高亮:

Copy code
local autocmds = {
    { "BufNewFile,BufRead", "*.md", "setf markdown" }
}

local group = vim.api.nvim_create_augroup("MyMarkdownAutocmds", autocmds)
在上面的代码中,BufNewFile,BufRead 表示监听打开一个新的文件或读取一个缓冲区的事件,
*.md表示监听文件名匹配模式为 .md 的文件,setf markdown 则为事件发生时要执行的 Vim 命令。