!docs: building 1.x document

.vitepress/components.d.ts

@@ -1,10 +1,10 @@
 /* eslint-disable */
+/* prettier-ignore */
 // @ts-nocheck
 // Generated by unplugin-vue-components
 // Read more: https://github.com/vuejs/core/pull/3399
 export {}
 
-/* prettier-ignore */
 declare module 'vue' {
   export interface GlobalComponents {
     Contributors: typeof import('./components/Contributors.vue')['default']

.vitepress/components/FeaturesList.vue

@@ -86,7 +86,6 @@
       >expect-type</a>
       进行类型测试
     </ListItem>
-    <ListItem>支持分片</ListItem>
   </ul>
 </template>
 

.vitepress/config.ts

@@ -32,13 +32,13 @@ export default () => {
       en: {
         label: 'English',
         lang: 'en',
-        link: 'https://vitest.dev/',
+        link: 'https://v1.vitest.dev/',
       },
     },
     head: [
       ['meta', { name: 'theme-color', content: '#729b1a' }],
-      ['link', { rel: 'icon', href: '/favicon.ico', sizes: '48x48' }],
-      ['link', { rel: 'icon', href: '/logo.svg', sizes: 'any', type: 'image/svg+xml' }],
+      ['link', { rel: 'icon', href: '/favicon.ico', sizes: 'any' }],
+      ['link', { rel: 'icon', href: '/logo.svg', type: 'image/svg+xml' }],
       ['meta', { name: 'author', content: `${teamMembers.map(c => c.name).join(', ')} and ${vitestName} contributors` }],
       ['meta', { name: 'keywords', content: 'vitest, vite, test, coverage, snapshot, react, vue, preact, svelte, solid, lit, marko, ruby, cypress, puppeteer, jsdom, happy-dom, test-runner, jest, typescript, esm, tinypool, tinyspy, node' }],
       ['meta', { property: 'og:title', content: vitestName }],
@@ -69,7 +69,7 @@ export default () => {
       logo: '/logo.svg',
 
       editLink: {
-        pattern: 'https://github.com/vitest-dev/docs-cn/tree/dev/:path',
+        pattern: 'https://github.com/vitest-dev/docs-cn/tree/v1/:path',
         text: '为此页提供修改建议',
       },
 
@@ -123,7 +123,7 @@ export default () => {
                   text: '社区指南',
                   link: contributing,
                 },
-              ]
+              ],
             },
             {
               items: [
@@ -135,10 +135,6 @@ export default () => {
                   text: 'v0.x',
                   link: 'https://v0.vitest.dev/',
                 },
-                {
-                  text: 'v1.x',
-                  link: 'https://v1.vitest.dev/',
-                },
               ],
             },
           ],
@@ -173,12 +169,12 @@ export default () => {
             ],
           },
         ],
