tree-sitter-ghactions

Github Actions expressions grammar for tree-sitter

Features

• Parses Github Action's expressions: ${{ ... }}
• Plays well with bash injections in YAML documents
• Passes parsing tests from actionlint

Neovim Installation (for use in your editor)

1. Install nvim-treesitter

It is recommended to install at least yaml, bash, and comment parsers to support github actions files.

Optional parsers used for additional highlights: json, nim, nim_format_string

2. Configure autocmd for a custom parser:

-- custom parsers
vim.api.nvim_create_autocmd('User', {
  pattern = 'TSUpdate',
  callback = function()
    require('nvim-treesitter.parsers').ghactions = {
      install_info = {
        url = 'https://github.com/rmuir/tree-sitter-ghactions',
        queries = 'queries',
      },
    }
  end,
})

3. Configure yaml injection in ~/.config/nvim/queries/yaml/injections.scm:

; extends

; github actions
([
  (string_scalar)
  (block_scalar)
  (double_quote_scalar)
  (single_quote_scalar)
  (ERROR)
] @injection.content
  (#lua-match? @injection.content "[$]{{")
  (#set! injection.language "ghactions"))

4. Run :TSUpdate and :TSInstall ghactions from neovim.

NOTE: these instructions are based upon the main branch of nvim-treesitter.

Bindings Installation (for development)

Bindings are published to pypi, npm, and crates.io as tree-sitter-ghactions. Wasm and source code artifacts are published to GitHub releases

Screenshot of highlights