@cdktf/hcl2json

HCL2JSON

This is a WebAssembly wrapper for https://github.com/tmccombs/hcl2json

Usage

yarn add @cdktf/hcl2json

Parse HCL strings

import { parse } from '@cdktf/hcl2json'

const hcl = `
  variable "name" {
    description = "Name to be used on all the resources as identifier"
    type        = string
    default     = ""
  }
`

(async () => {
  // my-filename.tf isn't relevant for the functionality, just metadata
  const json = await parse('my-filename.tf', hcl)
  console.log(json)
})()

// =>

{
  "variable": {
    "name": [
      {
        "default": "",
        "description": "Name to be used on all the resources as identifier",
        "type": "${string}"
      }
    ]
  }
}

Parse an entire directory

import { convertFiles } from "@cdktf/hcl2json";

(async () => {
  const json = await convertFiles("/your/terraform/code");
  console.log(json);
})();

// => Unified JSON representation of all *.tf and *.tf.json files in the given directory

Parse an expression

import { getReferencesInExpression } from "@cdktf/hcl2json";

(async () => {
  const variables = await getReferencesInExpression(
    "main.tf",
    "This is a ${var.input} embedded",
  );
  console.log(variables);
})();

// => [{ value: "var.input", startPosition: 12, endPosition: 23 }]

Development

With yarn build a Typescript compile is triggered and a Go build with a WASM target is performed.

Changelog

0.21.0

Breaking Changes

Minimum required Node version updated to 20.9

Since long-term support for Node.js 18 has ended, we updated our minimum compatible node version to 20.9.

fix

• fix: Stop escaping quotes within HEREDOC #3890
• fix: Pass migrate-state flag through to terraform init #3887
• fix: #3630 Slightly improve HCL rendering for skipped attributes #3878
• fix: issue where archive was being closed before the file finished writing causing corrupt TerraformAssets #3873

feat

• feat!: update minimum required Node.js version to 20.19 #3888
• feat: Skip Provider Locking on request #3879

chore

• chore(deps): bump tar-fs from 2.1.2 to 2.1.3 #3897
• chore: Upgrade base image for docker image used in building CDKTF #3872
• chore: Upgrading dependencies #3871
• chore(deps): bump the github-actions-backward-compatible group with 6 updates #3869
• chore(ci): use Dependabot to keep GitHub Actions updated #3867
• chore: add comments to docs #3863