Skip to content

Commit 2b078c6

Browse files
Jinjiangeddyerburgh
authored andcommitted
docs: vue-test-utils -> Vue Test Utils (#443)
* [docs] standardized the name into title case * [docs][zh-cn] standardized the name into title case * [docs][zh-cn] standardized the name into title case
1 parent 87c58fb commit 2b078c6

32 files changed

+60
-60
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
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)
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)
22

33
## Currently in beta
4-
To use vue-test-utils beta:
4+
To use Vue Test Utils beta:
55
```
66
// npm
77
npm install --save-dev @vue/test-utils
@@ -12,7 +12,7 @@ yarn add --dev @vue/test-utils
1212

1313
## Intro
1414

15-
`vue-test-utils` is the official test library for [Vue.js](http://vuejs.org). It provides methods for unit testing Vue components.
15+
Vue Test Utils is the official test library for [Vue.js](http://vuejs.org). It provides methods for unit testing Vue components.
1616

1717
## Documentation
1818

docs/en/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# vue-test-utils
1+
# Vue Test Utils
22

3-
`vue-test-utils` is the official unit testing utility library for Vue.js.
3+
Vue Test Utils is the official unit testing utility library for Vue.js.
44

55
## Table of Contents
66

docs/en/api/components/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Components
22

3-
vue-test-utils includes utility components you can use to stub components.
3+
Vue Test Utils includes utility components you can use to stub components.
44

55
[TransitionStub](./TransitionStub.md) and [TransitionGroupStub](./TransitionGroupStub.md) are used to stub `transition` and `transition-group` components by default. You can edit the stubs by editing the config.

docs/en/api/components/TransitionGroupStub.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A component to stub the `transition-group` component. Instead of performing transitions asynchronously, it returns the child components synchronously.
44

5-
This is set to stub all `transition-group` components by default in the `vue-test-utils` config. To use the built-in `transition-group` component set `config.stubs['transition-group']` to false:
5+
This is set to stub all `transition-group` components by default in the Vue Test Utils config. To use the built-in `transition-group` component set `config.stubs['transition-group']` to false:
66

77
```js
88
import { config } from '@vue/test-utils'

docs/en/api/components/TransitionStub.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A component to stub the `transition` component. Instead of performing transitions asynchronously, it returns the child component synchronously.
44

5-
This is set to stub all `transition` components by default in the vue-test-utils config. To use the built-in `transition` component set `config.stubs.transition` to false:
5+
This is set to stub all `transition` components by default in the Vue Test Utils config. To use the built-in `transition` component set `config.stubs.transition` to false:
66

77
```js
88
import { config } from '@vue/test-utils'

docs/en/api/config.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Config
22

3-
vue-test-utils includes a config object to defined options used by vue-test-utils.
3+
Vue Test Utils includes a config object to defined options used by Vue Test Utils.
44

5-
## `vue-test-utils` Config Options
5+
## Vue Test Utils Config Options
66

77
### `stubs`
88

docs/en/api/options.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Mounting Options
22

3-
Options for `mount` and `shallow`. The options object can contain both `vue-test-utils` mounting options and other options.
3+
Options for `mount` and `shallow`. The options object can contain both Vue Test Utils mounting options and other options.
44

5-
## `vue-test-utils` Specific Mounting Options
5+
## Vue Test Utils Specific Mounting Options
66

77
- [`context`](#context)
88
- [`slots`](#slots)

docs/en/api/selectors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ expect(wrapper.is(Foo)).toBe(true)
4343

4444
### Name
4545

46-
Using a find option object, `vue-test-utils` allows for selecting elements by a `name` of component on wrapper components.
46+
Using a find option object, Vue Test Utils allows for selecting elements by a `name` of component on wrapper components.
4747

4848
```js
4949
const buttonWrapper = wrapper.find({ name: 'my-button' })
@@ -52,7 +52,7 @@ buttonWrapper.trigger('click')
5252

5353
### Ref
5454

55-
Using a find option object, `vue-test-utils` allows for selecting elements by `$ref` on wrapper components.
55+
Using a find option object, Vue Test Utils allows for selecting elements by `$ref` on wrapper components.
5656

5757
```js
5858
const buttonWrapper = wrapper.find({ ref: 'myButton' })

docs/en/api/wrapper/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# `Wrapper`
22

3-
`vue-test-utils` is a wrapper based API.
3+
Vue Test Utils is a wrapper based API.
44

55
A `Wrapper` is an object that contains a mounted component or vnode and methods to test the component or vnode.
66

77
- **Properties:**
88

99
`vm` `Component`: this is the `Vue` instance. You can access all the [instance methods and properties of a vm](https://vuejs.org/v2/api/#Instance-Properties) with `wrapper.vm`. This only exists on Vue component wrappers
1010
`element` `HTMLElement`: the root DOM node of the wrapper
11-
`options` `Object`: Object containing `vue-test-utils` options passed to `mount` or `shallow`
11+
`options` `Object`: Object containing Vue Test Utils options passed to `mount` or `shallow`
1212
`options.attachedToDom` `Boolean`: True if `attachToDom` was passed to `mount` or `shallow`
1313

1414
- **Methods:**

docs/en/guides/choosing-a-test-runner.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A test runner is a program that runs tests.
44

5-
There are many popular JavaScript test runners, and `vue-test-utils` works with all of them. It's test runner agnostic.
5+
There are many popular JavaScript test runners, and Vue Test Utils works with all of them. It's test runner agnostic.
66

77
There are a few things to consider when choosing a test runner though: feature set, performance, and support for single-file component (SFC) pre-compilation. After carefully comparing existing libraries, here are two test runners that we recommend:
88

@@ -12,7 +12,7 @@ There are a few things to consider when choosing a test runner though: feature s
1212

1313
## Browser Environment
1414

15-
`vue-test-utils` relies on a browser environment. Technically you can run it in a real browser, but it's not recommended due to the complexity of launching real browsers on different platforms. Instead, we recommend running the tests in Node with a virtual browser environment using [JSDOM](https://github.com/tmpvar/jsdom).
15+
Vue Test Utils relies on a browser environment. Technically you can run it in a real browser, but it's not recommended due to the complexity of launching real browsers on different platforms. Instead, we recommend running the tests in Node with a virtual browser environment using [JSDOM](https://github.com/tmpvar/jsdom).
1616

1717
The Jest test runner sets up JSDOM automatically. For other test runners, you can manually set up JSDOM for the tests using [jsdom-global](https://github.com/rstacruz/jsdom-global) in the entry for your tests:
1818

0 commit comments

Comments
 (0)