@forge-ts/doctest (英语)

可执行文件测试 伪造 工具链。 摘录 @example 来自TSDoc 的代码块,并作为测试运行.

何时使用此软件包

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

npm install @forge-ts/doctest

如何运作

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

示例

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);
}

伪造的一部分

见 主还原 用于完整文档.

许可证

麻省理工学院