https://github.com/uncenter/tree-sitter-tera

⛩️ Tree-sitter grammar for the Tera templating language
https://github.com/uncenter/tree-sitter-tera

tera tree-sitter

Last synced: 3 months ago
JSON representation

⛩️ Tree-sitter grammar for the Tera templating language

• Host: GitHub
• URL: https://github.com/uncenter/tree-sitter-tera
• Owner: uncenter
• License: mit
• Created: 2024-10-17T16:33:41.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-21T11:40:30.000Z (3 months ago)
• Last Synced: 2024-10-21T16:53:52.679Z (3 months ago)
• Topics: tera, tree-sitter
• Language: JavaScript
• Homepage:
• Size: 1 MB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tree-sitter-tera

[Tree-sitter](https://tree-sitter.github.io/tree-sitter/) grammar and syntax highlight queries for the [Tera](https://keats.github.io/tera/) templating language.

## Usage

### Helix

![](./assets/helix.png)

1. Add the following language and grammar configuration to your own [`languages.toml` configuration file](https://docs.helix-editor.com/configuration.html):

  ```toml

  [[grammar]]

  name = "tera"

  [grammar.source]

  git = "https://github.com/uncenter/tree-sitter-tera"

  rev = "main"

  [[language]]

  file-types = ["tera"]

  grammar = "tera"

  injection-regex = "tera"

  name = "tera"

  scope = "source.tera"

  block-comment-tokens = [

    { start = "{#", end = "#}" },

    { start = "{#-", end = "-#}" },

    { start = "{#", end = "-#}" },

    { start = "{#-", end = "#}" },

  ]

  [language.auto-pairs]

  "\"" = "\""

  "'" = "'"

  "`" = "`"

  "(" = ")"

  "[" = "]"

  "{" = "}"

  "%" = "%"

  ```

2. Run `hx --grammar fetch` to fetch the grammar from this repository, and then `hx --grammar build` to build the grammars.

3. Run `just helix sync` or `just helix link` to copy or symlink the [queries](./queries) to Helix's runtime directory, as unfortunately [queries are not used from the grammar repository by default](https://github.com/helix-editor/helix/discussions/11379#discussioncomment-10194806).

> [!IMPORTANT]

> Helix [uses the reverse query precedence ordering](https://github.com/helix-editor/helix/issues/9436), meaning that the *first* matching highlight query is used rather than last; this is the opposite behavior of Neovim and Zed, both of which use the *last* matching highlight query - think of it like CSS, where queries gain precedence by being located further down. Helix does seemingly plan to change this soon, but for now **the highlights with Helix will not look as good** due to this issue.

### Neovim

![](./assets/neovim.png)

#### Lazy.nvim

Extend your nvim-treesitter plugin with this Tera plugin.

```lua

{

    "nvim-treesitter/nvim-treesitter",

    config = function()

        -- setup treesitter with config

    end,

    dependencies = {

        ...

        { "uncenter/tree-sitter-tera", build = ":TSUpdate tera" },

        ...

    },

    build = ":TSUpdate",

},

```

#### Manual

```lua

local parser_config = require("nvim-treesitter.parsers").get_parser_configs()

parser_config.tera = {

  install_info = {

    url = "https://github.com/uncenter/tree-sitter-tera",

    files = { "src/parser.c" },

    branch = "main",

  },

  filetype = "tera",

}

```

Run `:TSInstall tera` in Neovim to install the above parser.

## License

[MIT](LICENSE)