tree-sitter-vcl

Varnish Configuration Language grammar for tree-sitter.

Usage

Neovim

Neovim (0.11+) has built-in tree-sitter support. The parser must be compiled to a shared library and placed on the runtime path along with the highlight queries.

Both methods below require the tree-sitter CLI on $PATH and a C compiler.

Using lazy.nvim

{
  "ntsk/tree-sitter-vcl",
  build = function(plugin)
    local data = vim.fn.stdpath("data")
    local parser_dir = data .. "/site/parser"
    local queries_dir = data .. "/site/queries/vcl"
    vim.fn.mkdir(parser_dir, "p")
    vim.fn.mkdir(queries_dir, "p")
    vim.fn.system({ "tree-sitter", "build", "-o", parser_dir .. "/vcl.so", plugin.dir })
    vim.fn.system({ "cp", plugin.dir .. "/queries/highlights.scm", queries_dir .. "/" })
  end,
  ft = "vcl",
  init = function()
    vim.filetype.add({ extension = { vcl = "vcl" } })
  end,
  config = function()
    vim.api.nvim_create_autocmd("FileType", {
      pattern = "vcl",
      callback = function() vim.treesitter.start() end,
    })
  end,
}

:Lazy update rebuilds the parser whenever the grammar changes upstream.

Manual setup

If you don't use a plugin manager, build the parser and copy the queries yourself:

git clone https://github.com/ntsk/tree-sitter-vcl
cd tree-sitter-vcl

mkdir -p "$HOME/.local/share/nvim/site/parser"
tree-sitter build -o "$HOME/.local/share/nvim/site/parser/vcl.so"

mkdir -p "$HOME/.local/share/nvim/site/queries/vcl"
cp queries/highlights.scm "$HOME/.local/share/nvim/site/queries/vcl/"

Then add this to your Neovim config:

vim.filetype.add({
  extension = {
    vcl = "vcl",
  },
})

vim.api.nvim_create_autocmd("FileType", {
  pattern = "vcl",
  callback = function()
    vim.treesitter.start()
  end,
})

Development

Requires Node.js and the tree-sitter CLI.

npm install
npx tree-sitter generate
npx tree-sitter test
npx tree-sitter parse example.vcl

After editing grammar.js, re-run npx tree-sitter generate to update src/parser.c and friends, then npx tree-sitter test to run the corpus tests under test/corpus/.

References

• Varnish Documentation
• VCL Syntax