Crate arborium_hcl 

THIS FILE IS GENERATED FROM xtask/templates/lib.stpl.rs; DO NOT EDIT MANUALLY

arborium-hcl

HCL grammar for tree-sitter.

HashiCorp Configuration Language for IaC; language spec lives in the Terraform docs.

Inventor	HashiCorp
Year	2014

Usage

use arborium_hcl::language;
use tree_sitter_patched_arborium::Parser;

let mut parser = Parser::new();
parser.set_language(&language()).expect("Error loading hcl grammar");

let source_code = "/* your hcl code here */";
let tree = parser.parse(source_code, None).unwrap();
println!("{}", tree.root_node().to_sexp());

For most use cases, prefer the main arborium crate:

[dependencies]
arborium = { version = "*", features = ["hcl"] }

Or use this crate directly:

[dependencies]
arborium-hcl = "*"

About Arborium

This crate is part of Arborium, a collection of tree-sitter grammars packaged as Rust crates, maintained by Amos Wenger.

This crate packages a parser.c file generated by the tree-sitter CLI. It exports a language() function returning the tree-sitter Language for hcl.

Why separate crates? Tree-sitter parsers can be large (some exceed 1MB of generated C). Splitting languages into separate crates means you only compile what you need, and parallel/incremental builds are more effective.

Build Requirements

• Rust: MSRV is 1.85.0 (Rust 2024 edition)
• C compiler: This crate compiles C code via the cc crate

Supported Targets

• All major platforms: Linux, macOS, Windows
• WebAssembly: wasm32-unknown-unknown (with custom sysroot)

Upstream Grammar

Repository	tree-sitter-grammars/tree-sitter-hcl
Commit	fad991865fee927dd1de5e172fb3f08ac674d914
License	Apache-2.0

To regenerate after upstream updates:

cargo xtask gen --name hcl

Found a grammar bug? Please report it to the upstream repository.

Safety

This crate uses unsafe for FFI bindings to the tree-sitter C library. The unsafe surface is minimal and limited to what tree-sitter requires. The generated parser code is produced by tree-sitter’s own code generator.

Versioning

Crate versions track Arborium releases, not upstream grammar versions. The upstream commit is recorded above. A major version bump occurs when grammar changes affect node names or structure (breaking for query consumers).

License

• Generated parser code (parser.c): Apache-2.0 (from upstream grammar)
• Arborium glue code: MIT OR Apache-2.0

Contributing

• Issues: github.com/bearcove/arborium/issues
• Repository: github.com/bearcove/arborium

Constants

HIGHLIGHTS_QUERY

The highlights query for hcl.

INJECTIONS_QUERY

The injections query for hcl (empty - no injections available).

LOCALS_QUERY

The locals query for hcl (empty - no locals available).

Functions

language

Returns the hcl tree-sitter LanguageFn.