Skip to content

Commit 4583ccb

Browse files
committed
docs: add choosing a test runner docs
1 parent b0de8e7 commit 4583ccb

File tree

2 files changed

+35
-0
lines changed

2 files changed

+35
-0
lines changed

docs/en/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
* [selectors](api/selectors.md)
4040
* [guides](guides/README.md)
4141
* [Introduction to unit tests](guides/introduction-to-unit-tests.md)
42+
* [Choosing a test runner](guides/choosing-a-test-runner.md)
4243
* [Using with Jest](guides/using-with-jest.md)
4344
* [Testing SFCs with Jest](guides/testing-SFCs-with-jest.md)
4445
* [Testing SFCs with Mocha and webpack](guides/testing-SFCs-with-mocha-webpack.md)
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Choosing a test runner
2+
3+
A test runner is a program that runs tests.
4+
5+
There are many popular JavaScript test runners, and Vue Test Utils works in all of them. It's test runner agnostic.
6+
7+
However, some popular test runners do not have good support for compiling single file components (SFCs).
8+
9+
## Performance
10+
11+
The fastest test runners are:
12+
13+
- Jest
14+
- Mocha Webpack
15+
- tape
16+
17+
You can see a performance comparisson of popular test runners [here](https://github.com/eddyerburgh/vue-unit-test-perf-comparison).
18+
19+
## Features
20+
21+
Jest is the most fully featured test runner. It requires the leat configuration, as it sets up JSDOM by default.
22+
23+
tape is very minimal. If you choose tape, you will need to do a lot of set up yourself.
24+
25+
## Getting started
26+
27+
You can use our guides to get started with a test runner:
28+
29+
- [Testing SFCs with Jest](testing-SFCs-with-jest.md)
30+
- [Testing SFCs with Mocha and webpack](testing-SFCs-with-mocha-webpack.md)
31+
32+
## Resources
33+
34+
- [Test runner performance comparison](https://github.com/eddyerburgh/vue-unit-test-perf-comparison)

0 commit comments

Comments
 (0)