jenterkin/tree-sitter-jhcl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
mhoffm
2021-06-14 23:25:32 +02:00
parent 562fe37276
commit 9606c5fa49
1 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -2,6 +2,12 @@
tree-sitter grammar for the [HCL](https://github.com/hashicorp/hcl/blob/main/hclsyntax/spec.md) language 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/JdfxHvE.jpeg)
## Developing ## 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. It is recommended to use `nix` to fulfill all development dependencies. To activate the development environment simply run `nix-shell` in the project root.
@@ -10,16 +16,9 @@ It is recommended to use `nix` to fulfill all development dependencies. To activ
To run tests simply run `nix-shell --run 'tree-sitter test'`. To run tests simply run `nix-shell --run 'tree-sitter test'`.
## Example
Highlighting `example/example.hcl`:
![Highlighting Example](https://i.imgur.com/JdfxHvE.jpeg)
## Quoted Template Expressions ## Quoted Template Expressions
In principle it is allowed to contain arbitary expressions in quoted template expressions. In principle it is allowed to contain arbitary expressions in quoted template interpolations. Consider for example:
Consider for example:
```hcl ```hcl
foo = "prefix-${func(\"bar\"}" foo = "prefix-${func(\"bar\"}"
@@ -34,5 +33,9 @@ String literals are parsed as quoted templates. The calling application should c
## Todo ## Todo
* use [Unicode® Standard Annex #31](https://www.unicode.org/reports/tr31/) (augmented with '-') for identifiers * [ ] 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) * [ ] 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