Skip to content

Commit 2481dcd

Browse files
authored
docs: update jest configuration mappings (#579)
1 parent 48a6c3d commit 2481dcd

File tree

2 files changed

+35
-25
lines changed

2 files changed

+35
-25
lines changed

website/docs/en/guide/migration/jest.mdx

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,22 @@ export default defineConfig({
3333

3434
Here are some common Jest configurations and their Rstest equivalents:
3535

36-
| Jest Configuration | Rstest Equivalent |
37-
| ---------------------------- | -------------------- |
38-
| `testRegex` | `include` |
39-
| `testMatch` | `include` |
40-
| `testPathIgnorePatterns` | `exclude` |
41-
| `injectGlobals` | `globals` |
42-
| `moduleNameMapper` | `resolve.alias` |
43-
| `collectCoverage` | `coverage.enabled` |
44-
| `coverageDirectory` | `coverage.directory` |
45-
| `coverageProvider` | `coverage.provider` |
46-
| `coveragePathIgnorePatterns` | `coverage.exclude` |
36+
| Jest Configuration | Rstest Equivalent |
37+
| ---------------------------- | --------------------------------------------------------------------- |
38+
| `testRegex` | [`include`](/config/test/include) |
39+
| `testMatch` | [`include`](/config/test/include) |
40+
| `testPathIgnorePatterns` | [`exclude`](/config/test/exclude) |
41+
| `transformIgnorePatterns` | [`source.exclude`](/config/build/source#sourceexclude) |
42+
| `displayName` | [`name`](/config/test/name) |
43+
| `rootDir` | [`root`](/config/test/root) |
44+
| `verbose` | [`verbose-reporter`](/config/test/reporters#verbose-reporter) |
45+
| `injectGlobals` | [`globals`](/config/test/globals) |
46+
| `moduleNameMapper` | [`resolve.alias`](/config/build/resolve#resolvealias) |
47+
| `collectCoverage` | [`coverage.enabled`](/config/test/coverage#enabled) |
48+
| `coverageDirectory` | [`coverage.reportsDirectory`](/config/test/coverage#reportsdirectory) |
49+
| `coverageProvider` | [`coverage.provider`](/config/test/coverage#provider) |
50+
| `coveragePathIgnorePatterns` | [`coverage.exclude`](/config/test/coverage#exclude) |
51+
| `coverageThreshold` | [`coverage.thresholds`](/config/test/coverage#thresholds) |
4752

4853
For more details, please refer to the [Configuration](/config) section.
4954

website/docs/zh/guide/migration/jest.mdx

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,19 +33,24 @@ export default defineConfig({
3333

3434
以下是一些常见的 Jest 配置及其对应的 Rstest 配置:
3535

36-
| Jest 配置 | Rstest 等效配置 |
37-
| ---------------------------- | -------------------- |
38-
| `testRegex` | `include` |
39-
| `testMatch` | `include` |
40-
| `testPathIgnorePatterns` | `exclude` |
41-
| `injectGlobals` | `globals` |
42-
| `moduleNameMapper` | `resolve.alias` |
43-
| `collectCoverage` | `coverage.enabled` |
44-
| `coverageDirectory` | `coverage.directory` |
45-
| `coverageProvider` | `coverage.provider` |
46-
| `coveragePathIgnorePatterns` | `coverage.exclude` |
47-
48-
更多详情,请参考[配置](/config)部分。
36+
| Jest 配置 | Rstest 对等配置 |
37+
| ---------------------------- | --------------------------------------------------------------------- |
38+
| `testRegex` | [`include`](/config/test/include) |
39+
| `testMatch` | [`include`](/config/test/include) |
40+
| `testPathIgnorePatterns` | [`exclude`](/config/test/exclude) |
41+
| `transformIgnorePatterns` | [`source.exclude`](/config/build/source#sourceexclude) |
42+
| `displayName` | [`name`](/config/test/name) |
43+
| `rootDir` | [`root`](/config/test/root) |
44+
| `verbose` | [`verbose-reporter`](/config/test/reporters#verbose-reporter) |
45+
| `injectGlobals` | [`globals`](/config/test/globals) |
46+
| `moduleNameMapper` | [`resolve.alias`](/config/build/resolve#resolvealias) |
47+
| `collectCoverage` | [`coverage.enabled`](/config/test/coverage#enabled) |
48+
| `coverageDirectory` | [`coverage.reportsDirectory`](/config/test/coverage#reportsdirectory) |
49+
| `coverageProvider` | [`coverage.provider`](/config/test/coverage#provider) |
50+
| `coveragePathIgnorePatterns` | [`coverage.exclude`](/config/test/coverage#exclude) |
51+
| `coverageThreshold` | [`coverage.thresholds`](/config/test/coverage#thresholds) |
52+
53+
更多详情,请参考 [配置文档](/config)
4954

5055
### 注入全局 API
5156

@@ -85,7 +90,7 @@ Rstest 提供了与 Jest 兼容的 API。因此,你只需将导入从 Jest 更
8590
+ import { describe, expect, it, test } from '@rstest/core';
8691
```
8792

88-
Rstest 提供了一个 `rstest` API,你可以使用它来访问 Rstest 的工具函数,如 `rstest.fn()``rstest.mock()`。就像 Jest 的 `jest.fn()``jest.mock()` 一样。更多工具函数可以在 [Rstest APIs](/api/) 中找到。
93+
Rstest 提供了 `rstest` API,你可以使用它来访问 Rstest 的工具函数,如 `rstest.fn()``rstest.mock()`。就像 Jest 的 `jest.fn()``jest.mock()` 一样。更多工具函数可以在 [Rstest APIs](/api/) 中找到。
8994

9095
```diff
9196
- const fn = jest.fn();

0 commit comments

Comments
 (0)