From 07016c982fd0435955a9700fa41823affe7929a5 Mon Sep 17 00:00:00 2001 From: luotao Date: Fri, 23 Aug 2019 00:06:08 +0800 Subject: [PATCH 1/8] Update badges --- zh_CN/readme.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/zh_CN/readme.md b/zh_CN/readme.md index d4fa7138..f6c6585e 100644 --- a/zh_CN/readme.md +++ b/zh_CN/readme.md @@ -6,9 +6,8 @@ ___ # ![AVA](https://github.com/avajs/ava/blob/master/media/header.png) -> 未来的测试运行器 - -[![Build Status: Linux](https://travis-ci.org/avajs/ava.svg?branch=master)](https://travis-ci.org/avajs/ava) [![Build status: Windows](https://ci.appveyor.com/api/projects/status/igogxrcmhhm085co/branch/master?svg=true)](https://ci.appveyor.com/project/avajs/ava/branch/master) [![Coverage Status](https://coveralls.io/repos/avajs/ava/badge.svg?branch=master&service=github)](https://coveralls.io/github/avajs/ava?branch=master) [![Gitter](https://img.shields.io/badge/Gitter-Join_the_AVA_chat_%E2%86%92-00d06f.svg)](https://gitter.im/avajs/ava) +[![Build Status](https://travis-ci.org/avajs/ava.svg?branch=master)](https://travis-ci.org/avajs/ava) [![Coverage Status](https://codecov.io/gh/avajs/ava/branch/master/graph/badge.svg)](https://codecov.io/gh/avajs/ava/branch/master) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo) [![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/ava) +[![Mentioned in Awesome Node.js](https://awesome.re/mentioned-badge.svg)](https://github.com/sindresorhus/awesome-nodejs) 虽然 JavaScript 是单线程，但在 Node.js 里由于其异步的特性使得 IO 可以并行。AVA 利用这个优点让你的测试可以并发执行，这对于 IO 繁重的测试特别有用。另外，测试文件可以在不同的进程里并行运行，让每一个测试文件可以获得更好的性能和独立的环境。在 Pageres 项目中从 Mocha [切换](https://github.com/sindresorhus/pageres/commit/663be15acb3dd2eb0f71b1956ef28c2cd3fdeed0) 到 AVA 让测试时间从 31 秒下降到 11 秒。测试并发执行强制你写原子测试，意味着测试不需要依赖全局状态或者其他测试的状态，这是一件非常好的事情。 From b2e07b0372c82f45dcaf7c51361b6cfac4328078 Mon Sep 17 00:00:00 2001 From: luotao Date: Fri, 23 Aug 2019 00:16:17 +0800 Subject: [PATCH 2/8] Update zh_CN readme --- zh_CN/readme.md | 30 ++++++++---------------------- 1 file changed, 8 insertions(+), 22 deletions(-) diff --git a/zh_CN/readme.md b/zh_CN/readme.md index f6c6585e..3b2ef603 100644 --- a/zh_CN/readme.md +++ b/zh_CN/readme.md @@ -45,28 +45,14 @@ ___ - 强制编写原子测试 - 没有隐藏的全局变量 - 包含 TypeScript 和 Flow 的类型定义 -- [Magic assert](#magic-assert) -- [为每个测试文件隔离环境](#隔离进程) -- [用 ES2017 编写测试](#支持-es2017) -- [支持 Promise](#支持-promise) -- [支持 Generator](#支持-generator) -- [支持 Async](#支持-async) -- [支持 Observable](#支持-observable) -- [强化断言信息](#强化断言信息) -- [可选的 TAP 输出显示](#TAP 报告器) -- [简明的堆栈跟踪](#简明的堆栈跟踪) - - -## 测试语法 - -```js -import test from 'ava'; - -test(t => { - t.deepEqual([1, 2], [1, 2]); -}); -``` - +- Magic assert +- 为每个测试文件隔离环境 +- 用 ES2017 编写测试 +- 支持 Promise +- 支持 Generator +- 支持 Async +- 强化断言信息 +- 可选的 TAP 输出显示 ## 用法 From b9433616938ce41af7c61e4082a516c60d4306ed Mon Sep 17 00:00:00 2001 From: luotao Date: Fri, 23 Aug 2019 00:28:18 +0800 Subject: [PATCH 3/8] Update zh_CN from latest english readme.md --- zh_CN/readme.md | 1092 +++++++---------------------------------------- 1 file changed, 144 insertions(+), 948 deletions(-) diff --git a/zh_CN/readme.md b/zh_CN/readme.md index 3b2ef603..5c7f2a77 100644 --- a/zh_CN/readme.md +++ b/zh_CN/readme.md @@ -4,1059 +4,255 @@ ___ 这是 [readme.md](https://github.com/avajs/ava/blob/master/readme.md) 的简体中文翻译。这个[链接](https://github.com/avajs/ava/compare/67bf0472133041f59ef469f737b696de05ae316b...master#diff-0730bb7c2e8f9ea2438b52e419dd86c9) 用来查看本翻译与 AVA 的 master 分支是否有差别（如果你没有看到 `readme.md` 发生变化，那就意味着这份翻译文档是最新的）。 ___ -# ![AVA](https://github.com/avajs/ava/blob/master/media/header.png) +___ +**备注** -[![Build Status](https://travis-ci.org/avajs/ava.svg?branch=master)](https://travis-ci.org/avajs/ava) [![Coverage Status](https://codecov.io/gh/avajs/ava/branch/master/graph/badge.svg)](https://codecov.io/gh/avajs/ava/branch/master) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo) [![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/ava) -[![Mentioned in Awesome Node.js](https://awesome.re/mentioned-badge.svg)](https://github.com/sindresorhus/awesome-nodejs) +这是 [readme.md](https://github.com/avajs/ava/blob/master/readme.md) 的简体中文翻译。这个[链接](https://github.com/avajs/ava/compare/67bf0472133041f59ef469f737b696de05ae316b...master#diff-0730bb7c2e8f9ea2438b52e419dd86c9) 用来查看本翻译与 AVA 的 master 分支是否有差别（如果你没有看到 `readme.md` 发生变化，那就意味着这份翻译文档是最新的）。 +___ -虽然 JavaScript 是单线程，但在 Node.js 里由于其异步的特性使得 IO 可以并行。AVA 利用这个优点让你的测试可以并发执行，这对于 IO 繁重的测试特别有用。另外，测试文件可以在不同的进程里并行运行，让每一个测试文件可以获得更好的性能和独立的环境。在 Pageres 项目中从 Mocha [切换](https://github.com/sindresorhus/pageres/commit/663be15acb3dd2eb0f71b1956ef28c2cd3fdeed0) 到 AVA 让测试时间从 31 秒下降到 11 秒。测试并发执行强制你写原子测试，意味着测试不需要依赖全局状态或者其他测试的状态，这是一件非常好的事情。 +# AVA logo -*如果你想贡献（问题、PRs 等），请先阅读我们的[贡献向导](contributing.md)。* +[![Build Status](https://travis-ci.org/avajs/ava.svg?branch=master)](https://travis-ci.org/avajs/ava) [![Coverage Status](https://codecov.io/gh/avajs/ava/branch/master/graph/badge.svg)](https://codecov.io/gh/avajs/ava/branch/master) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo) [![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/ava) +[![Mentioned in Awesome Node.js](https://awesome.re/mentioned-badge.svg)](https://github.com/sindresorhus/awesome-nodejs) -关注 [AVA 的 Twitter 账号](https://twitter.com/ava__js) 以获取最新信息。 +Testing can be a drag. AVA helps you get it done. AVA is a test runner for Node.js with a concise API, detailed error output, embrace of new language features and process isolation that let you write tests more effectively. So you can ship more awesome code. 🚀 -翻译：[Español](https://github.com/avajs/ava-docs/blob/master/es_ES/readme.md), [Français](https://github.com/avajs/ava-docs/blob/master/fr_FR/readme.md), [Italiano](https://github.com/avajs/ava-docs/blob/master/it_IT/readme.md), [日本語](https://github.com/avajs/ava-docs/blob/master/ja_JP/readme.md), [Português](https://github.com/avajs/ava-docs/blob/master/pt_BR/readme.md), [简体中文](https://github.com/avajs/ava-docs/blob/master/zh_CN/readme.md) +Follow the [AVA Twitter account](https://twitter.com/ava__js) for updates. -## 目录 +Read our [contributing guide](contributing.md) if you're looking to contribute (issues / PRs / etc). -- [用法](#用法) -- [CLI 用法](#cli) -- [调试](#调试) -- [报告器](#报告器) -- [配置](#配置) -- [文档](#文档) -- [API](#api) -- [断言](#断言) -- [测试快照](#测试快照) -- [小贴士](#小贴士) -- [FAQ](#faq) -- [秘方](#秘方) -- [支持](#支持) -- [相关](#相关) -- [链接](#链接) -- [团队](#团队) +![](media/mini-reporter.gif) -## 为什么要用 AVA? +Translations: [Español](https://github.com/avajs/ava-docs/blob/master/es_ES/readme.md), [Français](https://github.com/avajs/ava-docs/blob/master/fr_FR/readme.md), [Italiano](https://github.com/avajs/ava-docs/blob/master/it_IT/readme.md), [日本語](https://github.com/avajs/ava-docs/blob/master/ja_JP/readme.md), [한국어](https://github.com/avajs/ava-docs/blob/master/ko_KR/readme.md), [Português](https://github.com/avajs/ava-docs/blob/master/pt_BR/readme.md), [Русский](https://github.com/avajs/ava-docs/blob/master/ru_RU/readme.md), [简体中文](https://github.com/avajs/ava-docs/blob/master/zh_CN/readme.md) -- 轻量和高效 -- 简单的测试语法 -- 并发运行测试 -- 强制编写原子测试 -- 没有隐藏的全局变量 -- 包含 TypeScript 和 Flow 的类型定义 -- Magic assert -- 为每个测试文件隔离环境 -- 用 ES2017 编写测试 -- 支持 Promise -- 支持 Generator -- 支持 Async -- 强化断言信息 -- 可选的 TAP 输出显示 -## 用法 +## Why AVA? -### 在项目中添加 AVA +- Minimal and fast +- Simple test syntax +- Runs tests concurrently +- Enforces writing atomic tests +- No implicit globals +- Includes TypeScript definitions +- [Magic assert](#magic-assert) +- [Isolated environment for each test file](./docs/01-writing-tests.md#process-isolation) +- [Write your tests using the latest JavaScript syntax](#latest-javascript-support) +- [Promise support](./docs/01-writing-tests.md#promise-support) +- [Async function support](./docs/01-writing-tests.md#async-function-support) +- [Observable support](./docs/01-writing-tests.md#observable-support) +- [Enhanced assertion messages](./docs/03-assertions.md#enhanced-assertion-messages) +- [Automatic parallel test runs in CI](#parallel-runs-in-ci) +- [TAP reporter](./docs/05-command-line.md#tap-reporter) -通过带 `--init` 参数运行 AVA 全局安装命令，将会添加 AVA 到 `package.json`： -```console -$ npm install --global ava -$ ava --init -``` +## Usage -如果你偏好 Yarn 的话： +To install and set up AVA, run: ```console -$ yarn global add ava -$ ava --init +npm init ava ``` -你的 `package.json` 会看起来像这样： +Your `package.json` will then look like this (exact version notwithstanding): ```json { - "name": "awesome-package", - "scripts": { - "test": "ava" - }, - "devDependencies": { - "ava": "^0.20.0" - } + "name": "awesome-package", + "scripts": { + "test": "ava" + }, + "devDependencies": { + "ava": "^1.0.0" + } } ``` -写在 `--init` 后面的任何参数都会被添加到 `package.json`。 - -#### 手动安装 - -你也可以直接安装 AVA： +Or if you prefer using Yarn: ```console -$ npm install --save-dev ava +yarn add ava --dev ``` -或者使用 Yarn ： +Alternatively you can install `ava` manually: ```console -$ yarn add --dev ava +npm install --save-dev ava ``` -你还需要在你的 `package.json` 中配置 `test` 脚本来使用 `ava`（参照前面）。 +Don't forget to configure the `test` script in your `package.json` as per above. -### 创建你的测试文件 +### Create your test file -在你的工程根目录下创建一个名字为 `test.js` 的文件： +Create a file named `test.js` in the project root directory: ```js import test from 'ava'; test('foo', t => { - t.pass(); + t.pass(); }); test('bar', async t => { - const bar = Promise.resolve('bar'); - - t.is(await bar, 'bar'); + const bar = Promise.resolve('bar'); + t.is(await bar, 'bar'); }); ``` -### 运行 +### Running your tests ```console -$ npm test +npm test ``` -### 观察 +Or with `npx`: ```console -$ npm test -- --watch +npx ava ``` -AVA 拥有非常智能的观察模式。[可以在它的秘方中查看详情](docs/recipes/watch-mode.md)。 - -## CLI +Run with the `--watch` flag to enable AVA's [watch mode](docs/recipes/watch-mode.md): ```console -$ ava --help - - Usage - ava [ ...] - - Options - --init Add AVA to your project - --fail-fast Stop after first test failure - --serial, -s Run tests serially - --tap, -t Generate TAP output - --verbose, -v Enable verbose output - --no-cache Disable the transpiler cache - --no-power-assert Disable Power Assert - --color Force color output - --no-color Disable color output - --match, -m Only run tests with matching title (Can be repeated) - --watch, -w Re-run tests when tests and source files change - --timeout, -T Set global timeout - --concurrency, -c Max number of test files running at the same time (Default: CPU cores) - --update-snapshots, -u Update snapshots - - Examples - ava - ava test.js test2.js - ava test-*.js - ava test - ava --init - ava --init foo.js - - Default patterns when no arguments: - test.js test-*.js test/**/*.js **/__tests__/**/*.js **/*.test.js +npx ava --watch ``` -*注意：在本地和全局都安装了 AVA 的情况下，本地安装的将会被优先使用。* - -文件夹会被递归遍历，所有 `*.js` 文件都会被作为测试文件。名字为 `fixtures`，`helpers` 和 `node_modules` 的文件夹*总会*被忽略。所以把 helper 名字以 `_` 开头命名就可以一起放置在测试文件的目录下。 - -当使用 `npm test` 时你可以直接传参数 `npm test test2.js`，但标志需要像这样传递 `npm test -- --verbose`。 - - -## 调试 - -AVA 在子进程中运行测试，因此为了调试测试，需要用如下方法： - -``` -$ node --inspect node_modules/ava/profile.js some/test/file.js -``` - -### 特定调试器的技巧 - - -- [Chrome DevTools](docs/recipes/debugging-with-chrome-devtools.md) -- [WebStorm](docs/recipes/debugging-with-webstorm.md) -- [Visual Studio Code](docs/recipes/debugging-with-vscode.md) - -## 报告器 +## Supported Node.js versions -### 迷你报告器 +AVA supports the latest release of any major version that [is supported by Node.js itself](https://github.com/nodejs/Release#release-schedule). Read more in our [support statement](docs/support-statement.md). -这是默认的报告器。 - - - -### 详细报告器 - -使用 `--verbose` 参数可以启用详细报告器。这在 CI 环境下始终会被启用，除非已经使用了 [TAP 报告器](#TAP 报告器) - - - -### TAP 报告器 - -AVA 支持 TAP格式，并且与 [任何 TAP 报告器](https://github.com/sindresorhus/awesome-tap#reporters) 相兼容。使用 `--tap` 选项来启用 TAP 输出。 - -```console -$ ava --tap | tap-nyan -``` - - - -注意 TAP 报告器在 [监视模式](docs/recipes/watch-mode.md) 下不可用。 +## Highlights ### Magic assert -AVA 加入了代码摘录和干净的 diff 到实际和期望的值。如果断言中的值是 object 或者 array，那么只有 diff 会显示出来，去掉了干扰让人专注问题。同时 diff 是带语法高亮的！如果你正在比较两个 string ，不管是单行还是多行的，AVA 都使用另一种 diff 显示，来高亮出新增和删除的字符。 - -### 干净的调用栈显示 - -AVA 会自动去掉调用栈中不相关的行，让你能够更快地定位错误的根源。 - -## 配置 - -所有的 CLI 选项都可以配置在 `package.json` 的 `ava` 属性中。你可以修改 `ava` 命令的默认行为，所以你不需要重复在命令行中输入相同的选项。 - -```json -{ - "ava": { - "files": [ - "my-test-folder/*.js", - "!**/not-this-file.js" - ], - "source": [ - "**/*.{js,jsx}", - "!dist/**/*" - ], - "match": [ - "*oo", - "!foo" - ], - "failFast": true, - "tap": true, - "require": [ - "babel-register" - ], - "babel": "inherit" - } -} -``` - -传递给 CLI 的参数总是比 `package.json` 中的配置优先级高。 - -请看 [支持 ES2015](#支持-es2015) 章节以了解 `babel` 选项的更多详情。 - -## 文档 - -测试是并发执行的，你可以选择同步或异步执行测试，在返回一个 promise 或 [observable](https://github.com/zenparsing/zen-observable) 时你才需要考虑使用同步。 - -我们*强烈*推荐使用 [async 函数](#支持-async)，它让异步代码简洁更具可读性，并且它隐式返回一个 promise 让你无需手动创建。 - -如果你不能使用 promise 或者 observales，你可以通过这样定义你的测试 `test.cb([title], fn)` 来启用 “callback 模式”。通过这种方式声明的测试*必须*手动添加 `t.end()` 来结束，这种模式的主要目的是为了测试 callback 方式的 API。 - -你必须同时将所有测试都定义为同步，它们不能定义在 `setTimeout`，`setImmediate` 等里面。 - -测试文件在当前文件夹中被执行，所以 [`process.cwd()`](https://nodejs.org/api/process.html#process_process_cwd) 和 [`__dirname`](https://nodejs.org/api/globals.html#globals_dirname) 总是相同。你可以使用相对路径代替 `path.join(__dirname, 'relative/path')` 操作。 - -### 创建测试 - -你可以通过调用 AVA 中导入的 `test` 方法来创建一个测试。提供可选的标题和 callback 函数，函数将在你运行测试时被调用。它会传递一个 [执行对象](#t) 作为其第一个且唯一的一个参数。按照惯例这个参数名字为 `t`。 - -```js -import test from 'ava'; - -test('my passing test', t => { - t.pass(); -}); -``` - -#### 标题 - -标题是可选的，意味着你可以这样： - -```js -test(t => { - t.pass(); -}); -``` - -如果你有多个测试的话建议写上测试标题。 - -如果你没有提供测试标题，但 callback 是一个有名字的函数，那这个名字将作为测试标题： - -```js -test(function name(t) { - t.pass(); -}); -``` - -### 断言计划 - -断言计划确保测试只能通过指定次数的断言，它们可以帮你捕捉测试太早退出的情况，如果太多断言被执行的话它们也会让测试失败，如果在你的 callback 或循环中有断言的话断言计划会比较有用。 - -请注意：不像 [`tap`](https://www.npmjs.com/package/tap) 和 [`tape`](https://www.npmjs.com/package/tape)，当断言计划数达到了指定数量 AVA 并*不*会自动结束。 - -这些例子将会通过测试： - -```js -test(t => { - t.plan(1); - - return Promise.resolve(3).then(n => { - t.is(n, 3); - }); -}); - -test.cb(t => { - t.plan(1); - - someAsyncFunction(() => { - t.pass(); - t.end(); - }); -}); -``` - -这些则不会： - -```js -test(t => { - t.plan(2); - - for (let i = 0; i < 3; i++) { - t.true(i < 3); - } -}); // 失败，3 个断言被执行，但计划只有 2 个 - -test(t => { - t.plan(1); - - someAsyncFunction(() => { - t.pass(); - }); -}); // 失败，在断言执行之前测试会因为同步而提前结束。 -``` - -### 串行运行测试 - -测试默认是并发运行的，这很棒。但有时你必须写不是并发运行的测试。 - -这种情况比较少见，但你可以使用 `.serial` 修饰符，它将强制让那些测试在并发的测试前*先*串行运行。 - -```js -test.serial(t => { - t.pass(); -}); -``` - -注意这只影响一个特定测试文件里面的测试，AVA 将仍然同时运行多个测试文件，除非你传递 [`--serial` CLI 标志](#cli)。 - -### 运行指定的测试 - -在开发中只运行少量指定的测试非常有用，这可以通过使用 `.only` 修饰符来完成。 - -```js -test('will not be run', t => { - t.fail(); -}); - -test.only('will be run', t => { - t.pass(); -}); -``` - -`.only` 影响所有测试文件，所以你在一个文件里面使用了它，那其他测试文件里的测试将不会运行。 - -### 运行匹配标题的测试 - -`--match` 标志允许你只运行包含匹配标题的测试，这可以通过简单的通配模式来做到，模式是大小写敏感的，详情请看 [`matcher`](https://github.com/sindresorhus/matcher)。 - -匹配以 `foo` 结尾的标题： - -```console -$ ava --match='*foo' -``` - -匹配以 `foo` 开头的标题： - -```console -$ ava --match='foo*' -``` - -匹配包含了 `foo` 的标题： - -```console -$ ava --match='*foo*' -``` - -匹配*精确*等于 `foo` 的标题（尽管大小写敏感）： - -```console -$ ava --match='foo' -``` - -匹配不包含了 `foo` 的标题： - -```console -$ ava --match='!*foo*' -``` - -匹配以 `foo` 开头并且以 `bar` 结束的标题： - -```console -$ ava --match='foo*bar' -``` - -匹配以 `foo` 开头或者以 `bar` 结束的标题： - -```console -$ ava --match='foo*' --match='*bar' -``` - -注意，匹配模式优先级高于 `.only` 修饰符，只有带明确标题的测试可以被匹配，当使用 `--match` 时，没有标题的或者标题是从 callback 函数名来的测试都会被跳过。 - -下面是当使用一个匹配模式 `*oo*` 来匹配测试的结果： - -```js -test('foo will run', t => { - t.pass(); -}); - -test('moo will also run', t => { - t.pass(); -}); - -test.only('boo will run but not exclusively', t => { - t.pass(); -}); - -// 不会运行，没有标题 -test(function (t) { - t.fail(); -}); - -// 不会运行，没有明确定义的标题 -test(function foo(t) { - t.fail(); -}); -``` - -### 跳过测试 - -有时候失败的测试一时难以修复，你可以使用 `.skip` 来告诉 AVA 跳过这些测试。它们仍然会显示在输出结果中（标识为 skipped），但不会被运行。 - -```js -test.skip('will not be run', t => { - t.fail(); -}); -``` - -你必须指定 callback 函数。 - -### 测试占位符 ("todo") - -当你计划写一个测试的时候你可以使用 `.todo` 修饰符，像跳过测试一样这些占位符也会显示在输出结果中，它们只要求一个标题，你不能指定 callback 函数。 - -```js -test.todo('will think about writing this later'); -``` - -### Before & after 钩子 - -AVA 让你可以注册在测试之前和之后跑的钩子，这允许你执行 setup 和 teardow 代码。 - -`test.before()` 在你的测试文件中注册了一个钩子并在第一个测试前运行，同样地，`test.after()` 注册了一个钩子在最后一个测试后运行。 - -`test.beforeEach()` 在你的测试文件中注册了一个钩子并在每个测试前运行，同样地，`test.afterEach()` 注册了一个钩子在每个测试后运行。 - -像 `test()` 这些方法一样接收一个可选的标题和一个 callback 函数，如果你的钩子失败了标题就会显示出来，callback 函数传递一个 [执行对象](#t)。 - -`before` 在 `beforeEach` 之前执行，`afterEach` 在 `after` 之前执行，同一类的钩子按照它们定义的顺序来执行。 - -```js -test.before(t => { - // 这个会在所有测试前运行 -}); - -test.before(t => { - // 这个会在上面的方法后面运行，但在测试之前运行 -}); - -test.after('cleanup', t => { - // 这个会在所有测试之后运行 -}); - -test.beforeEach(t => { - // 这个会在每个测试之前运行 -}); - -test.afterEach(t => { - // 这个会在每个测试之后运行 -}); - -test(t => { - // 正常的测试 -}); -``` - -钩子可以同步或异步，就像测试一样。让钩子异步返回一个 promise 或 observable，使用一个 async 函数，或者通过 `test.cb.before()`，`test.cb.beforeEach()` 等来启用 callback 模式。 - -```js -test.before(async t => { - await promiseFn(); -}); - -test.after(t => { - return new Promise(/* ... */); -}); - -test.cb.beforeEach(t => { - setTimeout(t.end); -}); - -test.afterEach.cb(t => { - setTimeout(t.end); -}); -``` - -请记住，`beforeEach` 和 `afterEach` 钩子在一个测试之前和之后运行，并且默认情况下测试是并发运行的，如果你需要为每个测试设置一个全局的状态（比如 `console.log` 的 spying [例子](https://github.com/avajs/ava/issues/560)），你需要确保这些测试是[串行运行](#串行运行测试)的。 - -记住，AVA 运行每个测试文件会有各自单独的进程，你可能不需要在 `after` 钩子中清理全局状态，因为它只会在进程退出前被调用。 - -`beforeEach` 和 `afterEach` 钩子可以共享测试的上下文： - -```js -test.beforeEach(t => { - t.context.data = generateUniqueData(); -}); - -test(t => { - t.is(t.context.data + 'bar', 'foobar'); -}); -``` - -默认情况下 `t.context` 是一个对象，但你可以重新赋值： - -```js -test.beforeEach(t => { - t.context = 'unicorn'; -}); - -test(t => { - t.is(t.context, 'unicorn'); -}); -``` - -上下文共享在 `before` 和 `after` 钩子中*不*可用。 - -### 连接测试修饰符 - -你可以以任何顺序使用 `.serial`，`.only` 和 `.skip`，与 `test`，`before`，`after`，`beforeEach` 和`afterEach` 一起，比如： - -```js -test.before.skip(...); -test.skip.after(...); -test.serial.only(...); -test.only.serial(...); -``` - -这意味着你可以在每个测试或钩子的末尾临时添加 `.skip` 或 `.only`，而不用做其他的修改。 - -### 测试宏 - -给到测试定义的额外参数会被传给测试的实现，这个特性可被用于创建可重用的测试宏。 - -```js -function macro(t, input, expected) { - t.is(eval(input), expected); -} - -test('2 + 2 = 4', macro, '2 + 2', 4); -test('2 * 3 = 6', macro, '2 * 3', 6); -``` - -通过实现宏的 `title` 方法，能够动态的为测试添加标题： - -```js -function macro(t, input, expected) { - t.is(eval(input), expected); -} - -macro.title = (providedTitle, input, expected) => `${providedTitle} ${input} = ${expected}`.trim(); - -test(macro, '2 + 2', 4); -test(macro, '2 * 3', 6); -test('providedTitle', macro, '3 * 3', 9); -``` - -如果不设置标题，`providedTitle` 参数默认是空字符串。因此能够安全的进行字符串的连接操作，而不用担心在 `null` / `undefined` 上调用方法而导致报错。空字符串是假值，`if(providedTitle) {...}` 这样的条件判断是完全成立的。 - -还可以向宏方法传入数组： - -```js -const safeEval = require('safe-eval'); - -function evalMacro(t, input, expected) { - t.is(eval(input), expected); -} - -function safeEvalMacro(t, input, expected) { - t.is(safeEval(input), expected); -} - -test([evalMacro, safeEvalMacro], '2 + 2', 4); -test([evalMacro, safeEvalMacro], '2 * 3', 6); -``` - -我们鼓励用宏代替[此类](https://github.com/avajs/ava-codemods/blob/47073b5b58aa6f3fb24f98757be5d3f56218d160/test/ok-to-truthy.js#L7-L9)测试生成代码。宏的设计初衷是静态分析你的代码，因此有着更好的效率、IDE 集成以及校验规则。 - -### 自定义断言 - -你可以使用其他断言库来替代内置的断言库，当断言失败可以让其抛出异常。 - -但这样做的话你将得不到[内置断言库](#断言)的良好体验，同时你也将不会用到[断言计划](#断言计划） (『看#25](https://github.com/avajs/ava/issues/25))。 - -```js -import assert from 'assert'; - -test(t => { - assert(true); -}); -``` - -### 支持 ES2015 +AVA adds code excerpts and clean diffs for actual and expected values. If values in the assertion are objects or arrays, only a diff is displayed, to remove the noise and focus on the problem. The diff is syntax-highlighted too! If you are comparing strings, both single and multi line, AVA displays a different kind of output, highlighting the added or missing characters. -AVA 通过 [Babel 6](https://babeljs.io) 内置支持 ES2015，只需要用 ES2015 的方式写你测试，不需要额外的配置。你可以在你的工程中使用任何的 Babel 版本，我们使用我们捆绑的 Babel，带有 [`es2015`](https://babeljs.io/docs/plugins/preset-es2015/) 和 [`stage-2`](https://babeljs.io/docs/plugins/preset-stage-2/) 设置，和 [`espower`](https://github.com/power-assert-js/babel-plugin-espower) 和 [`transform-runtime`](https://babeljs.io/docs/plugins/transform-runtime/) 插件一样。 +![](media/magic-assert-combined.png) -类似的 Babel 配置同样适用于 AVA，如下： +### Clean stack traces -```json -{ - "presets": [ - "es2015", - "stage-2", - ], - "plugins": [ - "espower", - "transform-runtime" - ] -} -``` - -你可以自定义 AVA 如何通过 [`package.json` 配置](#配置) `babel` 选项来转换测试文件，例如你可以这样来覆盖配置： - -```json -{ - "ava": { - "babel": { - "presets": [ - "es2015", - "stage-0", - "react" - ] - } - } -} -``` - -你也可以使用特殊的 `"inherit"` 关键字，这让 AVA 遵从你的 [`.babelrc` 或 `package.json` 文件](https://babeljs.io/docs/usage/babelrc/) 中的 Babel 配置，这种方式让测试文件的转换方式和与源文件的相同，可以无需在 AVA 中重复配置。 - - ```json -{ - "babel": { - "presets": [ - "es2015", - "stage-0", - "react" - ] - }, - "ava": { - "babel": "inherit" - } -} -``` - -注意，AVA *总是*应用 [`espower`](https://github.com/power-assert-js/babel-plugin-espower) 和 [`transform-runtime`](https://babeljs.io/docs/plugins/transform-runtime/) 插件。 - -### 支持 TypeScript +AVA automatically removes unrelated lines in stack traces, allowing you to find the source of an error much faster, as seen above. -AVA 支持 TypeScript，你必须自己配置转换规则，当你在你的 `tsconfig.json` 文件中把 `module` 设为 `commonjs`，TypeScipt 将自动为 AVA 找到类型定义。你应该把 `target` 设置为 `es2015` 来使用 promises 和 async 函数。 +### Latest JavaScript support -### 转换导入模块 +AVA uses [Babel 7](https://babeljs.io) so you can use the latest JavaScript syntax in your tests. There is no extra setup required. You don't need to be using Babel in your own project for this to work either. -AVA 现在只转换需要运行的测试，*它不会转换那些在测试中你 `import` 的模块*，这可能不是你所期望的但这就是现在的工作方案。 +We aim to support all [finished syntax proposals](https://github.com/tc39/proposals/blob/master/finished-proposals.md), as well as all syntax from ratified JavaScript versions (e.g. ES2017). See our [`@ava/stage-4`](https://github.com/avajs/babel-preset-stage-4) preset for the currently supported proposals. -如果你使用 Babel 你可以使用它的 [require 钩子](https://babeljs.io/docs/usage/require/) 来实时转换导入模块，运行 AVA 带上 `--require babel-register` （请看 [CLI](#cli)) 参数或[在你的 `package.json` 里配置](#配置)。 +Please note that we do not add or modify built-ins. For example, if you use [`Object.fromEntries()`](https://github.com/tc39/proposal-object-from-entries) in your tests, they will crash in Node.js 10 which does not implement this method. -你也可以在另外一个进程里转换你的模块，并且参考你的转换文件而不是你的测试源码。 +You can disable this syntax support, or otherwise customize AVA's Babel pipeline. See our [Babel recipe] for more details. -### 支持 Promise +### Parallel runs in CI -如果你在测试里返回一个 promise，你不需要在测试里明确的结束测试，当 promise resolve 的时候它会自己结束。 +AVA automatically detects whether your CI environment supports parallel builds. Each build will run a subset of all test files, while still making sure all tests get executed. See the [`ci-parallel-vars`](https://www.npmjs.com/package/ci-parallel-vars) package for a list of supported CI environments. -```js -test(t => { - return somePromise().then(result => { - t.is(result, 'unicorn'); - }); -}); -``` - -### 支持 Generator - -AVA 自带对 [generator 函数](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Statements/function*) 的内置支持。 - -```js -test(function * (t) { - const value = yield generatorFn(); - t.true(value); -}); -``` +## Documentation -### 支持 Async - -AVA 自带对 [async functions](https://tc39.github.io/ecmascript-asyncawait/) *(async/await)* 的内置支持。 - -```js -test(async function (t) { - const value = await promiseFn(); - t.true(value); -}); - -// 异步箭头函数 -test(async t => { - const value = await promiseFn(); - t.true(value); -}); -``` - -### 支持 Observable - -AVA 自带对 [observables](https://github.com/zenparsing/es-observable) 的内置支持。如果你从测试中返回一个 observable，AVA 会自动消费它使其在测试结束前完成。 - -*你不需要使用 “callback 模式" 或者调用 `t.end()`。* - -```js -test(t => { - t.plan(3); - return Observable.of(1, 2, 3, 4, 5, 6) - .filter(n => { - // 只有奇数 - return n % 2 === 0; - }) - .map(() => t.pass()); -}); -``` - -### 支持 Callback - -当使用 node-style, error-first 等 callback API 时，AVA 支持使用 `t.end` 作为最后一个 callback 函数。AVA 将把任何为真的值传递给 `t.end` 其实变成一个 error。注意，`t.end` 要求 “callback 模式”，这个可以通过使用 `test.cb` 链来启用。 - -```js -test.cb(t => { - // t.end 自动检查第一个参数是否为错误 - fs.readFile('data.txt', t.end); -}); -``` - -### 可选的 TAP 输出 - -AVA 可以通过 `--tap` 选项来生成 TAP 的输出，可以选择任意的 [TAP 报告](https://github.com/sindresorhus/awesome-tap#reporters)。 - -```console -$ ava --tap | tap-nyan -``` +Please see the [files in the `docs` directory](./docs): - +* [Writing tests](./docs/01-writing-tests.md) +* [Execution context](./docs/02-execution-context.md) +* [Assertions](./docs/03-assertions.md) +* [Snapshot testing](./docs/04-snapshot-testing.md) +* [Command line (CLI)](./docs/05-command-line.md) +* [Configuration](./docs/06-configuration.md) +* [Test timeouts](./docs/07-test-timeouts.md) -### 简明的堆栈跟踪 +### Common pitfalls -AVA 会在堆栈跟踪信息里面自动移除不相关的行，让你更快地找到错误的原因。 +We have a growing list of [common pitfalls](docs/08-common-pitfalls.md) you may experience while using AVA. If you encounter any issues you think are common, comment in [this issue](https://github.com/avajs/ava/issues/404). - +### Recipes -## API - -### `test([title], implementation)` -### `test.serial([title], implementation)` -### `test.cb([title], implementation)` -### `test.only([title], implementation)` -### `test.skip([title], implementation)` -### `test.todo(title)` -### `test.failing([title], implementation)` -### `test.before([title], implementation)` -### `test.after([title], implementation)` -### `test.beforeEach([title], implementation)` -### `test.afterEach([title], implementation)` - -#### `title` - -类型：`string` - -测试标题 - -#### `callback(t)` - -类型：`function` - -应该包含实际的测试。 - -##### `t` - -类型：`object` - -特定测试的执行对象，每个测试的 callback 接收到一个不同的对象，包含[断言](#断言)，`.plan(count)` 和 `.end()` 等方法。`t.context` 可以包含 `beforeEach` 钩子中的共享状态。 - -###### `t.plan(count)` - -计划有多少断言将在测试中被执行，如果实际断言的数量没有匹配计划数，那么测试将失败，详情请见[断言计划](#断言计划)。 - -###### `t.end()` - -结束测试，只在 `test.cb()` 中有效。 - -## 断言 - -断言也被包含在 [执行对象](#t) 中，可以提供给每个测试 callback： - -```js -test(t => { - t.truthy('unicorn'); // 断言 -}); -``` - -如果单个测试中有多个断言同时失败了，那 AVA 只会显示*第一个*。 - -### `.pass([message])` - -测试通过。 - -### `.fail([message])` - -断言失败。 - -### `.truthy(value, [message])` - -断言 `value` 是否是真值。 - -### `.falsy(value, [message])` - -断言 `value` 是否是假值。 - -### `.true(value, [message])` - -断言 `value` 是否是 `true`。 - -### `.false(value, [message])` - -断言 `value` 是否是 `false`。 - -### `.is(value, expected, [message])` - -断言 `value` 是否和 `expected` 相等。 - -### `.not(value, expected, [message])` - -断言 `value` 是否和 `expected` 不等。 - -### `.deepEqual(value, expected, [message])` - -断言 `value` 是否和 `expected` 深度相等。 - -### `.notDeepEqual(value, expected, [message])` - -断言 `value` 是否和 `expected` 深度不等。 - -### `.throws(function|promise, [error, [message]])` - -断言 `function` 抛出一个异常，或者 `promise` reject 一个错误。 - -`error` 可以是一个构造器，正则，错误信息或者验证函数。 - -返回由 `function` 抛出的异常或 `promise` 的拒绝原因。 - -### `.notThrows(function|promise, [message])` - -断言 `function` 没有抛出一个异常，或者 `promise` resolve。 - -### `.regex(contents, regex, [message])` - -断言 `contents` 匹配 `regex`。 - -### `.notRegex(contents, regex, [message])` - -断言 `contents` 不匹配 `regex`。 - -### `.ifError(error, [message])` - -断言 `error` 是假值。 - -### 跳过断言 - -通过 `skip` 修饰符可以跳过任何断言，跳过的断言仍然会被计数，所以不需要去改变你的断言计划数量。 - -```js -test(t => { - t.plan(2); - t.skip.is(foo(), 5); // 当跳过时不需要改变你的计划数 - t.is(1, 1); -}); -``` - -### 强化断言信息 - -AVA 自带内置的 [`power-assert`](https://github.com/power-assert-js/power-assert)，给你更多的描述性断言信息，它阅读你的测试代码并从中试图推断出更多信息。 - -我们来举个例子，使用 Node 的标准 [`断言` 库](https://nodejs.org/api/assert.html)。 - -```js -const a = /foo/; -const b = 'bar'; -const c = 'baz'; -require('assert').ok(a.test(b) || b === c); -``` - -如果你把代码粘贴到 Node REPL 中会返回： - -``` -AssertionError: false == true -``` - -而在 AVA 中，这个测试： - -```js -test(t => { - const a = /foo/; - const b = 'bar'; - const c = 'baz'; - t.true(a.test(b) || b === c); -}); -``` - -将会输出： - -``` -t.true(a.test(b) || b === c) - | | | | - | "bar" "bar" "baz" - false -``` - -## 隔离进程 - -每个测试文件都会在一个独立的 Node 进程中运行，这样让你可以在一个测试文件中改变全局状态或将其覆盖一个内置的全局状态，而不会影响其他测试文件。这样更加有效地利用现代的多核处理器，让多个测试可以并发地执行。 - -## 小贴士 - -### 临时文件 - -并发运行测试面临着许多挑战，文件的 IO 操作就是其中一个。 - -一般来讲，串行测试在当前文件夹中创建临时文件夹，然后会在测试结束的时候清理它们。但这种做法在并发测试中不起作用，因为测试会一起操作这个文件夹而导致冲突。正确的做法是为每个测试创建一个新的临时文件夹，使用 [`tempfile`](https://github.com/sindresorhus/tempfile) 和 [`temp-write`](https://github.com/sindresorhus/temp-write) 模块可能会有帮助。 - -### 调试 - -AVA 默认情况下是并发执行测试，这样在调试信息时并不是最理想的，你可以通过设置 `--serial` 选项来让测试串行执行。 - -```console -$ ava --serial -``` - -### 代码覆盖率 - -你不能使用 [`istanbul`](https://github.com/gotwarlost/istanbul) 来做代码覆盖率因为 AVA [处理过这些测试文件](#隔离进程），你可以使用 [`nyc`](https://github.com/bcoe/nyc) 来代替，你可以把它看做是支持子进程的 `istanbul`。 - -从版本 `5.0.0` 开始，在报告覆盖率时为你的代码使用原生映射，而不是转换后的代码。确保你测试的代码包括了一个内联的原生映射或者引用了一个原生映射文件。如果你使用了 `babel-register`，你可以在你的 Babel 配置中将 `sourceMaps` 设置为 `inline`。 +- [Test setup](docs/recipes/test-setup.md) +- [Code coverage](docs/recipes/code-coverage.md) +- [Watch mode](docs/recipes/watch-mode.md) +- [Endpoint testing](docs/recipes/endpoint-testing.md) +- [When to use `t.plan()`](docs/recipes/when-to-use-plan.md) +- [Browser testing](docs/recipes/browser-testing.md) +- [TypeScript](docs/recipes/typescript.md) +- [Flow](docs/recipes/flow.md) +- [Configuring Babel][Babel recipe] +- [Using ES modules](docs/recipes/es-modules.md) +- [Passing arguments to your test files](docs/recipes/passing-arguments-to-your-test-files.md) +- [Testing React components](docs/recipes/react.md) +- [Testing Vue.js components](docs/recipes/vue.md) +- [JSPM and SystemJS](docs/recipes/jspm-systemjs.md) +- [Debugging tests with Chrome DevTools](docs/recipes/debugging-with-chrome-devtools.md) +- [Debugging tests with VSCode](docs/recipes/debugging-with-vscode.md) +- [Debugging tests with WebStorm](docs/recipes/debugging-with-webstorm.md) +- [Isolated MongoDB integration tests](docs/recipes/isolated-mongodb-integration-tests.md) +- [Testing web apps using Puppeteer](docs/recipes/puppeteer.md) ## FAQ -### 为什么不用 `mocha`，`tape`，`tap`？ - -Mocha 要求你使用隐式全局变量比如 `describe` 和 `it` 作为其默认接口（这是大部分人使用的）。这样做不是很好，并且串行执行测试没有进程隔离，使得测试十分缓慢。 - -Tape 和 tap 是非常好的。AVA 在它们的语法中得到大量启发，但它们也是串行执行测试，它们的默认 [TAP](https://testanything.org) 输出不是非常友好，因此你总是需要使用额外的 tap 报告。 +### Why not `mocha`, `tape`, `tap`? -与它们不同的是，AVA 可以并发执行测试，为每个测试文件提供独立进程，它的默认报告简单明了，并且 AVA 也支持通过 CLI 标志来输出一个 TAP 报告。 +Mocha requires you to use implicit globals like `describe` and `it` with the default interface (which most people use). It's not very opinionated and executes tests serially without process isolation, making it slow. -### 我如何使用自定义的报告？ +Tape and tap are pretty good. AVA is highly inspired by their syntax. They too execute tests serially. Their default [TAP](https://testanything.org) output isn't very user-friendly though so you always end up using an external tap reporter. -AVA 支持 TAP 格式，所以它兼容任何 [TAP 报告](https://github.com/sindresorhus/awesome-tap#reporters)，使用 [`--tap` 标志](#可选的-tap-输出)来启用 TAP 输出。 +In contrast AVA is highly opinionated and runs tests concurrently, with a separate process for each test file. Its default reporter is easy on the eyes and yet AVA still supports TAP output through a CLI flag. -### 项目名字要怎么写才是正确的？如何发音？ +### How is the name written and pronounced? -AVA，不是 Ava，也不是 ava，发音 [`/ˈeɪvə/` ay-və](https://github.com/avajs/ava/blob/master/media/pronunciation.m4a?raw=true)。 +AVA, not Ava or ava. Pronounced [`/ˈeɪvə/`](media/pronunciation.m4a?raw=true): Ay (f**a**ce, m**a**de) V (**v**ie, ha**v**e) A (comm**a**, **a**go) -### 项目背景图片是什么意思？ +### What is the header background? -它是[处女座星系](https://zh.wikipedia.org/wiki/%E4%BB%99%E5%A5%B3%E5%BA%A7%E6%98%9F%E7%B3%BB)。 +It's the [Andromeda galaxy](https://simple.wikipedia.org/wiki/Andromeda_galaxy). -### 并发和并行有什么不同？ +### What is the difference between concurrency and parallelism? -[并发不是并行，并发可以并行。](https://stackoverflow.com/q/1050222) +[Concurrency is not parallelism. It enables parallelism.](https://stackoverflow.com/q/1050222) -## 秘方 - -- [代码覆盖率](docs/recipes/code-coverage.md) -- [观察模式](docs/recipes/watch-mode.md) -- [端点测试](docs/recipes/endpoint-testing.md) -- [什么时候使用 `t.plan()`](docs/recipes/when-to-use-plan.md) -- [浏览器测试](docs/recipes/browser-testing.md) -- [TypeScript](docs/recipes/typescript.md) - -## 支持 +## Support - [Stack Overflow](https://stackoverflow.com/questions/tagged/ava) -- [Gitter chat](https://gitter.im/avajs/ava) +- [Spectrum](https://spectrum.chat/ava) - [Twitter](https://twitter.com/ava__js) -## 相关 +## Related -- [sublime-ava](https://github.com/avajs/sublime-ava) - AVA 测试的代码片段 -- [atom-ava](https://github.com/avajs/atom-ava) - AVA 测试的代码片段 -- [vscode-ava](https://github.com/samverschueren/vscode-ava) - AVA 测试的代码片段 -- [eslint-plugin-ava](https://github.com/avajs/eslint-plugin-ava) - AVA 测试的代码规则 -- [gulp-ava](https://github.com/avajs/gulp-ava) - 用 gulp 运行测试 -- [grunt-ava](https://github.com/avajs/grunt-ava) - 用 grunt 运行测试 -- [fly-ava](https://github.com/pine/fly-ava) - 用 fly 运行测试 -- [start-ava](https://github.com/start-runner/ava) - 用 start 运行测试 +- [eslint-plugin-ava](https://github.com/avajs/eslint-plugin-ava) - Lint rules for AVA tests +- [sublime-ava](https://github.com/avajs/sublime-ava) - Snippets for AVA tests +- [atom-ava](https://github.com/avajs/atom-ava) - Snippets for AVA tests +- [vscode-ava](https://github.com/samverschueren/vscode-ava) - Snippets for AVA tests +- [gulp-ava](https://github.com/avajs/gulp-ava) - Run tests with gulp +- [grunt-ava](https://github.com/avajs/grunt-ava) - Run tests with grunt +- [More…](https://github.com/avajs/awesome-ava#packages) -[更多...](https://github.com/avajs/awesome-ava#packages) +## Links -## 链接 +- [AVA stickers, t-shirts, etc](https://www.redbubble.com/people/sindresorhus/works/30330590-ava-logo) +- [Awesome list](https://github.com/avajs/awesome-ava) +- [AVA Casts](http://avacasts.com) +- [More…](https://github.com/avajs/awesome-ava) -- [购买 AVA 贴纸](https://www.stickermule.com/user/1070705604/stickers) -- [Awesome 列表](https://github.com/avajs/awesome-ava) +## Team -## 团队 +[![Mark Wubben](https://github.com/novemberborn.png?size=100)](https://github.com/novemberborn) | [![Sindre Sorhus](https://github.com/sindresorhus.png?size=100)](https://github.com/sindresorhus) | [![Vadim Demedes](https://github.com/vadimdemedes.png?size=100)](https://github.com/vadimdemedes) +---|---|--- +[Mark Wubben](https://novemberborn.net) | [Sindre Sorhus](http://sindresorhus.com) | [Vadim Demedes](https://github.com/vadimdemedes) -[![Sindre Sorhus](https://avatars.githubusercontent.com/u/170270?s=130)](http://sindresorhus.com) | [![Vadim Demedes](https://avatars.githubusercontent.com/u/697676?s=130)](https://github.com/vdemedes) | [![James Talmage](https://avatars.githubusercontent.com/u/4082216?s=130)](https://github.com/jamestalmage) | [![Mark Wubben](https://avatars.githubusercontent.com/u/33538?s=130)](https://novemberborn.net) ----|---|---|--- -[Sindre Sorhus](http://sindresorhus.com) | [Vadim Demedes](https://github.com/vdemedes) | [James Talmage](https://github.com/jamestalmage) | [Mark Wubben](https://novemberborn.net) - -### 前任 +###### Former - [Kevin Mårtensson](https://github.com/kevva) +- [James Talmage](https://github.com/jamestalmage) +- [Juan Soto](https://github.com/sotojuan) +- [Jeroen Engels](https://github.com/jfmengels) +
-
-
-
- AVA -
-
+
+
+
+ + AVA + +
+
+ +[Babel recipe]: docs/recipes/babel.md \ No newline at end of file From 499ed5c82c91e9fad443f6606b8e483561be9bfc Mon Sep 17 00:00:00 2001 From: luotao Date: Fri, 23 Aug 2019 00:28:58 +0800 Subject: [PATCH 4/8] Ignore .DS_Store --- .gitignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..e43b0f98 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.DS_Store From d475122d46999be9095293fb5f050b76390cac40 Mon Sep 17 00:00:00 2001 From: luotao Date: Fri, 23 Aug 2019 00:31:25 +0800 Subject: [PATCH 5/8] Remove extra lines --- zh_CN/readme.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/zh_CN/readme.md b/zh_CN/readme.md index 5c7f2a77..25673911 100644 --- a/zh_CN/readme.md +++ b/zh_CN/readme.md @@ -4,12 +4,6 @@ ___ 这是 [readme.md](https://github.com/avajs/ava/blob/master/readme.md) 的简体中文翻译。这个[链接](https://github.com/avajs/ava/compare/67bf0472133041f59ef469f737b696de05ae316b...master#diff-0730bb7c2e8f9ea2438b52e419dd86c9) 用来查看本翻译与 AVA 的 master 分支是否有差别（如果你没有看到 `readme.md` 发生变化，那就意味着这份翻译文档是最新的）。 ___ -___ -**备注** - -这是 [readme.md](https://github.com/avajs/ava/blob/master/readme.md) 的简体中文翻译。这个[链接](https://github.com/avajs/ava/compare/67bf0472133041f59ef469f737b696de05ae316b...master#diff-0730bb7c2e8f9ea2438b52e419dd86c9) 用来查看本翻译与 AVA 的 master 分支是否有差别（如果你没有看到 `readme.md` 发生变化，那就意味着这份翻译文档是最新的）。 -___ - # AVA logo [![Build Status](https://travis-ci.org/avajs/ava.svg?branch=master)](https://travis-ci.org/avajs/ava) [![Coverage Status](https://codecov.io/gh/avajs/ava/branch/master/graph/badge.svg)](https://codecov.io/gh/avajs/ava/branch/master) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo) [![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/ava) @@ -255,4 +249,4 @@ It's the [Andromeda galaxy](https://simple.wikipedia.org/wiki/Andromeda_galaxy).
-[Babel recipe]: docs/recipes/babel.md \ No newline at end of file +[Babel recipe]: docs/recipes/babel.md From f09a828a8ed94924cd839f21e17a2b670dfeb76c Mon Sep 17 00:00:00 2001 From: luotao Date: Fri, 23 Aug 2019 00:43:31 +0800 Subject: [PATCH 6/8] Update zh_CN readme.md --- zh_CN/readme.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/zh_CN/readme.md b/zh_CN/readme.md index 25673911..9cb225dc 100644 --- a/zh_CN/readme.md +++ b/zh_CN/readme.md @@ -21,20 +21,20 @@ Read our [contributing guide](contributing.md) if you're looking to contribute ( Translations: [Español](https://github.com/avajs/ava-docs/blob/master/es_ES/readme.md), [Français](https://github.com/avajs/ava-docs/blob/master/fr_FR/readme.md), [Italiano](https://github.com/avajs/ava-docs/blob/master/it_IT/readme.md), [日本語](https://github.com/avajs/ava-docs/blob/master/ja_JP/readme.md), [한국어](https://github.com/avajs/ava-docs/blob/master/ko_KR/readme.md), [Português](https://github.com/avajs/ava-docs/blob/master/pt_BR/readme.md), [Русский](https://github.com/avajs/ava-docs/blob/master/ru_RU/readme.md), [简体中文](https://github.com/avajs/ava-docs/blob/master/zh_CN/readme.md) -## Why AVA? +## 为什么选择 AVA？ - Minimal and fast -- Simple test syntax +- 简单的测试语法 - Runs tests concurrently - Enforces writing atomic tests -- No implicit globals +- 没有隐式的全局变量 - Includes TypeScript definitions - [Magic assert](#magic-assert) - [Isolated environment for each test file](./docs/01-writing-tests.md#process-isolation) -- [Write your tests using the latest JavaScript syntax](#latest-javascript-support) -- [Promise support](./docs/01-writing-tests.md#promise-support) -- [Async function support](./docs/01-writing-tests.md#async-function-support) -- [Observable support](./docs/01-writing-tests.md#observable-support) +- [使用最新的 JavaScript 语法编写你的测试](#latest-javascript-support) +- [支持 Promise](./docs/01-writing-tests.md#promise-support) +- [支持 Async 函数](./docs/01-writing-tests.md#async-function-support) +- [支持 Observable](./docs/01-writing-tests.md#observable-support) - [Enhanced assertion messages](./docs/03-assertions.md#enhanced-assertion-messages) - [Automatic parallel test runs in CI](#parallel-runs-in-ci) - [TAP reporter](./docs/05-command-line.md#tap-reporter) @@ -42,13 +42,13 @@ Translations: [Español](https://github.com/avajs/ava-docs/blob/master/es_ES/rea ## Usage -To install and set up AVA, run: +要安装并配置 AVA，运行： ```console npm init ava ``` -Your `package.json` will then look like this (exact version notwithstanding): +你的 `package.json` 看起来将会像这样 (exact version notwithstanding)： ```json { @@ -62,13 +62,13 @@ Your `package.json` will then look like this (exact version notwithstanding): } ``` -Or if you prefer using Yarn: +或者如果你偏好使用 Yarn： ```console yarn add ava --dev ``` -Alternatively you can install `ava` manually: +相应的你也可以手动安装 `ava`： ```console npm install --save-dev ava @@ -76,7 +76,7 @@ npm install --save-dev ava Don't forget to configure the `test` script in your `package.json` as per above. -### Create your test file +### 创建你的测试文件 Create a file named `test.js` in the project root directory: @@ -93,7 +93,7 @@ test('bar', async t => { }); ``` -### Running your tests +### 运行你的测试 ```console npm test @@ -111,7 +111,7 @@ Run with the `--watch` flag to enable AVA's [watch mode](docs/recipes/watch-mode npx ava --watch ``` -## Supported Node.js versions +## 所支持的 Node.js 版本 AVA supports the latest release of any major version that [is supported by Node.js itself](https://github.com/nodejs/Release#release-schedule). Read more in our [support statement](docs/support-statement.md). @@ -127,7 +127,7 @@ AVA adds code excerpts and clean diffs for actual and expected values. If values AVA automatically removes unrelated lines in stack traces, allowing you to find the source of an error much faster, as seen above. -### Latest JavaScript support +### 最新的 JavaScript 支持 AVA uses [Babel 7](https://babeljs.io) so you can use the latest JavaScript syntax in your tests. There is no extra setup required. You don't need to be using Babel in your own project for this to work either. @@ -141,7 +141,7 @@ You can disable this syntax support, or otherwise customize AVA's Babel pipeline AVA automatically detects whether your CI environment supports parallel builds. Each build will run a subset of all test files, while still making sure all tests get executed. See the [`ci-parallel-vars`](https://www.npmjs.com/package/ci-parallel-vars) package for a list of supported CI environments. -## Documentation +## 文档 Please see the [files in the `docs` directory](./docs): @@ -201,7 +201,7 @@ It's the [Andromeda galaxy](https://simple.wikipedia.org/wiki/Andromeda_galaxy). [Concurrency is not parallelism. It enables parallelism.](https://stackoverflow.com/q/1050222) -## Support +## 支持 - [Stack Overflow](https://stackoverflow.com/questions/tagged/ava) - [Spectrum](https://spectrum.chat/ava) @@ -217,14 +217,14 @@ It's the [Andromeda galaxy](https://simple.wikipedia.org/wiki/Andromeda_galaxy). - [grunt-ava](https://github.com/avajs/grunt-ava) - Run tests with grunt - [More…](https://github.com/avajs/awesome-ava#packages) -## Links +## 链接 - [AVA stickers, t-shirts, etc](https://www.redbubble.com/people/sindresorhus/works/30330590-ava-logo) - [Awesome list](https://github.com/avajs/awesome-ava) - [AVA Casts](http://avacasts.com) - [More…](https://github.com/avajs/awesome-ava) -## Team +## 团队 [![Mark Wubben](https://github.com/novemberborn.png?size=100)](https://github.com/novemberborn) | [![Sindre Sorhus](https://github.com/sindresorhus.png?size=100)](https://github.com/sindresorhus) | [![Vadim Demedes](https://github.com/vadimdemedes.png?size=100)](https://github.com/vadimdemedes) ---|---|--- From 01ea660411ee2c151a0e63113bf548e892cdeb89 Mon Sep 17 00:00:00 2001 From: luotao Date: Fri, 23 Aug 2019 01:04:33 +0800 Subject: [PATCH 7/8] Update zh_CN readme.md --- zh_CN/readme.md | 61 +++++++++++++++++++++++++------------------------ 1 file changed, 31 insertions(+), 30 deletions(-) diff --git a/zh_CN/readme.md b/zh_CN/readme.md index 9cb225dc..b2b2e100 100644 --- a/zh_CN/readme.md +++ b/zh_CN/readme.md @@ -25,10 +25,10 @@ Translations: [Español](https://github.com/avajs/ava-docs/blob/master/es_ES/rea - Minimal and fast - 简单的测试语法 -- Runs tests concurrently -- Enforces writing atomic tests +- 并行地运行测试 +- 强制编写原子性的测试 - 没有隐式的全局变量 -- Includes TypeScript definitions +- 包含 TypeScript 的类型定义 - [Magic assert](#magic-assert) - [Isolated environment for each test file](./docs/01-writing-tests.md#process-isolation) - [使用最新的 JavaScript 语法编写你的测试](#latest-javascript-support) @@ -36,7 +36,7 @@ Translations: [Español](https://github.com/avajs/ava-docs/blob/master/es_ES/rea - [支持 Async 函数](./docs/01-writing-tests.md#async-function-support) - [支持 Observable](./docs/01-writing-tests.md#observable-support) - [Enhanced assertion messages](./docs/03-assertions.md#enhanced-assertion-messages) -- [Automatic parallel test runs in CI](#parallel-runs-in-ci) +- [在 CI 上自动的并发运行测试](#parallel-runs-in-ci) - [TAP reporter](./docs/05-command-line.md#tap-reporter) @@ -78,7 +78,7 @@ Don't forget to configure the `test` script in your `package.json` as per above. ### 创建你的测试文件 -Create a file named `test.js` in the project root directory: +在项目根目录创建 `test.js` 文件： ```js import test from 'ava'; @@ -99,7 +99,7 @@ test('bar', async t => { npm test ``` -Or with `npx`: +或者使用 `npx`: ```console npx ava @@ -129,29 +129,30 @@ AVA automatically removes unrelated lines in stack traces, allowing you to find ### 最新的 JavaScript 支持 -AVA uses [Babel 7](https://babeljs.io) so you can use the latest JavaScript syntax in your tests. There is no extra setup required. You don't need to be using Babel in your own project for this to work either. +AVA 使用了 [Babel 7](https://babeljs.io)，所以你可以在你的测试中使用最新的 JavaScript 语法。无需额外的配置。你并不需要在为此你自己的项目中使用 Babel。 We aim to support all [finished syntax proposals](https://github.com/tc39/proposals/blob/master/finished-proposals.md), as well as all syntax from ratified JavaScript versions (e.g. ES2017). See our [`@ava/stage-4`](https://github.com/avajs/babel-preset-stage-4) preset for the currently supported proposals. Please note that we do not add or modify built-ins. For example, if you use [`Object.fromEntries()`](https://github.com/tc39/proposal-object-from-entries) in your tests, they will crash in Node.js 10 which does not implement this method. -You can disable this syntax support, or otherwise customize AVA's Babel pipeline. See our [Babel recipe] for more details. +你可以禁用这个语法支持，或者自定义 AVA 的 Babel pipeline。请查阅我们的 [Babel recipe] 了解更多信息。 ### Parallel runs in CI -AVA automatically detects whether your CI environment supports parallel builds. Each build will run a subset of all test files, while still making sure all tests get executed. See the [`ci-parallel-vars`](https://www.npmjs.com/package/ci-parallel-vars) package for a list of supported CI environments. +AVA 会自动检查你的 CI 环境是否支持并行构建。Each build will run a subset of all test files, while still making sure all tests get executed. See the [`ci-parallel-vars`](https://www.npmjs.com/package/ci-parallel-vars) package for a list of supported CI environments. + ## 文档 -Please see the [files in the `docs` directory](./docs): +请翻阅 [files in the `docs` directory](./docs): -* [Writing tests](./docs/01-writing-tests.md) +* [编写测试](./docs/01-writing-tests.md) * [Execution context](./docs/02-execution-context.md) -* [Assertions](./docs/03-assertions.md) -* [Snapshot testing](./docs/04-snapshot-testing.md) +* [断言](./docs/03-assertions.md) +* [Snapshot 测试](./docs/04-snapshot-testing.md) * [Command line (CLI)](./docs/05-command-line.md) -* [Configuration](./docs/06-configuration.md) -* [Test timeouts](./docs/07-test-timeouts.md) +* [配置](./docs/06-configuration.md) +* [测试超时](./docs/07-test-timeouts.md) ### Common pitfalls @@ -160,19 +161,19 @@ We have a growing list of [common pitfalls](docs/08-common-pitfalls.md) you may ### Recipes - [Test setup](docs/recipes/test-setup.md) -- [Code coverage](docs/recipes/code-coverage.md) -- [Watch mode](docs/recipes/watch-mode.md) -- [Endpoint testing](docs/recipes/endpoint-testing.md) -- [When to use `t.plan()`](docs/recipes/when-to-use-plan.md) -- [Browser testing](docs/recipes/browser-testing.md) +- [代码覆盖率](docs/recipes/code-coverage.md) +- [Watch 模式](docs/recipes/watch-mode.md) +- [Endpoint 测试](docs/recipes/endpoint-testing.md) +- [何时使用 `t.plan()`](docs/recipes/when-to-use-plan.md) +- [浏览器测试](docs/recipes/browser-testing.md) - [TypeScript](docs/recipes/typescript.md) - [Flow](docs/recipes/flow.md) -- [Configuring Babel][Babel recipe] -- [Using ES modules](docs/recipes/es-modules.md) +- [配置 Babel][Babel recipe] +- [使用 ES modules](docs/recipes/es-modules.md) - [Passing arguments to your test files](docs/recipes/passing-arguments-to-your-test-files.md) -- [Testing React components](docs/recipes/react.md) -- [Testing Vue.js components](docs/recipes/vue.md) -- [JSPM and SystemJS](docs/recipes/jspm-systemjs.md) +- [测试 React 组件](docs/recipes/react.md) +- [测试 Vue.js 组件](docs/recipes/vue.md) +- [JSPM 和 SystemJS](docs/recipes/jspm-systemjs.md) - [Debugging tests with Chrome DevTools](docs/recipes/debugging-with-chrome-devtools.md) - [Debugging tests with VSCode](docs/recipes/debugging-with-vscode.md) - [Debugging tests with WebStorm](docs/recipes/debugging-with-webstorm.md) @@ -181,7 +182,7 @@ We have a growing list of [common pitfalls](docs/08-common-pitfalls.md) you may ## FAQ -### Why not `mocha`, `tape`, `tap`? +### 为什么不选择 `mocha`, `tape`, `tap`? Mocha requires you to use implicit globals like `describe` and `it` with the default interface (which most people use). It's not very opinionated and executes tests serially without process isolation, making it slow. @@ -189,11 +190,11 @@ Tape and tap are pretty good. AVA is highly inspired by their syntax. They too e In contrast AVA is highly opinionated and runs tests concurrently, with a separate process for each test file. Its default reporter is easy on the eyes and yet AVA still supports TAP output through a CLI flag. -### How is the name written and pronounced? +### 名字如何拼写的发音? -AVA, not Ava or ava. Pronounced [`/ˈeɪvə/`](media/pronunciation.m4a?raw=true): Ay (f**a**ce, m**a**de) V (**v**ie, ha**v**e) A (comm**a**, **a**go) +AVA, 不是 Ava 或 ava. 读作 [`/ˈeɪvə/`](media/pronunciation.m4a?raw=true): Ay (f**a**ce, m**a**de) V (**v**ie, ha**v**e) A (comm**a**, **a**go) -### What is the header background? +### 头部的背景图是什么? It's the [Andromeda galaxy](https://simple.wikipedia.org/wiki/Andromeda_galaxy). @@ -207,7 +208,7 @@ It's the [Andromeda galaxy](https://simple.wikipedia.org/wiki/Andromeda_galaxy). - [Spectrum](https://spectrum.chat/ava) - [Twitter](https://twitter.com/ava__js) -## Related +## 相关 - [eslint-plugin-ava](https://github.com/avajs/eslint-plugin-ava) - Lint rules for AVA tests - [sublime-ava](https://github.com/avajs/sublime-ava) - Snippets for AVA tests From f07e2d3854105e12acd0d7574e2976f396cbd16e Mon Sep 17 00:00:00 2001 From: luotao Date: Fri, 23 Aug 2019 16:20:11 +0800 Subject: [PATCH 8/8] Update zh_CN reademe.md --- zh_CN/readme.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/zh_CN/readme.md b/zh_CN/readme.md index b2b2e100..7f062309 100644 --- a/zh_CN/readme.md +++ b/zh_CN/readme.md @@ -9,11 +9,11 @@ ___ [![Build Status](https://travis-ci.org/avajs/ava.svg?branch=master)](https://travis-ci.org/avajs/ava) [![Coverage Status](https://codecov.io/gh/avajs/ava/branch/master/graph/badge.svg)](https://codecov.io/gh/avajs/ava/branch/master) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/xojs/xo) [![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/ava) [![Mentioned in Awesome Node.js](https://awesome.re/mentioned-badge.svg)](https://github.com/sindresorhus/awesome-nodejs) -Testing can be a drag. AVA helps you get it done. AVA is a test runner for Node.js with a concise API, detailed error output, embrace of new language features and process isolation that let you write tests more effectively. So you can ship more awesome code. 🚀 +测试可能是一个累赘。但 AVA 可以帮助你完成它。AVA 是一个基于 Node.js 的的测试运行工具，通过提供简洁的 API，详尽的错误输出，拥抱新的语言特性和进程隔离的特性让你更高效地编写测试。所以你可以产出更多更好的代码。🚀 -Follow the [AVA Twitter account](https://twitter.com/ava__js) for updates. +关注 [AVA 的 Twitter 账号](https://twitter.com/ava__js) 以获取更新。 -Read our [contributing guide](contributing.md) if you're looking to contribute (issues / PRs / etc). +如果你想参与贡献（issues / PRs 等），请翻阅我们的 [贡献指南](contributing.md) ![](media/mini-reporter.gif) @@ -23,7 +23,7 @@ Translations: [Español](https://github.com/avajs/ava-docs/blob/master/es_ES/rea ## 为什么选择 AVA？ -- Minimal and fast +- 轻量且高效 - 简单的测试语法 - 并行地运行测试 - 强制编写原子性的测试 @@ -74,7 +74,7 @@ yarn add ava --dev npm install --save-dev ava ``` -Don't forget to configure the `test` script in your `package.json` as per above. +别忘记参照下文在你的 `package.json` 配置 `test` 要运行的脚本。 ### 创建你的测试文件 @@ -105,7 +105,7 @@ npm test npx ava ``` -Run with the `--watch` flag to enable AVA's [watch mode](docs/recipes/watch-mode.md): +通过 `--watch` flag 运行以启用 AVA 的 [watch 模式](docs/recipes/watch-mode.md)： ```console npx ava --watch @@ -133,13 +133,13 @@ AVA 使用了 [Babel 7](https://babeljs.io)，所以你可以在你的测试中 We aim to support all [finished syntax proposals](https://github.com/tc39/proposals/blob/master/finished-proposals.md), as well as all syntax from ratified JavaScript versions (e.g. ES2017). See our [`@ava/stage-4`](https://github.com/avajs/babel-preset-stage-4) preset for the currently supported proposals. -Please note that we do not add or modify built-ins. For example, if you use [`Object.fromEntries()`](https://github.com/tc39/proposal-object-from-entries) in your tests, they will crash in Node.js 10 which does not implement this method. +请注意我们没有修改或添加任何内建的方法，如果你在你的测试中使用 [`Object.fromEntries()`](https://github.com/tc39/proposal-object-from-entries)，由于 Node.js 10 不支持这个方法，这将会在 Node.js 10 下会崩溃。 你可以禁用这个语法支持，或者自定义 AVA 的 Babel pipeline。请查阅我们的 [Babel recipe] 了解更多信息。 -### Parallel runs in CI +### CI 并行构建 -AVA 会自动检查你的 CI 环境是否支持并行构建。Each build will run a subset of all test files, while still making sure all tests get executed. See the [`ci-parallel-vars`](https://www.npmjs.com/package/ci-parallel-vars) package for a list of supported CI environments. +AVA 会自动检查你的 CI 环境是否支持并行构建。Each build will run a subset of all test files, while still making sure all tests get executed. 请翻阅 [`ci-parallel-vars`](https://www.npmjs.com/package/ci-parallel-vars) 包以获得所支持的 CI 环境列表。 ## 文档 @@ -170,15 +170,15 @@ We have a growing list of [common pitfalls](docs/08-common-pitfalls.md) you may - [Flow](docs/recipes/flow.md) - [配置 Babel][Babel recipe] - [使用 ES modules](docs/recipes/es-modules.md) -- [Passing arguments to your test files](docs/recipes/passing-arguments-to-your-test-files.md) +- [向你的测试文件传递参数](docs/recipes/passing-arguments-to-your-test-files.md) - [测试 React 组件](docs/recipes/react.md) - [测试 Vue.js 组件](docs/recipes/vue.md) - [JSPM 和 SystemJS](docs/recipes/jspm-systemjs.md) -- [Debugging tests with Chrome DevTools](docs/recipes/debugging-with-chrome-devtools.md) -- [Debugging tests with VSCode](docs/recipes/debugging-with-vscode.md) -- [Debugging tests with WebStorm](docs/recipes/debugging-with-webstorm.md) -- [Isolated MongoDB integration tests](docs/recipes/isolated-mongodb-integration-tests.md) -- [Testing web apps using Puppeteer](docs/recipes/puppeteer.md) +- [使用 Chrome DevTools 调试测试](docs/recipes/debugging-with-chrome-devtools.md) +- [使用 VSCode 调试测试](docs/recipes/debugging-with-vscode.md) +- [使用 WebStorm 调试测试](docs/recipes/debugging-with-webstorm.md) +- [隔离的 MongoDB 集成测试](docs/recipes/isolated-mongodb-integration-tests.md) +- [使用 Puppeteer 测试 web 应用](docs/recipes/puppeteer.md) ## FAQ @@ -190,7 +190,7 @@ Tape and tap are pretty good. AVA is highly inspired by their syntax. They too e In contrast AVA is highly opinionated and runs tests concurrently, with a separate process for each test file. Its default reporter is easy on the eyes and yet AVA still supports TAP output through a CLI flag. -### 名字如何拼写的发音? +### 名字如何拼写和发音? AVA, 不是 Ava 或 ava. 读作 [`/ˈeɪvə/`](media/pronunciation.m4a?raw=true): Ay (f**a**ce, m**a**de) V (**v**ie, ha**v**e) A (comm**a**, **a**go)