Files
tree-sitter-jhcl/README.md
2021-06-27 12:22:06 +02:00

1.4 KiB

tree-sitter-hcl

tree-sitter grammar for the HCL language

Example

Highlighting example/example.hcl:

Highlighting Example

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.

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

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

The aim is to build unit testcases from selected failure classes and slowly get to 100%.

Todo

  • use Unicode® Standard Annex #31 (augmented with '-') for identifiers
    • allow starting '_' also, not to spec but terraform allows it
  • add template expressions
    • add quoted templates
      • add quoted template interpolations
      • add quoted template directives
    • add heredoc templates