https://github.com/tree-sitter-grammars/tree-sitter-hcl

HCL grammar for tree-sitter
https://github.com/tree-sitter-grammars/tree-sitter-hcl

hcl parser tree-sitter

Last synced: about 1 month ago
JSON representation

HCL grammar for tree-sitter

• Host: GitHub
• URL: https://github.com/tree-sitter-grammars/tree-sitter-hcl
• Owner: tree-sitter-grammars
• License: apache-2.0
• Created: 2021-06-07T18:38:41.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-08-15T16:09:32.000Z (3 months ago)
• Last Synced: 2024-09-27T10:41:16.335Z (about 1 month ago)
• Topics: hcl, parser, tree-sitter
• Language: HCL
• Homepage: https://tree-sitter-grammars.github.io/tree-sitter-hcl/
• Size: 3.31 MB
• Stars: 93
• Watchers: 6
• Forks: 20
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tree-sitter-hcl

tree-sitter grammar for the [HCL](https://github.com/hashicorp/hcl/blob/main/hclsyntax/spec.md) language

## Try It Out

Try the parser in the [playground](https://tree-sitter-grammars.github.io/tree-sitter-hcl/)

## Example

Highlighting `example/example.hcl`:

![Highlighting Example](https://i.imgur.com/yUJ0ybK.png)

## Developing

It is recommended to use `nix` to fulfill all development dependencies. To activate the development environment simply run `nix-shell` in the project root.

## Running Tests

To run tests simply run `nix-shell --run 'tree-sitter test'`.

## Compliance

The directory `example/real_world_stuff` contains a corpus of hcl files that I found with the github query `language:HCL` for users `coreos`, `hashicorp`, `oracle` and `terraform-community-modules`.

```bash

tree-sitter parse --quiet --stat example/real_world_stuff/*/*

Total parses: 1892; successful parses: 1892; failed parses: 0; success percentage: 100.00%

```

## Fuzzing

See the [fuzzing repo for this parser](https://github.com/MichaHoffmann/tree-sitter-hcl-fuzz)

## Attributions

Pages were copied from https://github.com/m-novikov/tree-sitter-sql