1 | # Vue Test Utils [![Build Status](https://circleci.com/gh/vuejs/vue-test-utils/tree/dev.png?style=shield)](https://circleci.com/gh/vuejs/vue-test-utils)
|
2 |
|
3 | ## Currently in beta
|
4 |
|
5 | To use Vue Test Utils beta:
|
6 |
|
7 | ```
|
8 | // npm
|
9 | npm install --save-dev @vue/test-utils
|
10 |
|
11 | // yarn
|
12 | yarn add --dev @vue/test-utils
|
13 | ```
|
14 |
|
15 | ## Intro
|
16 |
|
17 | Vue Test Utils is the official test library for [Vue.js](http://vuejs.org). It provides methods for unit testing Vue components.
|
18 |
|
19 | ## Documentation
|
20 |
|
21 | Refer to the [documentation](https://vue-test-utils.vuejs.org/)
|
22 |
|
23 | ## Examples
|
24 |
|
25 | - [example with Jest](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-unit-jest)
|
26 | - [example with Mocha](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-unit-mocha)
|
27 | - [example with tape](https://github.com/eddyerburgh/vue-test-utils-tape-example)
|
28 | - [example with AVA](https://github.com/eddyerburgh/vue-test-utils-ava-example)
|
29 |
|
30 | ## Questions
|
31 |
|
32 | For questions and support please use the [Discord chat room](https://vue-land.js.org/), [Gitter chat room](https://gitter.im/vuejs/vue), or [the official forum](http://forum.vuejs.org). The issue list of this repo is **exclusively** for bug reports and feature requests.
|
33 |
|
34 | ## Issues
|
35 |
|
36 | Please make sure to read the [Issue Reporting Checklist](https://github.com/vuejs/vue/blob/dev/.github/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
|
37 |
|
38 | ## License
|
39 |
|
40 | [MIT](http://opensource.org/licenses/MIT)
|