# @cdktf/hcl2json 中文文档

规范地址：https://npmcn.com/package/%40cdktf/hcl2json/

版本：0\.21\.0
npm 元数据更新时间：2025-06-04T16:46:25.799Z
中文译文更新时间：2026-11-09T06:34:14.045Z
软件包许可：MPL-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cdktf/hcl2json
原文对照：https://npmcn.com/package/%40cdktf/hcl2json/?lang=original
项目主页：https://github.com/hashicorp/terraform-cdk#readme
源码仓库：https://github.com/hashicorp/terraform-cdk

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.8 MB，25 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2021-03-11T14:54:41.452Z
- 最新版本发布：2025-06-04T16:46:25.583Z
- 近 30 天下载量：4261855（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：806（近 12 个月 0 个）

## 中文简介

将 HCL 转换为 JSON

## 安装

```sh
npm install @cdktf/hcl2json
```

也可以使用：`pnpm add @cdktf/hcl2json`、`yarn add @cdktf/hcl2json`、`bun add @cdktf/hcl2json`

## README

# HCL2JSON (美国)

这是WebAssembly的包装 [https://github.com/tmccombs/hcl2json (中文(简体) )](https://github.com/tmccombs/hcl2json)

## 使用量

```
yarn add @cdktf/hcl2json
```

### 解析 HCL 字符串

```js
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}"
      }
    ]
  }
}
```

### 解析整个目录

```js
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
```

### 解析表达式

```js
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 }]
```

## 发展

与 `yarn build` 启动 Typescript 编译,并实现带有 WASM 目标的 Go 构建 .

## 常见问题

### @cdktf/hcl2json 是什么？

将 HCL 转换为 JSON

### 如何安装 @cdktf/hcl2json？

在项目目录运行 npm install @cdktf/hcl2json，或使用 pnpm add / yarn add / bun add。

### @cdktf/hcl2json 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cdktf/hcl2json 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cdktf/hcl2json 可以商用吗？

@cdktf/hcl2json 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @cdktf/hcl2json 的下载量有多少？

根据 npm 官方下载统计，@cdktf/hcl2json 在 2026/10/10 – 2026/11/08 这 30 天内被下载 4,261,855 次，日均约 142,062 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cdktf/hcl2json 还在维护吗？

最新版本 0\.21\.0 发布于 2025/06/05（1\.4 年前）；至今共发布 806 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/03/11。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。