varnishls

varnishls is a Varnish Language Server. Provides some autocomplete, jump to definition across files and basic linting. Made for Varnish 6.0 (plus), but it should work with other versions - except Fastly.

Setup

• Download a release for your platform and put it somewhere, preferably in path
• Either install varnish locally or download VCC-files.zip here and place them in $HOME/.varnishls/vcc

mkdir $HOME/.varnishls
cd $HOME/.varnishls
unzip varnish-vcc-files.zip

• Set VARNISHLS_VCC_PATHS in .profile, .zshrc or .bashrc

export VARNISHLS_VCC_PATHS="./lib:./vcc:/usr/share/varnish/vcc:/opt/homebrew/opt/varnish/share/varnish/vcc:$HOME/.varnishls/vcc/"

Now setup up your editor of choice

• vscode
• neovim
• vim
• emacs

VSCode

Currently seperate repo. Bundles varnishls.

Note

VSCode extention does not need configuration, but will use it if it exists.

• Github Repo
• VSCode Markedplace

Neovim

local lspconfig = require('lspconfig')
local lsp_configs = require('lspconfig.configs')

lsp_configs.varnishls = {
  default_config = {
    -- Change the path to varnishls (add --debug for debug log)
    cmd = { "/path/to/varnishls", "lsp", "--stdio" },
    filetypes = { "vcl", "vtc" },
    root_dir = lspconfig.util.root_pattern(".varnishls.toml", ".git"),
    settings = {},
  }
}

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

It is technically possible to use the tree-sitter grammar for syntax highlighting, but this is even more WIP than the lsp.

local parser_config = require "nvim-treesitter.parsers".get_parser_configs()
for _, lang in pairs({ "vcl", "vtc" }) do
  parser_config[lang] = {
    install_info = {
      url = "/<path to this repo>/vendor/tree-sitter-" .. lang,
      files = {"src/parser.c"},
    }
  }
end

Run :TSInstallFromGrammar vcl after adding the nvim-treesitter config.

Vim

vim-lsp using prabirshrestha/vim-lsp

au User lsp_setup call lsp#register_server({
        \ 'name': 'varnishls',
        \ 'cmd': {server_info->['/path/to/varnishls',"lsp","--stdio"]},
        \ 'allowlist': ['vcl','vtc'],
        \ })

Emacs

install vcl-mode and add this to .emacs

(with-eval-after-load 'eglot
  (add-to-list 'eglot-server-programs
               '(vcl-mode . ("varnishls" "lsp" "--stdio"))))

Config Override

You can add .varnishls.toml in the root of your workspace and add overrides and tunings for spesific varnish configuration three.

# .varnishls.toml in your workspace dir
main_vcl = "vg/varnish.vcl" # path to the main vcl file varnish uses
vmod_paths = ["/usr/lib/varnish-plus/vmods/"] # paths to directories containing your vmods (.so binaries)
vcc_paths = ["/usr/src/varnish-cache/lib/"] # paths to directories containing vcc files (vmod definition files)
vcl_paths = ["./", "/usr/share/varnish-plus/vcl/"] # paths to directories containing vcl (default ./)
[lint]
prefer_else_if = "hint"
prefer_lowercase_headers = "hint"
prefer_custom_headers_without_prefix = false

Allowed levels for linting rules are error, warning, info, and hint. Set to false to disable a rule.

NOTE: vcc_paths takes precedence over vmod_paths when searching for vmods, since vcc also has documentation.

Dev Setup

make tree-sitter-vcl tree-sitter-vtc
make build

Inspiration:

• tree-sitter-c
• tower-lsp-boilerplate
• prosemd-lsp
• svls
• deno lsp