# @cmsgov/hpt-validator-cli 中文文档

规范地址：https://npmcn.com/package/%40cmsgov/hpt-validator-cli/

版本：1\.12\.0
npm 元数据更新时间：2026-10-26T14:31:17.025Z
中文译文更新时间：2026-11-10T04:17:27.203Z
软件包许可：CC0-1\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40cmsgov/hpt-validator-cli
原文对照：https://npmcn.com/package/%40cmsgov/hpt-validator-cli/?lang=original
项目主页：https://github.com/CMSgov/hpt-validator-cli#readme
源码仓库：https://github.com/CMSgov/hpt-validator-cli

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

- 包体积（解压后）：37.3 kB，22 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2025-07-24T19:26:07.203Z
- 最新版本发布：2026-10-26T14:31:16.589Z
- 近 30 天下载量：4393（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 11 个）

## 中文简介

CLI 用于验证 CMS 医院价格透明机器可读文件

## 安装

```sh
npm install @cmsgov/hpt-validator-cli
```

也可以使用：`pnpm add @cmsgov/hpt-validator-cli`、`yarn add @cmsgov/hpt-validator-cli`、`bun add @cmsgov/hpt-validator-cli`

## README

# 医院价格透明CLI验证器

[![Version](https://img.shields.io/npm/v/@cmsgov/hpt-validator-cli)](https://www.npmjs.com/package/@cmsgov/hpt-validator-cli)

CLI 用于验证 CMS 医院价格透明机器可读文件

## 开始

### 先决条件

这些是用于开发CLI工具的最低限度版本。 建议更新节点和国家预防机制的最新发布.

-   节点(20.x版)
-   国家预防机制(8.5.x版)

### 安装

在全球安装 CLI

```sh
npm install -g @cmsgov/hpt-validator-cli
```

### 使用量

```sh
cms-hpt-validator --help
Usage: cms-hpt-validator [options] <filepath> <version>

Arguments:
  filepath                   filepath to validate
  version                    version of data dictionary requirements to validate against (choices: "v2.1", "v2.2", "v3.0")

Options:
  -V, --version              output the CLI version number
  -f, --format <string>      file format of file (choices: "csv", "json")
  -o, --output <string>      output format (choices: "table", "json", default: "table")
  -e, --error-limit <value>  maximum number for errors (default: 1000)
  -h, --help                 display help for command
```

### 数据词典版本

参见 [医院价格透明数据词典仓库](https://github.com/CMSgov/hospital-price-transparency) 用于所有所需版本的文件.

### 实例

基本用途:

```sh
cms-hpt-validator ./sample.csv v3.0
```

覆盖默认错误限制以显示50个错误 :

```sh
cms-hpt-validator ./sample.csv v3.0 -e 50
```

覆盖默认错误限制以显示所有错误 :

```sh
cms-hpt-validator ./sample.csv v3.0 -e 0
```

使用 JSON 输出格式 :

```sh
cms-hpt-validator ./sample.csv v3.0 -o json
```

使用带有有限错误的 JSON 输出格式 :

```sh
cms-hpt-validator ./sample.csv v3.0 -o json -e 10
```

### 输出格式

CLI 支持两种输出格式:

#### 表格格式( 默认)

默认的表格格式提供了带有有色文字的可人阅读输出,以结构化的表格格式显示验证结果.

#### JSON 格式

JSON格式提供机器可读输出,包括:

-   文件信息(路径、验证器版本、时间戳)
-   验证状态(有效/无效)
-   错误和提醒计数
-   详细错误和提醒阵列

示例 JSON 输出 :

```json
{
  "file": "/path/to/sample.csv",
  "version": "1.10.0",
  "timestamp": "2025-01-11T17:00:00.000Z",
  "valid": false,
  "errorCount": 2,
  "alertCount": 1,
  "errors": [
    {
      "path": "C4",
      "field": "code | 1 | type",
      "message": "Invalid code type"
    }
  ],
  "alerts": [
    {
      "path": "D5",
      "field": "estimated_amount",
      "message": "Nine 9s used for estimated amount"
    }
  ]
}
```

### 机器可读文件扩展名

目前HPT MRF的两个允许文件格式是CSV和JSON. CLI 将自动检测传递到工具中的文件格式, 以结束文件 `.csv` 或者说 `.json` 并运行该文件的适当验证符。 CLI还可以检测被gzip压缩出的文件. 以 `.gz` 扩展将在验证前解压缩 。 这些文件格式检测可以合并,所以文件以 `.csv.gz` 或者说 `.json.gz` 将分别被解压和验证为CSV或JSON。 对于结束于 `.gz`,使用 `-f` 选项.

## 限制

可能存在CLI工具会因为在被验证文件中发现的错误数量而耗尽内存的情况. 如果您碰到了这个 NODE 错误, 请将错误的大小更新到一个较小的值, 允许随该值一起收集 `-e, --error-limit` 旗帜.

## 捐款

感谢您考虑为美国开放源码项目捐款 政府! 关于我们捐款准则的更多信息,见 [捐款额](https://npmcn.com/package/%40cmsgov/hpt-validator-cli/CONTRIBUTING.md)

## 警卫

关于我们的安全、脆弱和负责任的更多信息 披露政策,见 [警卫](https://npmcn.com/package/%40cmsgov/hpt-validator-cli/SECURITY.md)。 。 。 .

## 作者和维护者

撰稿人完整名单可在以下网址查阅: [https://github.cms.gov/CMSGov/hpt-validator-cli/graphs/controducers. 互联网档案馆的存檔,存档日期2014-12-21](https://github.cms.gov/CMSGov/hpt-validator-cli/graphs/contributors)。 。 。 .

## 公有领域

这个项目在美国的公有领域获得许可, 作品的版权和相关权利 [CC0 1.0 普遍公有领域 承诺](https://creativecommons.org/publicdomain/zero/1.0/)。 。 。 .

所有对该项目的贡献将在CC0专注下发布. 以 你同意遵守这项豁免 版权权益.

## 常见问题

### @cmsgov/hpt-validator-cli 是什么？

CLI 用于验证 CMS 医院价格透明机器可读文件

### 如何安装 @cmsgov/hpt-validator-cli？

在项目目录运行 npm install @cmsgov/hpt-validator-cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cms-hpt-validator，可以用 npx cms-hpt-validator 直接运行。

### @cmsgov/hpt-validator-cli 支持 TypeScript 吗？

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

### @cmsgov/hpt-validator-cli 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @cmsgov/hpt-validator-cli 可以商用吗？

@cmsgov/hpt-validator-cli 使用 CC0-1\.0 许可。作者放弃著作权，可不受限制地使用。以上为概括，不构成法律意见，请以许可原文为准。

### @cmsgov/hpt-validator-cli 的下载量有多少？

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

### @cmsgov/hpt-validator-cli 还在维护吗？

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