# @forge-ts/doctest 中文文档

规范地址：https://npmcn.com/package/%40forge-ts/doctest/

版本：0\.24\.0
npm 元数据更新时间：2026-04-13T18:57:12.723Z
中文译文更新时间：2026-11-15T07:24:18.016Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：40.4 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：1 个
- 首次发布：2026-03-18T21:16:53.430Z
- 最新版本发布：2026-04-13T18:57:12.450Z
- 近 30 天下载量：11507（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：35（近 12 个月 35 个）

## 中文简介

TSDoc @ 实例区块提取器和用于伪造的试跑器

## 安装

```sh
npm install @forge-ts/doctest
```

也可以使用：`pnpm add @forge-ts/doctest`、`yarn add @forge-ts/doctest`、`bun add @forge-ts/doctest`

## README

# @forge-ts/doctest (英语)

可执行文件测试 [伪造](https://github.com/kryptobaseddev/forge-ts) 工具链。 摘录 `@example` 来自TSDoc 的代码块,并作为测试运行.

## 何时使用此软件包

**大多数用户应安装 `@forge-ts/cli` 换成** 和使用情况 `npx forge-ts test`。本包供方案使用.

```bash
npm install @forge-ts/doctest
```

## 如何运作

1.  走动您的类型脚本 AST 查找 `@example` tSDoc 注释中的块
2.  生成自动输入导入的虚拟测试文件
3.  添加指向原始源的内置源地图
4.  转换 `// => value` 对断言的评论
5.  运行测试 通过节点24的内置 `node:test` 运行

## 示例

```typescript
import { loadConfig } from "@forge-ts/core";
import { doctest } from "@forge-ts/doctest";

const config = await loadConfig();
const result = await doctest(config);

if (!result.success) {
  console.error(`${result.errors.length} doctest(s) failed`);
  process.exit(1);
}
```

## 伪造的一部分

见 [主还原](https://github.com/kryptobaseddev/forge-ts) 用于完整文档.

## 许可证

麻省理工学院

## 常见问题

### @forge-ts/doctest 是什么？

TSDoc @ 实例区块提取器和用于伪造的试跑器

### 如何安装 @forge-ts/doctest？

在项目目录运行 npm install @forge-ts/doctest，或使用 pnpm add / yarn add / bun add。

### @forge-ts/doctest 支持 TypeScript 吗？

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

### @forge-ts/doctest 支持 ESM 还是 CommonJS？

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

### @forge-ts/doctest 需要什么版本的 Node\.js？

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

### @forge-ts/doctest 可以商用吗？

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

### @forge-ts/doctest 的下载量有多少？

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

### @forge-ts/doctest 还在维护吗？

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