Home

Awesome

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

See Creating Parsers for more information.

Usage

  1. Clone this repository:
git clone https://github.com/phoenixframework/tree-sitter-heex.git
  1. (Optional) Install NodeJS via asdf:
cd tree-sitter-heex
asdf install
  1. Install npm dependencies:
npm install
  1. Run the tests:
npm test
  1. Run the code formatter:
npm run format
  1. (Optional) Update the tests (useful when contributing):
npm run update_test
  1. (Optional) Run the web playground (requires Docker):
npm run playground

See Using Parsers for more information.

Editor Support