因为非常炫酷的 Vitepress 升级了，所以咱的官方文档也跟着升级了，所以咱的中文文档也要跟着升级，已经开始进行该操作！请大家稍作等待，等升级完成在进行PR操作。

今天下午开始我会全力进行同步官方文档的任务，可能到时候会将各位的翻译直接照搬，有一个 commit 的覆盖问题，不知道各位是否在意这个事情？

@BTBMan @alexzhang1030 @ouduidui @baboon-king @jp-liu @zhangzhibang0309

针对 官方文档 中的一些技术单词的翻译讨论

欢迎 @watonyweng 加入Vitest 中文文档的翻译维护团队

https://cn.vitest.dev/

由于是提取出来的文档，所以可能需要各位同学先去 官方仓库 看一下是否同步，不同步在进行翻译的工作。目前工作量可能比较大，实在不好意思，我在思考解决的方案了，如果各位同学有解决方案也可以告诉我！

十分感谢各位的帮忙！！

领取方式，在本 issues 下评论即可。

• guide
  • index --- alexzhang1030
  • why --- __Catalina
  • features --- __Catalina
  • mocking --- XieZongChen
  • In-source testing --- John Long
  • debugging --- Lo
  • migration --- Lo
• API
  • test --- Dewey Ou
  • describe --- Dewey Ou
  • expect --- Dewey Ou
  • Setup and Teardown --- XieZongChen
  • Vi --- Lo
  • MockInstance Methods --- Lo
  • MockInstance Properties --- Lo
• config --- alexzhang1030

翻译任务认领说明

注意：

1. 一次尽量只认领一篇，给其他小伙伴留些机会~
2. 认领开始前，请务必阅读 翻译流程说明
3. 如果在翻译的时候发现有任何未同步的地方，及时指出，谢谢！

从 Todo List 中选取未被人领取过的文章：

未被领取过：

• install

领取过：

• install (@elonehoo)

领取过，已完成：

• install (@elonehoo) docs (cn) : api/toThrowErrorMatchingSnapshot translation #49

领取方式，在本 issues 下评论即可。

认领任务格式：

Section | Title | 译者 | 完成时间
-- | -- | -- | --
guide |  install | @elonehoo | 2022.05.06 - 2022.05.06

示例效果：

当完成时，请修改自己的认领评论，添加 PR 信息：

任务认领列表

Todo List:

• guide
  • index.md (@elonehoo) docs(cn): getting started translation #69
  • coverage.md (@elonehoo) docs(cn): coverage translation #70
  • extending-matchers.md
  • filtering.md (@amadeus711) docs(guide): translate filtering #71
  • ui.md (@amadeus711) docs(guide): translate vitest UI #73

非常感谢各位的翻译与同步工作！鉴于 Vitest 的 API 已经相对稳定，我认为现在是时候可以把该翻译项目官方化了！

@elonehoo 已邀请你到 GitHub Org，如果你愿意的话可以将仓库进行迁移，迁移后我会配置好权限和部署流程。你也可以加我的 Discord antfu#3212 进行沟通。

@QC-L 有空的时候麻烦你看一下能不能给这个仓库配置和主仓库的同步

感谢！

不好意思，最近年底公司的项目都在收尾，双休都被砍没了，后续将翻译以下内容

• api/expect - 6f987ea, 24d2789
• api/index - 5087ecf, a23c3fa, 1c22153, 1c22153
• api/mock - 45b37d6
• api/vi - e22bc20, c71e003, d603d39
• config/index - 800e13b

欠的貌似有点多了，不好意思😬

同步翻译任务认领说明

注意：

1. 一次尽量只认领一篇，给其他小伙伴留些机会~
2. 认领开始前，请务必阅读 翻译流程说明
3. 如果在翻译的时候发现有任何未同步的地方，及时指出，谢谢！

从 Todo List 中选取未被人领取过的文章：

未被领取过：

• install

领取过：

• install (@elonehoo)

领取过，已完成：

• install (@elonehoo) docs (cn) : api/toThrowErrorMatchingSnapshot translation #49

领取方式，在本 issues 下评论即可。

认领任务格式：

Section | Title | 译者 | 完成时间
-- | -- | -- | --
guide |  install | @elonehoo | 2022.05.06 - 2022.05.06

示例效果：

当完成时，请修改自己的认领评论，添加 PR 信息：

同步翻译的提醒事项

目前的 main 分支是之前的，跟官方文档产生了严重的脱节。

现在的 dev 分支是最新版的，并且后期会每天与官方文档进行同步。

请fork项目之后，将分支调整为 dev 的分支。

$ git checkout dev

将翻译完成的文档 PR 到dev分支。

任务认领列表

Todo List:

