hcl2-parser

library1.0.3jsnpmunverified

hcl2-parser is a JavaScript library designed for parsing HashiCorp Configuration Language (HCL) version 2 strings, providing crucial utility for developers working with Terraform configurations or other systems that utilize HCLv2. It offers functions to convert HCL input into either a JSON string or a JavaScript object. A key differentiator for this package is its support for the newer HCL v2 syntax, which includes features like for-expressions, dynamic blocks, and null values, an capability often lacking in other JavaScript-based HCL parsers. The library achieves this by wrapping the Go-based `tmccombs/hcl2json` tool and transpiling the necessary Go code to JavaScript using GopherJS, resulting in a self-contained npm package. As of its initial stable release, version 1.0.3, the package includes TypeScript definitions and is primarily intended for use within Node.js environments. Its release cadence is currently nascent.

devops serialization

npm install hcl2-parser

github ↗package ↗

INSTALL

IMPORT

SIG · HCL2-PARSER

hcl2-parser

devopsjavascriptv1.0.3

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

parseToString

✓ import { parseToString } from 'hcl2-parser';

✗ import hcl from 'hcl2-parser'; const result = hcl.parseToString(...);

For named ESM imports of specific parser functions.

parseToObject

✓ import { parseToObject } from 'hcl2-parser';

For named ESM imports of specific parser functions.

hcl (namespace)

✓ import * as hcl from 'hcl2-parser';

✗ import * as hcl = from 'hcl2-parser';

Correct ESM namespace import syntax. The 'hcl = from' syntax in some examples is incorrect.

hcl (CommonJS)

✓ const hcl = require('hcl2-parser');

✗ import hcl from 'hcl2-parser';

Standard CommonJS `require` for Node.js environments. ESM `import` will not work directly in CJS modules without transpilation.

Demonstrates parsing an HCL string into both a JSON string and a JavaScript object using ESM imports, highlighting how to access specific elements.

import * as hcl from 'hcl2-parser'; const hclString = ` # Create a resource group variable "azureRegion" { type = string default = "uksouth" } resource "azurerm_resource_group" "example" { name = "example-resources" location = var.azureRegion } `; // Parse into a JSON string const stringResult = hcl.parseToString(hclString); console.log('JSON String Result:', stringResult); // Parse into an object, accessing the actual result in array index 0 const objectResult = hcl.parseToObject(hclString); console.log('Parsed Object Resource:', objectResult[0].resource.azurerm_resource_group); console.log('Name:', objectResult[0].resource.azurerm_resource_group.example.name); console.log('Location:', objectResult[0].resource.azurerm_resource_group.example.location);

Debug

Known issues

gotchaThe `parseToObject` function always returns an array, even when parsing a single HCL document. Developers must access the first element of this array (`result[0]`) to get the actual parsed object.

fix

Always access the parsed object via `hcl.parseToObject(input)[0]`.

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: Cannot read properties of undefined (reading 'resource')

Attempting to access properties directly on the array returned by `parseToObject` instead of its first element.

fix

Access the parsed object at index 0, e.g., `hcl.parseToObject(hclString)[0].resource`.

SyntaxError: Unexpected token 'export' or ReferenceError: require is not defined

Incorrectly mixing ES module `import`/`export` syntax with CommonJS `require()` in the same file or environment without proper configuration/transpilation.

fix

Ensure your project uses consistent module syntax (either CommonJS or ES Modules) or configure your build tool (e.g., Webpack, Rollup, Babel, TypeScript) to transpile modules correctly for your target environment. For Node.js, use `.mjs` or `type: module` in `package.json` for ESM.

Upgrade

Version history

1.0.3latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

8 hits · last 30 days

node

Resources

githubhttps://github.com/benc-uk/hcl2-parser ↗

packagehttps://www.npmjs.com/package/hcl2-parser ↗