Skip to content

Commit 66df601

Browse files
committed
chore: add eslint-plugin-docs-style eslint plugin
1 parent 484c532 commit 66df601

44 files changed

Lines changed: 102 additions & 180 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!-- 感谢你的贡献! -->
22

33
### 在提交PR之前,请确保您执行以下操作:
4-
- [ ] 曾阅读过[翻译须知](https://github.com/vitest-dev/docs-cn/issues/391)
4+
- [ ] 曾阅读过 [翻译须知](https://github.com/vitest-dev/docs-cn/issues/391)
55
- [ ] 检查是否已经有PR以同样的方式解决问题,以避免创建重复。
66
- [ ] 在此PR中描述正在解决的问题,或引用它解决的问题(例如:`fixes #123`)。
77

advanced/pool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 自定义运行池
1+
# 自定义运行池 <Badge type="danger">advanced</Badge> {#custom-pool}
22

33
::: warning
44
这是一个高级且非常底层的 API。如果你只是想 [运行测试](/guide/),你可能不需要这个。它主要由库作者使用。

api/advanced/metadata.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 任务元数据 <Badge type="danger">高级</Badge>
1+
# 任务元数据 <Badge type="danger">高级</Badge> {#task-metadata}
22

33
如果你正在开发自定义报告器或使用 Vitest Node.js API,你可能会发现将在各种上下文中执行的测试中的数据传递给报告器或自定义 Vitest 处理程序很有用。
44

@@ -42,7 +42,7 @@ Vitest 使用不同的方法与 Node.js 进程进行通信。
4242

4343
该属性也会出现在每个测试的 `json` 报告中,因此请确保数据可以序列化为 JSON。
4444

45-
另外,请确保在设置[错误属性](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm#error_types)之前序列化它们。
45+
另外,请确保在设置 [错误属性](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm#error_types) 之前序列化它们。
4646
:::
4747

4848
当测试运行完成时,你还可以从 Vitest 状态获取此信息:

api/advanced/plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Vitest 通过 `Vite` namespace 重新导出所有仅 Vite 类型的导入,我
5959

6060
### project
6161

62-
该插件所属的当前[测试项目](./test-project)
62+
该插件所属的当前 [测试项目](./test-project)
6363

6464
::: warning 浏览器模式
6565
请注意,如果我们依赖浏览器功能,则 `project.browser` 字段尚未设置。请改用 [`reporter.onBrowserInit`](./reporters#onbrowserinit) 事件。

api/advanced/runner.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 运行器 API <Badge type="danger">advanced</Badge>
1+
# 运行器 API <Badge type="danger">advanced</Badge> {#runner-api}
22

33
::: warning 注意
44
这是高级 API。如果你只需要 [运行测试](/guide/),你可能不需要这个。它主要被库的作者使用。

api/advanced/test-module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ describe('the validation works correctly', (task) => {
6666
```
6767

6868
:::tip
69-
如果元数据是在收集过程中附加的(在 `test` 函数之外),那么它将在自定义报告器中的['onTestModuleCollectd'](./reporters#onTestModuleCollected) 挂钩中可用。
69+
如果元数据是在收集过程中附加的(在 `test` 函数之外),那么它将在自定义报告器中的 ['onTestModuleCollectd'](./reporters#onTestModuleCollected) 挂钩中可用。
7070
:::
7171

7272
## diagnostic

api/advanced/vitest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ const testCase = vitest.state.getReportedEntity(task) // 新 API
7878

7979
## projects
8080

81-
这是一个数组,里面包含了所有 [测试项目](/api/advanced/test-project) ,这些项目是用户自己定义的。如果用户没有显式指定任何项目,那么这个数组中只会包含一个 [根项目](#getrootproject)
81+
这是一个数组,里面包含了所有 [测试项目](/api/advanced/test-project),这些项目是用户自己定义的。如果用户没有显式指定任何项目,那么这个数组中只会包含一个 [根项目](#getrootproject)
8282

8383
Vitest 会保证这个数组里至少有一个项目可用。如果用户在命令行里通过 --project 参数指定了不存在的项目名称,Vitest 会在创建这个数组前就报错。
8484

api/browser/assertions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Vitest 默认提供了一组丰富的 DOM 断言,这些断言源自 [`@testing
1414
```
1515
:::
1616

17-
浏览器中的测试由于其异步特性,可能会不一致地失败。因此,即使条件延迟(如超时、网络请求或动画),也必须有办法保证断言成功。为此,Vitest 通过 [`expect.poll`](/api/expect#poll)`expect.element` API 提供了可重试的断言:
17+
浏览器中的测试由于其异步特性,可能会不一致地失败。因此,即使条件延迟(如超时、网络请求或动画),也必须有办法保证断言成功。为此,Vitest 通过 [`expect.poll`](/api/expect#poll) `expect.element` API 提供了可重试的断言:
1818

1919
```ts
2020
import { expect, test } from 'vitest'
@@ -433,7 +433,7 @@ function toHaveAccessibleErrorMessage(message?: string | RegExp): Promise<void>
433433

434434
这允许你断言一个元素具有预期的 [可访问错误消息](https://w3c.github.io/aria/#aria-errormessage)。
435435

436-
你可以传递预期的可访问错误消息的确切字符串。或者,你可以通过传递正则表达式或使用 [`expect.stringContaining`](/api/expect#expect-stringcontaining) 或 [`expect.stringMatching`](/api/expect#expect-stringmatching)来进行部分匹配。
436+
你可以传递预期的可访问错误消息的确切字符串。或者,你可以通过传递正则表达式或使用 [`expect.stringContaining`](/api/expect#expect-stringcontaining) 或 [`expect.stringMatching`](/api/expect#expect-stringmatching) 来进行部分匹配。
437437

438438
```html
439439
<input
@@ -480,7 +480,7 @@ await expect.element(
480480
function toHaveAccessibleName(name?: string | RegExp): Promise<void>
481481
```
482482

483-
这允许你断言一个元素具有预期的[可访问名称](https://w3c.github.io/accname/)。例如,它有助于断言表单元素和按钮是否被正确标记。
483+
这允许你断言一个元素具有预期的 [可访问名称](https://w3c.github.io/accname/)。例如,它有助于断言表单元素和按钮是否被正确标记。
484484

485485
你可以传递预期的可访问名称的确切字符串,或者通过传递正则表达式进行部分匹配,也可以使用 [`expect.stringContaining`](/api/expect#expect-stringcontaining) 或 [`expect.stringMatching`](/api/expect#expect-stringmatching)。
486486

@@ -512,7 +512,7 @@ await expect.element(getByTestId('input-title')).toHaveAccessibleName()
512512
function toHaveAttribute(attribute: string, value?: unknown): Promise<void>
513513
```
514514

515-
这允许你检查给定的元素是否具有某个属性。你还可以选择性地验证该属性是否具有特定的预期值或使用 [`expect.stringContaining`](/api/expect#expect-stringcontaining) 或 [`expect.stringMatching`](/api/expect#expect-stringmatching)进行部分匹配。
515+
这允许你检查给定的元素是否具有某个属性。你还可以选择性地验证该属性是否具有特定的预期值或使用 [`expect.stringContaining`](/api/expect#expect-stringcontaining) 或 [`expect.stringMatching`](/api/expect#expect-stringmatching) 进行部分匹配。
516516

517517
```html
518518
<button data-testid="ok-button" type="submit" disabled>ok</button>
@@ -948,7 +948,7 @@ await expect.element(getByTestId('switch')).toHaveRole('alert') // ❌
948948
function toHaveSelection(selection?: string): Promise<void>
949949
```
950950

951-
这允许断言某个元素具有一个[文本选择](https://developer.mozilla.org/en-US/docs/Web/API/Selection)。
951+
这允许断言某个元素具有一个 [文本选择](https://developer.mozilla.org/en-US/docs/Web/API/Selection)。
952952

953953
这在检查元素内是否选择了文本或部分文本时非常有用。该元素可以是文本类型的输入框、`textarea`,或者是任何包含文本的其他元素,例如段落、`span``div` 等。
954954

api/browser/commands.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: 命令 | 浏览器模式
33
outline: deep
44
---
55

6-
# 命令
6+
# 命令 {#commands}
77

88
命令是一个函数,它调用服务器上的另一个函数并将结果传递回浏览器。Vitest 公开了几个可以在浏览器测试中使用的内置命令。
99

@@ -59,7 +59,7 @@ expect(input).toHaveValue('a')
5959
```
6060

6161
::: warning
62-
CDP session仅适用于 `playwright` provider,并且仅在使用 `chromium` 浏览器时有效。有关详细信息,请参阅 playwright 的 [`CDPSession`](https://playwright.dev/docs/api/class-cdpsession)文档。
62+
CDP session仅适用于 `playwright` provider,并且仅在使用 `chromium` 浏览器时有效。有关详细信息,请参阅 playwright 的 [`CDPSession`](https://playwright.dev/docs/api/class-cdpsession) 文档。
6363
:::
6464

6565
## 自定义命令 {#custom-commands}
@@ -133,7 +133,7 @@ Vitest 在命令上下文中公开了几个`playwright`特定属性。
133133
- `page`引用包含测试 iframe 的完整页面。这是协调器 HTML,为避免出现问题,最好不要碰它。
134134
- `frame` 是一个异步方法,用于解析测试器 [`Frame`](https://playwright.dev/docs/api/class-frame)。它的 API 与 `page` 类似,但不支持某些方法。如果您需要查询元素,应优先使用 `context.iframe` 代替,因为它更稳定、更快速。
135135
- `iframe` 是一个 [`FrameLocator`](https://playwright.dev/docs/api/class-framelocator),用于查询页面上的其他元素。
136-
- `context` 是指唯一的[BrowserContext](https://playwright.dev/docs/api/class-browsercontext)
136+
- `context` 是指唯一的 [BrowserContext](https://playwright.dev/docs/api/class-browsercontext)
137137

138138
```ts
139139
import { BrowserCommand } from 'vitest/node'

api/browser/context.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,15 +179,15 @@ await frame.click() // ❌ 不可用
179179
::: danger IMPORTANT
180180
目前,`frameLocator` 方法仅支持 `playwright` 提供者。
181181

182-
交互方法(如 `click``fill`)在 iframe 内的元素上始终可用,但使用 `expect.element` 进行断言时要求 iframe 具有[同源策略](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy)。
182+
交互方法(如 `click``fill`)在 iframe 内的元素上始终可用,但使用 `expect.element` 进行断言时要求 iframe 具有 [同源策略](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy)。
183183
:::
184184

185185
## `cdp`
186186

187187
`cdp` 导出返回当前的 Chrome DevTools 协议会话。它主要用于库作者在其基础上构建工具。
188188

189189
::: warning
190-
CDP 会话仅适用于 `playwright` provider,并且仅在使用 `chromium` 浏览器时有效。有关详细信息,请参阅 playwright 的 [`CDPSession`](https://playwright.dev/docs/api/class-cdpsession)文档。
190+
CDP 会话仅适用于 `playwright` provider,并且仅在使用 `chromium` 浏览器时有效。有关详细信息,请参阅 playwright 的 [`CDPSession`](https://playwright.dev/docs/api/class-cdpsession) 文档。
191191
:::
192192

193193
```ts

0 commit comments

Comments
 (0)