# @bahmutov/add-typescript-to-cypress 中文文档

规范地址：https://npmcn.com/package/%40bahmutov/add-typescript-to-cypress/

版本：2\.1\.2
npm 元数据更新时间：2022-04-04T17:30:39.208Z
中文译文更新时间：2026-11-07T15:15:14.490Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：10.9 kB，6 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=6
- 运行依赖：7 个
- peer 依赖：typescript \*
- 首次发布：2017-12-01T03:39:11.931Z
- 最新版本发布：2019-06-08T06:42:33.165Z
- 近 30 天下载量：10643（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 0 个）

## 中文简介

快速向 Cypress 添加类型Script 光谱支持

## 安装

```sh
npm install @bahmutov/add-typescript-to-cypress
```

也可以使用：`pnpm add @bahmutov/add-typescript-to-cypress`、`yarn add @bahmutov/add-typescript-to-cypress`、`bun add @bahmutov/add-typescript-to-cypress`

## README

# @bahmutov/add-typescript-to-cypress (中文(简体) )

> 快速向 Cypress 添加类型Script 光谱支持

[![NPM](https://nodei.co/npm/@bahmutov/add-typescript-to-cypress.svg?downloads=true)](https://npmjs.org/package/@bahmutov/add-typescript-to-cypress)

 [![Build status](https://travis-ci.org/bahmutov/add-typescript-to-cypress.svg?branch=master)](https://travis-ci.org/bahmutov/add-typescript-to-cypress)[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg) ](https://github.com/semantic-release/semantic-release)[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/) [![renovate-app badge](https://img.shields.io/badge/renovate-app-blue.svg)](https://renovateapp.com/)

## 为什么

[齐压](https://www.cypress.io/) 很棒, 但不会从框中直接显示 TypeScript 支持 。 您需要安装 [Cypress 网页包预处理器](https://github.com/cypress-io/cypress-webpack-preprocessor) 或者说 [Cypress 浏览器化预处理器](https://github.com/cypress-io/cypress-browserify-preprocessor) 并配置到 [转写类型Script spec 文件](https://github.com/cypress-io/cypress-example-recipes/tree/master/examples/preprocessors__typescript-webpack)。 。 。 .

这太夸张了 用这个模块,你只需要执行常规 `npm install` 命令,您可以马上写入 TypeScript 光谱文件.

**说明** 覆盖已存在的 `cypress/plugins/index.js` 存档一次。 在其它安装中查找文件 `cypress/plugins/cy-ts-preprocessor.js` 以避免覆盖.

## 安装

在安装 Cypress (版本 1. x) 并打开一次后, 将工程脚手架 :

```sh
npm install --save-dev @bahmutov/add-typescript-to-cypress
```

这应该创建 [cypress/plugins/index.js (简体中文)](https://npmcn.com/package/%40bahmutov/add-typescript-to-cypress/src/plugin.js) 用于 `webpack` 预处理器和 `ts-loader` 转接 `.ts` 文档.

**说明** 此模块不安装类型脚本模块,而是将其列为一个 `peerDependency`。如果您的项目没有 `typescript` 但是,安装它与 `npm i -D typescript`。 。 。 .

**说明** 如果没有根 `tsconfig.json`,将创建空文件,否则 `ts-loader` 撞车.

## 使用

开始写吧 `*.ts` 查看和证明文件,它应该起作用。 如果尚未找到类型, 请在 spec 文件上方添加以下行

```
/// <reference types="Cypress" />
```

见 [执行中](https://www.youtube.com/watch?v=hxlrJAAeFeM&feature=youtu.be)

## 调试

用环境变量安装此软件包 `DEBUG=add-typescript-to-cypress`

## 弹出

如果您想要在安装一次后解开此模块, 您仍需要引用来自 [src/cy-ts-预处理器.js](https://npmcn.com/package/%40bahmutov/add-typescript-to-cypress/src/cy-ts-preprocessor.js)数字 :

-   [@ cypress/webpack- 预处理器](https://github.com/cypress-io/cypress-webpack-preprocessor#readme) (及其同伴依赖关系)
-   [装弹机](https://github.com/TypeStrong/ts-loader) (及其同伴依赖关系)

你可以安装它们

```bash
npm i -D @cypress/webpack-preprocessor ts-loader
```

然后解开这个包裹.

### 小印数

作者:格列布·巴赫穆托夫 <gleb.bahmutov@gmail.com> 2017年©

-   [@bahmutov (英语)](https://twitter.com/bahmutov)
-   [glebbahmutov.com (中文(简体) )](https://glebbahmutov.com/)
-   [博客](https://glebbahmutov.com/blog)

许可:麻省理工学院 - 做任何与代码有关的事情, 但如果它不起作用,不要责怪我.

支持: 如果您发现此模块有任何问题, 电子邮件 / 微博 / [未决问题](https://github.com/bahmutov/add-typescript-to-cypress/issues) 在基图布

## MIT 许可证

版权 (c) 2017 Gleb Bahmutov <gleb.bahmutov@gmail.com>

特此免费准许任何人 获取该软件和相关文件的副本 文件(“软件”),在软件中处理,不包含 限制,包括不限制使用权, 复制、修改、合并、出版、发行、分版和/或销售 软件的复制本,并允许向 为此提供了软件,但须符合下列条件: 条件:

上述版权通知和本许可通知应为: 列入软件的所有副本或大部分.

软件是提供的"是", 没有任何种类的恐惧, 或监禁,包括但不限制于 特别目的和目的的证明 无所不入。 绝对不能让警察或警察 B. 任何索赔、救济或其他负债的持有者, 条约、条约或其他条约行动 来源、来源或与溶剂或使用有关的 其他交易 在软件.

## 常见问题

### @bahmutov/add-typescript-to-cypress 是什么？

快速向 Cypress 添加类型Script 光谱支持

### 如何安装 @bahmutov/add-typescript-to-cypress？

在项目目录运行 npm install @bahmutov/add-typescript-to-cypress，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typescript（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @bahmutov/add-typescript-to-cypress 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/bahmutov\_\_add-typescript-to-cypress 是否存在。

### @bahmutov/add-typescript-to-cypress 支持 ESM 还是 CommonJS？

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

### @bahmutov/add-typescript-to-cypress 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=6。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @bahmutov/add-typescript-to-cypress 可以商用吗？

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

### @bahmutov/add-typescript-to-cypress 的下载量有多少？

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

### @bahmutov/add-typescript-to-cypress 还在维护吗？

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

