README.md

# 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://michahoffmann.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
readme 2021-06-07 20:52:50 +02:00			`# tree-sitter-hcl`

README 2021-06-13 09:26:49 +02:00			`tree-sitter grammar for the [HCL](https://github.com/hashicorp/hcl/blob/main/hclsyntax/spec.md) language`
add more tests, readme 2021-06-08 23:18:50 +02:00
playground: initial version 2022-06-05 11:37:07 +02:00			`## Try It Out`

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

readme 2021-06-14 23:25:32 +02:00			`## Example`

			Highlighting `example/example.hcl`:

fix grammar 2021-09-19 13:25:57 +02:00			`![Highlighting Example](https://i.imgur.com/yUJ0ybK.png)`
readme 2021-06-14 23:25:32 +02:00
handle quoted template expressions and template interpolations 2021-06-14 00:55:24 +02:00			`## Developing`
add more tests, readme 2021-06-08 23:18:50 +02:00
			It is recommended to use `nix` to fulfill all development dependencies. To activate the development environment simply run `nix-shell` in the project root.

handle quoted template expressions and template interpolations 2021-06-14 00:55:24 +02:00			`## Running Tests`
add more tests, readme 2021-06-08 23:18:50 +02:00
fix string literals; trim trailing whitespace 2021-06-14 23:33:28 +02:00			To run tests simply run `nix-shell --run 'tree-sitter test'`.
add conditionals 2021-06-12 21:47:30 +02:00
add real world test corpus; work on some parse errors and weirdnesses 2021-06-19 16:56:35 +02:00			`## Compliance`

add serialization and deserialization 2021-06-23 20:30:30 +02:00			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`.
add real world test corpus; work on some parse errors and weirdnesses 2021-06-19 16:56:35 +02:00
			```bash
add serialization and deserialization 2021-06-23 20:30:30 +02:00			`tree-sitter parse --quiet --stat example/real_world_stuff//`

wip make sure that heredoc identifier sits on a line of its own 2021-06-26 10:31:33 +02:00			`Total parses: 1892; successful parses: 1892; failed parses: 0; success percentage: 100.00%`
add real world test corpus; work on some parse errors and weirdnesses 2021-06-19 16:56:35 +02:00			```

start fuzzing 2021-06-27 19:57:02 +02:00			`## Fuzzing`
add real world test corpus; work on some parse errors and weirdnesses 2021-06-19 16:56:35 +02:00
move fuzzing stuff to dedicated repository 2021-09-19 12:21:37 +02:00			`See the [fuzzing repo for this parser](https://github.com/MichaHoffmann/tree-sitter-hcl-fuzz)`
add real world test corpus; work on some parse errors and weirdnesses 2021-06-19 16:56:35 +02:00
playground: initial version 2022-06-05 11:37:07 +02:00			`## Attributions`

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