tree-sitter-gh-actions-expressions 0.1.1

Github Actions expressions grammar for tree-sitter

tree-sitter-gh-actions-expressions

Tree-sitter grammar for Github Actions expressions

Parser requirements

• gitignore (optional): for hashFiles() function
• json (optional): for fromJSON() function
• yaml: injection to its block_mapping_pair node

Usage in Editors

Neovim

Requirements

• nvim-treesitter
• Node.js (if ABI not compatible)
• tree-sitter cli (if ABI not compatible)

Installation

1. Add the following to your nvim-treesitter configuration:

   local parser_config = require("nvim-treesitter.parsers").get_parser_configs()
   
   -- NOTE: add the parser to `parser_config` before calling `setup()`
   parser_config.gh_actions_expressions = {
     install_info = {
       url = 'https://github.com/Hdoc1509/tree-sitter-gh-actions-expressions',
       files = { "src/parser.c" },
       revision = 'release',
       -- if ABI version from neovim doesn't match the one from this grammar
       -- requires Node.js and tree-sitter cli to be installed
       requires_generate_from_grammar = true,
     },
   }
   
   require('nvim-treesitter.configs').setup({
     ensure_installed = {
       --- other parsers
       'gh_actions_expressions',
     },
     -- other options
   })
   

2. Copy the queries from queries directory to queries/gh_actions_expression directory in your neovim configuration directory:

   With	Path
   Unix	~/.config/nvim
   Windows	~/AppData/Local/nvim
   XDG_CONFIG_HOME set	$XDG_CONFIG_HOME/nvim

Helix

WIP

Emacs

WIP

In General

You can get the built files from the release branch. If you have specific instructions for your editor, PR's are welcome.

Implementations

WIP

References

• Github Actions expressions documentation
• if conditional:
  • run.steps[*].if
  • jobs.<job_id>.if
• Gihub Actions Context documentation

Thanks

Thanks to @disrupted for creating tree-sitter-github-actions grammar, which is the base I used to create this grammar.