# @cdktf/hcl-tools 中文文档

规范地址：https://npmcn.com/package/%40cdktf/hcl-tools/

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

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

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

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

- 包体积（解压后）：1.5 MB，13 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2024-01-09T20:23:53.110Z
- 最新版本发布：2025-06-04T16:46:20.107Z
- 近 30 天下载量：549918（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：131（近 12 个月 0 个）

## 中文简介

为 HCL 配置输出与 HCL 帮助库进行交互

## 安装

```sh
npm install @cdktf/hcl-tools
```

也可以使用：`pnpm add @cdktf/hcl-tools`、`yarn add @cdktf/hcl-tools`、`bun add @cdktf/hcl-tools`

## README

# `@cdktf/hcl-tools`

这个库意在容纳由CDKTF常用的HCL工具. 现在,它只是 支持 [曲线](https://pkg.go.dev/github.com/hashicorp/hcl/v2/hclwrite) 戈兰格图书馆 特别是 [`Format`](https://pkg.go.dev/github.com/hashicorp/hcl/v2/hclwrite#Format) 函数.

## 使用量

```
import { format } from "@cdktf/hcl-tools";

const unformattedHcl = `
resource "random_pet" "my_pet" {
}
`

const formatted = await format(unformattedHcl);

```

## 常见问题

### @cdktf/hcl-tools 是什么？

为 HCL 配置输出与 HCL 帮助库进行交互

### 如何安装 @cdktf/hcl-tools？

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

### @cdktf/hcl-tools 支持 TypeScript 吗？

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

### @cdktf/hcl-tools 支持 ESM 还是 CommonJS？

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

### @cdktf/hcl-tools 可以商用吗？

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

### @cdktf/hcl-tools 的下载量有多少？

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

### @cdktf/hcl-tools 还在维护吗？

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