README.md

# tree-sitter-hcl

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

## Example

Highlighting `example/example.hcl`:

![Highlighting Example](https://i.imgur.com/sgFcxLK.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'`.

## Todo

* [ ] use [Unicode® Standard Annex #31](https://www.unicode.org/reports/tr31/) (augmented with '-') for identifiers
* [ ] add [template expressions](https://github.com/hashicorp/hcl/blob/main/hclsyntax/spec.md#template-expressions)
  * [x] add quoted templates
    * [x] add quoted template interpolations
    * [ ] add quoted template directives
  * [ ] add heredoc templates
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
readme 2021-06-14 23:25:32 +02:00			`## Example`

			Highlighting `example/example.hcl`:

fmt tests; properly define string literals; work on scanner 2021-06-17 19:39:46 +02:00			`![Highlighting Example](https://i.imgur.com/sgFcxLK.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
handle quoted template expressions and template interpolations 2021-06-14 00:55:24 +02:00			`## Todo`

readme 2021-06-14 23:25:32 +02:00			`* [ ] use [Unicode® Standard Annex #31](https://www.unicode.org/reports/tr31/) (augmented with '-') for identifiers`
fix string literals; trim trailing whitespace 2021-06-14 23:33:28 +02:00			`* [ ] add [template expressions](https://github.com/hashicorp/hcl/blob/main/hclsyntax/spec.md#template-expressions)`
readme 2021-06-14 23:25:32 +02:00			`* [x] add quoted templates`
			`* [x] add quoted template interpolations`
			`* [ ] add quoted template directives`
			`* [ ] add heredoc templates`