# @cucumber/gherkin-streams 中文文档

规范地址：https://npmcn.com/package/%40cucumber/gherkin-streams/

版本：7\.0\.1
npm 元数据更新时间：2026-06-20T07:19:59.221Z
中文译文更新时间：2026-11-11T04:24:55.925Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：44.6 kB，37 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：@cucumber/gherkin \>=22\.0\.0，@cucumber/message-streams \>=4\.0\.0，@cucumber/messages \>=17\.1\.1
- 首次发布：2021-03-24T14:17:40.480Z
- 最新版本发布：2026-06-20T07:19:58.925Z
- 近 30 天下载量：8480118（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 2 个）

## 中文简介

读取 Gherkin 剖析器输出的流

## 安装

```sh
npm install @cucumber/gherkin-streams
```

也可以使用：`pnpm add @cucumber/gherkin-streams`、`yarn add @cucumber/gherkin-streams`、`bun add @cucumber/gherkin-streams`

## README

# Gherkin 流线

这个模块包含使用有流的Gherkin库的公用事业.

## 安装

`gherkin-streams` 有3个同伴依赖关系: `@cucumber/gherkin`, (中文(简体) ), `@cucumber/messages` 财务报告和审定财务报表 `@cucumber/message-streams`。 。 。 .

你必须要有 `@cucumber/gherkin` 财务报告和审定财务报表`@cucumber/message-streams` 在你的属下, `@cucumber/messages` 自动安装 `@cucumber/gherkin`。 。 。 .

```
npm install @cucumber/gherkin-streams @cucumber/gherkin @cucumber/message-streams
```

## 使用量

```javascript
import { GherkinStreams } from '@cucumber/gherkin-streams'

const options = {
  includeSource: true,
  includeGherkinDocument: true,
  includePickles: true,
}
const stream = GherkinStreams.fromPaths(['features/hello.feature'])

// Pipe the stream to another stream that can read messages.
stream.pipe(...)
```

### 缩短URI `relativeTo`

包含 `relativeTo` 选项,以避免排放更长或绝对的铀RI,而使其仅相对于当前工作目录(或任何对您的使用有道理的东西):

```javascript
import { GherkinStreams } from '@cucumber/gherkin-streams'

// imagine `discoverPaths()` is a function that returns absolute paths
const paths = discoverPaths();
const options = {
  includeSource: true,
  includeGherkinDocument: true,
  includePickles: true,
  relativeTo: process.cwd()
}
const stream = GherkinStreams.fromPaths(paths)

// Pipe the stream to another stream that can read messages.
stream.pipe(...)
```

## 常见问题

### @cucumber/gherkin-streams 是什么？

读取 Gherkin 剖析器输出的流

### 如何安装 @cucumber/gherkin-streams？

在项目目录运行 npm install @cucumber/gherkin-streams，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@cucumber/gherkin（\>=22\.0\.0）、@cucumber/message-streams（\>=4\.0\.0）、@cucumber/messages（\>=17\.1\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 gherkin-javascript，可以用 npx gherkin-javascript 直接运行。

### @cucumber/gherkin-streams 支持 TypeScript 吗？

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

### @cucumber/gherkin-streams 支持 ESM 还是 CommonJS？

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

### @cucumber/gherkin-streams 可以商用吗？

@cucumber/gherkin-streams 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cucumber/gherkin-streams 的下载量有多少？

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

### @cucumber/gherkin-streams 还在维护吗？

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