# @creditkarma/thrift-parser 中文文档

规范地址：https://npmcn.com/package/%40creditkarma/thrift-parser/

版本：2\.0\.0
npm 元数据更新时间：2022-06-22T18:47:00.187Z
中文译文更新时间：2026-11-11T00:12:16.203Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：156 kB，36 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2017-09-26T04:11:50.024Z
- 最新版本发布：2022-06-22T18:47:00.066Z
- 近 30 天下载量：35017（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：28（近 12 个月 0 个）

## 中文简介

以 TypeScript 书写的 Thrift 解析器

## 安装

```sh
npm install @creditkarma/thrift-parser
```

也可以使用：`pnpm add @creditkarma/thrift-parser`、`yarn add @creditkarma/thrift-parser`、`bun add @creditkarma/thrift-parser`

## README

# 类型脚本

用 TypeScript 编写的 Thrift 解析器 。 由此产生的AST可用于从Thrift文件中编码JavaScript,或者仅仅用于检查Thrift结构.

## 使用量

一个成功的解析返回了 ThriftDocument 对象 。 不成功的剖析返回 ThriftErrors 对象 .

```js
import { parse, ThriftDocument } from '@creditkarma/thrift-parser'


const rawThrift: string =`
  struct MyStruct {
    1: required i32 id
  }
`;

const thriftAST: ThriftDocument | ThriftErrors = parse(rawThrift);

switch(thriftAST.type) {
  case 'ThriftDocument':
    // Do something with valid AST
  case 'ThriftErrors':
    // Report or recover from errors
}
```

您也可以使用命令行或 npm 脚本中的 Thrift Parser 。 当从命令行使用生成的 AST 时被保存为 JSON .

```sh
$ thrift-parser --rootDir thrift --outDir thrift-json --fastFail false some_file.thrift
```

在这种使用中,有三种选择:

-   \--rootDir: 在哪里启动文件搜索并保存
-   \--outDir: 相对于 rootDir 保存输出文件的位置
-   \-- fastFail: 如果遇到第一个错误时出现真实失败

### 构建

```sh
$ npm install
$ npm run build
```

### 测试

```sh
$ npm test
```

## AST 结构

返回的 AST 的根是 Thrift Document( 成功剖析) 或 ThriftErrors( 未成功剖析) .

### 调色文件

```typescript
{
  type: "ThriftDocument",
  body: Array<ThriftStatement>
}
```

### 扰动错误

```typescript
{
  type: "ThriftErrors",
  errors: Array<ThriftError>
}
```

#### 扭曲

在解析指定 Thrift 源时描述出出错的描述符 .

```typescript
{
  type: "ParseError" | "ScanError",
  message: string,
  loc: TextLocation
}
```

### 倾斜语句

Thrift Systems代表了在 Thrift source中可以定义的每个主构造.

#### 名称空间定义

```
namespace <identifier> <identifier>
```

```typescript
{
  type: "NamespaceDefinition",
  scope: Identifier,
  name: Identifier
}
```

#### 包含定义

```
include '<path>'"
```

```typescript
{
  type: "IncludeDefinition",
  path: StringLiteral
}
```

#### 类型定义

```
typedef <field-type> <identifier>
```

```typescript
{
  type: "TypedefDefinition",
  name: Identifier,
  definitionType: FieldType
}
```

#### 定义

```
const <field-type> <identifier> = <initializer>
```

```typescript
{
  type: "ConstDefinition",
  name: Identifier,
  fieldType: FieldType,
  initializer: ConstValue,
}
```

#### 定义

```
enum <identifier> { <members> }
```

```typescript
{
  type: "EnumDefinition",
  name: Identifier,
  members: Array<EnumMember>
}
```

#### 定义

```
struct <identifier> { <fields> }
```

```typescript
{
  type: "StructDefinition",
  name: Identifier,
  fields: Array<FieldDefinition>
}
```

#### 联盟定义

```
union <identifier> { <fields> }
```

```typescript
{
  type: "UnionDefinition",
  name: Identifier,
  fields: Array<FieldDefinition>
}
```

#### 例外定义

```
exception <identifier> { <fields> }
```

```typescript
{
  type: "ExceptionDefinition",
  name: Identifier,
  fields: Array<FieldDefinition>
}
```

#### 服务定义

```
service <identifier> (extends <identifier>)? { <functions> }
```

```typescript
{
  type: "ServiceDefinition",
  name: Identifier,
  extends: Identifier | null,
  functions: Array<FunctionDefinition>
}
```

## 使用 AST 爆炸器查看

ASTExplorer是可视化AST的网络应用. 您输入源。 它显示基于您所选择的解析器生成的语法树. 我已经包括了这个解析器的整合。 为了把那个弄好,你需要克隆ASTExplorer.

```sh
$ git clone https://github.com/fkling/astexplorer.git
$ cd astexplorer/website
$ npm install
```

您现在需要为 AST Explorer 安装节俭 Parser

```sh
$ npm install @creditkarma/thrift-parser
```

酷,现在我们需要复制一些东西 在ASTExplorer项目.

如果ASTExplorer项目和@creditkarma/thrift-parser项目是兄弟姐妹,您可以输入到temrinal(从astexplorer/website)中.

```sh
$ cp -r ../../thrift-parser/astexplorer/thrift ./src/parsers/thrift
```

您现在需要建立 AST 探索器并启动服务器

```sh
$ npm run build
$ npm start
```

默认情况下, 这将在本地主机: 8080 启动 AST Explorer

要选择要使用的语言, 请选择“ Thrift IDL ”

注意:我有些困难 `npm run build` 工作的时候。 然而,手表的建造要可靠得多.

```sh
$ npm run watch
```

然后在另一个终端窗口运行 `start`。 。 。 .

```sh
$ npm start
```

## 捐款

欲了解更多关于贡献新功能和错误修正的信息,请参见我们 [贡献准则](https://github.com/creditkarma/CONTRIBUTING.md)。 。 。 . 外部捐助者必须签署捐助者许可证协定

## 许可证

这个项目的许可证根据 [Apache 许可证版本 2.0](https://npmcn.com/package/%40creditkarma/thrift-parser/LICENSE)

## 常见问题

### @creditkarma/thrift-parser 是什么？

以 TypeScript 书写的 Thrift 解析器

### 如何安装 @creditkarma/thrift-parser？

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

### @creditkarma/thrift-parser 支持 TypeScript 吗？

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

### @creditkarma/thrift-parser 支持 ESM 还是 CommonJS？

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

### @creditkarma/thrift-parser 可以商用吗？

@creditkarma/thrift-parser 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @creditkarma/thrift-parser 的下载量有多少？

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

### @creditkarma/thrift-parser 还在维护吗？

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