• guide

  • cli.md (@watonyweng) #2f6c3e4
  • comparisons.md (@amadeus711) - #98
  • coverage.md (@amadeus711) - #82
  • debugging.md (@amadeus711) - #85
  • extending-matchers.md (@justforuse) #81
  • features.md (@amadeus711) - #86
  • filtering.md (@amadeus711) - #90
  • ide.md (@watonyweng) #88
  • in-source.md (@watonyweng) #92
  • index.md (@watonyweng) #84
  • migration.md (@watonyweng) #89
  • mocking.md (@amadeus711) - #80
  • snapshot.md (@amadeus711) - #93
  • test-context.md (@amadeus711) - #96
  • ui.md (@amadeus711) - #79
  • using-plugins.md (@watonyweng) #95
  • why.md (@elonehoo) #78

• config

  • index.md (@watonyweng) #103

• api

  • index.md (@watonyweng) #101

在 2024年2月7日 至 2024年2月18日 进行全部的翻译校对工作，根据目前的 #391 。

• advanced/api
• advanced/metadata
• advanced/pool
• advanced/reporters
• advanced/runner
• api/assert-type
• api/expect-typeof
• api/expect
• api/index
• api/mock
• api/vi
• config/index
• guide/browser
• guide/cli
• guide/common-errors
• guide/comparisons
• guide/coverage
• guide/debugging
• guide/environment
• guide/extending-matchers
• guide/features
• guide/filtering
• guide/ide
• guide/improving-performance
• guide/in-source
• guide/index
• guide/migration
• guide/mocking
• guide/reporters
• guide/snapshot
• guide/test-context
• guide/testing-types
• guide/ui
• guide/using-plugins
• guide/why
• guide/workspace

翻译任务认领说明

注意：

1. 一次尽量只认领一篇，给其他小伙伴留些机会~
2. 认领开始前，请务必阅读 翻译流程说明
3. 如果在翻译的时候发现有任何未同步的地方，及时指出，谢谢！

从 Todo List 中选取未被人领取过的文章：

未被领取过：

• install

领取过：

• install (@elonehoo)

领取过，已完成：

• install (@elonehoo) docs (cn) : api/toThrowErrorMatchingSnapshot translation #49

领取方式，在本 issues 下评论即可。

认领任务格式：

Section | Title | 译者 | 完成时间
-- | -- | -- | --
guide |  install | @elonehoo | 2022.05.06 - 2022.05.06

示例效果：

当完成时，请修改自己的认领评论，添加 PR 信息：

任务认领列表

Todo List:

• api
  • toThrowErrorMatchingSnapshot (@elonehoo) docs (cn) : api/toThrowErrorMatchingSnapshot translation #49
  • toThrowErrorMatchingInlineSnapshot (@murongg) docs(cn): api/toThrowErrorMatchingInlineSnapshot translation
  • toSatisfy (@murongg) docs(cn): api/toSatisfy translation #54
  • expect.addSnapshotSerializer (@murongg) docs(cn): api/expect.addSnapshotSerializer translation #55
  • expect.extend (@murongg) docs(cn): api/expect.extend translation #56
  • toMatchSnapshot (@murongg) docs(cn): api/toMatchSnapshot translation #57
  • toMatchInlineSnapshot (@murongg) docs(cn): api/toMatchInlineSnapshot translation #58
• config
  • allowOnly (@murongg) docs(cn): config/allowOnly translation #59
  • passWithNoTests (@murongg) docs(cn): config/passWithNoTests translation #60
• guide
  • extending-matchers.md (@amadeus711) docs(guide): translate extending matchers #63
  • snapshot-serializer.md (@murongg) docs(cn): guide/snapshot-serializer.md translation #61
  • 「migration.md/Vue Snapshots」(@watonyweng) docs(cn): translate Vue Snapshots in guide/migration.md #62

Vitest 翻译须知

👏欢迎参与 Vitest 的文档协作工作中，以下内容仅仅只适用于参与 vitest-dev/docs-cn 仓库的协作，在此之前，劳烦阅读完以下全文。

协作指南

准备参与

• 安装 Git
• 安装 Node.js 和 pnpm 。
• 编辑、开发工具 (建议 VSCode)

开发

$ git clone [email protected]:vitest-dev/docs-cn.git
$ cd docs-cn
$ pnpm install
$ pnpm run dev

在完成翻译后，发起 PR 即可，在文档翻译长期维护的开发者确认无误后，将合并入主仓库，访问域名：cn.vitest.dev 。

commit message 规范

建议 message 使用英文，关键词后加英文冒号，再加空格，一段话描述，如：

• style: fix the strong style for Chinese characters
• chore: update yarn.lock
• review: introduction

Pull Request 标题规范

具体参考旧 Pull Request 建议标题使用英文，可以在描述里使用中文描述详细的特性。

参与贡献

翻译和校对

集中翻译和校对

目前网站即将处于待校对的状态，细则详见：#393

定期翻译和校对从英文站同步过来的新内容

英文文档的所在 请点击此链接，我们会每天拉取英文版文档内容的更新到 sync-docs 分支，并由印记中文 bot 自动发起 Pull Request ，解决 Git 冲突并翻译内容。

