#快速上手

#在线示例

你可以通过以下示例在线尝试 Rstest，无需任何设置：

• StackBlitz 示例

#环境准备

开始之前，需要先安装 Node.js >= 18 版本，推荐使用 Node.js LTS 版本。

通过以下命令检查当前的 Node.js 版本：

node -v

如果你的环境中尚未安装 Node.js，或是版本太低，可以通过 nvm 或 fnm 安装。

下面是通过 nvm 安装的例子：

# 安装 Node.js LTS
nvm install --lts
# 切换 Node.js LTS
nvm use --lts

#使用 Rstest

你可以通过如下命令安装 Rstest：

npm add @rstest/core -D

yarn add @rstest/core -D

pnpm add @rstest/core -D

bun add @rstest/core -D

deno add npm:@rstest/core -D

下一步，你需要在 package.json 的 npm scripts 中添加 Rstest 命令：

{
  "scripts": {
    "test": "rstest"
  }
}

完成以上步骤后，你即可通过 npm run test、yarn test 或 pnpm test 来运行 Rstest 测试。当然，你也可以直接使用 npx rstest 来运行 Rstest 测试。

Rstest 内置了 watch、run 等命令，请参考 CLI 工具 来了解所有可用命令以及选项。

#编写测试

作为一个简单的例子，我们有一个 sayHi 方法。为了对它进行测试，你可以创建一个名为 index.test.ts 的测试文件或使用与 Rust 测试 类似的 In-Source 测试。

export const sayHi = () => 'hi';

import { expect, test } from '@rstest/core';
import { sayHi } from '../src/index';

test('should sayHi correctly', () => {
  expect(sayHi()).toBe('hi');
});

接下来，你可以通过 使用 Rstest 中配置好的命令执行测试。Rstest 会打印如下内容：

 ✓ test/index.test.ts (1)

 Test Files 1 passed
      Tests 1 passed
   Duration 140 ms (build 17 ms, tests 123 ms)