Tree-sitter HEEx

Tree-sitter grammar and parser for HEEx, the HTML-aware and component-friendly extension of EEx for Phoenix.

For EEx support, see tree-sitter-eex. For Surface support, see tree-sitter-surface.

Installation

Requirements

• NodeJS LTS
• mise (optional)
• Docker (optional)

See Creating Parsers for more information.

Usage

1. Clone this repository:

git clone https://github.com/phoenixframework/tree-sitter-heex.git

2. (Optional) Install NodeJS via mise:

cd tree-sitter-heex
mise install

3. Install npm dependencies:

npm install

4. Run the tests:

npm test

5. Run the code formatter:

npm run format

6. (Optional) Update the tests (useful when contributing):

npm run update_test

7. (Optional) Run the web playground (requires Docker):

npm run playground

See Using Parsers for more information.

Editor Support

• Neovim via nvim-treesitter
• Helix
• Zed via the Elixir extension