除了翻译和校对

• 定期从英文版同步：包括最新的翻译和非文档内容的代码同步，可以随时发起 PR
• 网络环境和本地化：如果发现任何这方面的问题可以直接发起 issue 讨论
• 翻译讨论：可以随时发起 issue 讨论

注意事项

• 尽量保持原文的编码风格，不产生不必要的格式变化和改动。如果对格式有异议，建议直接在英文站讨论。
• 同步最新的翻译时，建议先查阅是否有印记中文 bot 所产生的 Pull Request。

常见问题

1. 发现有些段落翻译晦涩难懂？
   在搜索未得到相关讨论结果后，可发起 issue，有结论后，我们定期汇总至该 issue

2. 如果有一个章节很长，我只翻译了一半，后续不想翻译了？

   虽然允许，但，我个人还是希望，最好以一个 .md 文件为单位来发起 PR，避免后续来回追踪。

翻译须知

术语翻译约定

中文术语约定

Alert 术语约定

如何增加 术语翻译阅读 的内容

开启一个新的 issue 与大家一起讨论，在有了结果之后，会将结果同步到该 issue 中。

ps. 文档翻译长期维护的开发者「排名不分先后」

• thinkasany
• Wáng Wěi Tāo
• Elone Hoo

I wish vitest-cn add search feature just like vite-cn

翻译流程

整个翻译流程分为以下几个阶段：

• 认领阶段
• 翻译阶段
• 校对阶段

认领阶段

如未认领文档就直接翻译，容易出现撞车的情况。

因此，在翻译前务必进行任务认领。

认领任务，请到 Github Issues 选择想翻译的文档。翻译任务认领说明

选定要翻译的文档后，即可开始翻译。

翻译阶段

fork 并 clone

先将 vitest-dev/docs-cn 的文档仓库 fork 为个人仓库（有增删改的权限）。

将 fork 后的仓库 download 至本地，如：

git clone https://github.com/<YOUR-GITHUB-NAME>/docs-cn/

翻译

在 clone 好的文档中找到你所认领的文章，即可开始翻译。

翻译完成后，请 push 至个人仓库。

git add
git commit -m 'docs(cn): 翻译的哪篇文章'
git push -u origin <翻译分支>

再创建 Pull Request 至 vitest-dev/docs-cn 仓库。

注意：在创建 Pull Request 时，请尽量勾选允许其他人进行修改，便于快速修改及合并。

至此翻译阶段就结束了。

校对阶段

翻译完成请评论 @校对者

• @elonehoo
• @QC-L
• @antfu

校对中，如有疑问或翻译错误，校对者会给出建议。

Github 的 PR 的评论提供了 suggestion 的功能，校对者对某行给出校对建议后，如无异议，可以直接进行合并。

而如果改动点较多，需进行本地修改时，则在本地对对应的内容进行修改，并提交到个人仓库的翻译分支即可。

注意: 无需关闭 Pull Request，Pull Reuquest 会自动追踪你的修改。

完成

校对完成后，校对者会对 PR 进行 Approve 操作，并进行 Pull Request 的合并。

当你的 Pull Request 被合并后，则代表流程结束。

其他

如需再次翻译，或同时翻译多篇。

• 一次 pr 尽量只有一篇文章的翻译，便于回溯

• 保证个人仓库的 main 分支始终为最新

• 每次翻译新文章时，请基于 main 分支拉取新分支

更新个人仓库的分支

git remote add upstream https://github.com/vitest-dev/docs-cn.git
git fetch upstream
git checkout main
git merge upstream/main

文档同步后有一处还没翻译的地方，我有机会贡献一波吗
@elonehoo

好像因为这边没做处理，所以后续的pr还是携带了那几个冲突。

这四个的 Github 链接跳转 404 ，以及其在线试用地址点进去报错

英文文档中貌似已做更改，但是 jest-dom 的链接和示例移除了。

@antfu 有些同学也想来维护该文档！

起因：最近我工作了，还没有完全从学校生活适应到工作生活，所以文档一直拖沓了。

结果：有部分同学也想跟我一起维护。

想加入的同学：

• @watonyweng Wang Weitao

现在默认的和活跃的分支是 dev，或许可以修改下 Wike

建议用 issue 列一个 tasks，将要翻译的内容拆分成小块，供想翻译的同学认领，同时也防止任务冲突

位于 vi-domock)

在代码中发现该问题已经修复，但线上环境并没有正确显示

浏览过程中刷新页面会导致文档内容为空，直接通过 URL 访问文档页面也会触发，英文站点无此问题

刷新页面的演示：

英文站点表现正常：

直接通过 URL 打开的演示：

使用的浏览器是 Chrome 109.0.5414.75，在新版 Edge 和 Android 上的 Via 浏览器上也能 100% 复现，所有 Chromium 系浏览器可能都可以复现

个人一点不成熟的猜测：可能是 workbox 的缓存导致