-        '/': [
+        '/guide/': [
           {
             text: '指南',
             items: [
               {
-                text: '简介',
+                text: '为什么是 Vitest?',
                 link: '/guide/why',
               },
               {
@@ -222,45 +218,12 @@ export default () => {
                 link: '/guide/testing-types',
               },
               {
-                text: 'Vitest UI',
+                text: 'UI 模式',
                 link: '/guide/ui',
               },
               {
                 text: '浏览器模式',
-                link: '/guide/browser/',
-                collapsed: false,
-                items: [
-                  {
-                    text: 'Assertion API',
-                    link: '/guide/browser/assertion-api',
-                    docFooterText: 'Assertion API | Browser Mode',
-                  },
-                  {
-                    text: 'Retry-ability',
-                    link: '/guide/browser/retry-ability',
-                    docFooterText: 'Retry-ability | Browser Mode',
-                  },
-                  {
-                    text: 'Context',
-                    link: '/guide/browser/context',
-                    docFooterText: 'Context | Browser Mode',
-                  },
-                  {
-                    text: 'Interactivity API',
-                    link: '/guide/browser/interactivity-api',
-                    docFooterText: 'Interactivity API | Browser Mode',
-                  },
-                  {
-                    text: 'Commands',
-                    link: '/guide/browser/commands',
-                    docFooterText: 'Commands | Browser Mode',
-                  },
-                  {
-                    text: 'Examples',
-                    link: '/guide/browser/examples',
-                    docFooterText: 'Examples | Browser Mode',
-                  },
-                ],
+                link: '/guide/browser',
               },
               {
                 text: '源码内联测试',
@@ -287,7 +250,7 @@ export default () => {
                 link: '/guide/debugging',
               },
               {
-                text: '与其他测试框架对比',
+                text: '测试框架比较',
                 link: '/guide/comparisons',
               },
               {
@@ -304,6 +267,8 @@ export default () => {
               },
             ],
           },
+        ],
+        '/api/': [
           {
             text: 'API',
             items: [
@@ -337,6 +302,8 @@ export default () => {
               },
             ],
           },
+        ],
+        '/config/': [
           {
             text: '配置',
             items: [

advanced/api.md

@@ -4,7 +4,7 @@
 Vitest 暴露了实验性的私有 API。由于可能不遵循语义化版本规范（SemVer），因此可能会出现不兼容的更改，请在使用 Vitest 时锁定版本。
 :::
 
-## 启动 Vitest
+## startVitest
 
 你可以使用 Vitest 的 Node API 开始运行 Vitest 测试：
 
@@ -34,7 +34,7 @@ await vitest?.close()
 
 或者，你可以将完整的 Vite 配置作为第四个参数传递进去，这将优先于任何其他用户定义的选项。
 
-## 创建 Vitest
+## createVitest
 
 你可以使用 `createVitest` 函数创建自己的 Vitest 实例. 它返回与 `startVitest` 相同的 `Vitest` 实例, 但不会启动测试，也不会验证已安装的包。
 
@@ -62,9 +62,8 @@ Vitest 实例需要当前的测试模式。它可以是以下之一：
 
 - 运行运行时测试时为 `test`
 - 运行基准测试时为 `benchmark`
-- 运行类型测试时为 `typecheck`
 
-### 模式
+### 模式 {#mode}
 
 #### test
 
@@ -74,53 +73,6 @@ Vitest 实例需要当前的测试模式。它可以是以下之一：
 
 基准测试模式会调用 `bench` 函数，并在遇到 `test` 或 `it` 时抛出错误。此模式使用配置中的 `benchmark.include` 和 `benchmark.exclude` 选项查找基准测试文件。
 
-#### typecheck
-
-类型检查模式不会*运行*测试。它仅分析类型并提供摘要信息。此模式使用配置中的 `typecheck.include` 和 `typecheck.exclude` 选项查找要分析的文件。
-
 ### start
 
 你可以使用 `start` 方法运行测试或者基准测试。你还可以传递一个字符串数组以筛选测试文件。
-
-
-### `provide`
-
-Vitest 暴露了`provide`方法，它是`vitest.getCoreWorkspaceProject().provide`的简写。使用该方法，您可以从主线程向测试传递值。所有值在存储前都会通过 `structuredClone`进行检查，但值本身不会被克隆。
-
-要在测试中接收值，需要从 `vitest` entrypont 导入 `inject` 方法：
-
-```ts
-import { inject } from 'vitest'
-const port = inject('wsPort') // 3000
-```
-
-为了提高类型安全性，我们鼓励您增强 `ProvidedContext` 的类型：
-
-```ts
-import { createVitest } from 'vitest/node'
-
-const vitest = await createVitest('test', {
-  watch: false,
-})
-vitest.provide('wsPort', 3000)
-
-declare module 'vitest' {
-  export interface ProvidedContext {
-    wsPort: number
-  }
-}
-```
-
-::: warning
-从技术上讲，`provide`是`WorkspaceProject`的一个方法，因此仅限于特定的项目。不过，所有项目都继承了核心项目的值，这使得 `vitest.provide` 成为向测试传递值的通用方法。
-:::
-
-::: tip
-在不想使用公共 API 的情况下，[全局设置文件](/config/#globalsetup) 也可以使用此方法：
-
-```js
-export default function setup({ provide }) {
-  provide('wsPort', 3000)
-}
-```
-:::

advanced/runner.md

@@ -31,7 +31,7 @@ export interface VitestRunner {
    * 这是在实际运行测试函数之前被调用的。
    * 此时已经有了带有 "state" 和 "startTime" 属性的 "result" 对象。
    */
-  onBeforeTryTask?: (test: TaskPopulated, options: { retry: number, repeats: number }) => unknown
+  onBeforeTryTask?: (test: TaskPopulated, options: { retry: number; repeats: number }) => unknown
   /**
    * 这是在结果和状态都被设置之后被调用的。
    */
@@ -40,7 +40,7 @@ export interface VitestRunner {
    * 这是在运行测试函数后立即被调用的。此时还没有新的状态。
    * 如果测试函数抛出异常，将不会调用此方法。
    */
-  onAfterTryTask?: (test: TaskPopulated, options: { retry: number, repeats: number }) => unknown
+  onAfterTryTask?: (test: TaskPopulated, options: { retry: number; repeats: number }) => unknown
 
   /**
    * 这是在运行单个测试套件之前被调用的，此时还没有测试结果。
@@ -80,7 +80,7 @@ export interface VitestRunner {
   /**
    * 这个方法被用于 "test" 和 "custom" 处理程序。
    * 你可以在 "setupFiles" 中使用 "beforeAll" 来定义自定义上下文，而不是使用 runner。
-   * 更多信息请参考：https://vitest.dev/advanced/runner.html#your-task-function
+   * 更多信息请参考：https://v1.vitest.dev/advanced/runner.html#your-task-function
    */
   extendTaskContext?: <T extends Test | Custom>(context: TaskContext<T>) => TaskContext<T>
   /**