Skip to content

Commit d5fceb7

Browse files
César Albercaeddyerburgh
César Alberca
authored and
eddyerburgh
committed
docs: update docs (#874)
1 parent ba8aade commit d5fceb7

File tree

9 files changed

+61
-57
lines changed

9 files changed

+61
-57
lines changed

‎docs/api/config.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ When passing `stubs` as an array in the mounting options, `config.stubs` are con
2020
Example:
2121

2222
```js
23-
import VueTestUtils from '@vue/test-utils'
23+
import { config } from '@vue/test-utils'
2424

25-
VueTestUtils.config.stubs['my-component'] = '<div />'
25+
config.stubs['my-component'] = '<div />'
2626
```
2727

2828
### `mocks`
@@ -35,9 +35,9 @@ Like `stubs`, the values passed to `config.mocks` are used by default. Any value
3535
Example:
3636

3737
```js
38-
import VueTestUtils from '@vue/test-utils'
38+
import { config } from '@vue/test-utils'
3939

40-
VueTestUtils.config.mocks['$store'] = {
40+
config.mocks['$store'] = {
4141
state: {
4242
id: 1
4343
}
@@ -54,9 +54,9 @@ You can configure default methods using the `config` object. This can be useful
5454
Example:
5555

5656
```js
57-
import VueTestUtils from '@vue/test-utils'
57+
import { config } from '@vue/test-utils'
5858

59-
VueTestUtils.config.methods['errors'] = () => {
59+
config.methods['errors'] = () => {
6060
any: () => false
6161
}
6262
```
@@ -71,9 +71,9 @@ Like `stubs` or `mocks`, the values passed to `config.provide` are used by defau
7171
Example:
7272

7373
```js
74-
import VueTestUtils from '@vue/test-utils'
74+
import { config } from '@vue/test-utils'
7575

76-
VueTestUtils.config.provide['$logger'] = {
76+
config.provide['$logger'] = {
7777
log: (...args) => {
7878
console.log(...args)
7979
}
@@ -90,9 +90,9 @@ Logs warning when extended child components are automatically stubbed. Hides war
9090
Example:
9191

9292
```js
93-
import VueTestUtils from '@vue/test-utils'
93+
import { config } from '@vue/test-utils'
9494

95-
VueTestUtils.config.logModifiedComponents = false
95+
config.logModifiedComponents = false
9696
```
9797

9898
### `silent`
@@ -105,7 +105,7 @@ It suppresses warnings triggered by Vue while mutating component's observables (
105105
Example:
106106

107107
```js
108-
import VueTestUtils from '@vue/test-utils'
108+
import { config } from '@vue/test-utils'
109109

110-
VueTestUtils.config.silent = false
110+
config.silent = false
111111
```

‎docs/ja/api/components/TransitionGroupStub.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,17 @@
55
デフォルトではすべての `transition-group` コンポーネントは `TransitionGroupStub` でスタブされます。これは `vue-test-utils` の `config` で設定されています。スタブせずに既存の `transition-group` コンポーネントを使用したい場合は、 `config.stubs['transition-group']` に `false` をセットします。:
66

77
```js
8-
import VueTestUtils from '@vue/test-utils'
8+
import { config } from '@vue/test-utils'
99

10-
VueTestUtils.config.stubs['transition-group'] = false
10+
config.stubs['transition-group'] = false
1111
```
1212

1313
`transition-group` コンポーネントをスタブするために再びセットするには以下のようにします。
1414

1515
```js
16-
import VueTestUtils, { TransitionGroupStub } from '@vue/test-utils'
16+
import { config, TransitionGroupStub } from '@vue/test-utils'
1717

18-
VueTestUtils.config.stubs['transition-group'] = TransitionGroupStub
18+
config.stubs['transition-group'] = TransitionGroupStub
1919
```
2020

2121
マウンティングオプションでスタブとしてセットするには以下のようにします。

‎docs/ja/api/config.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ vue-test-utils にはオプションを定義するための `config` オプシ
1919
例:
2020

2121
```js
22-
import VueTestUtils from '@vue/test-utils'
22+
import { config } from '@vue/test-utils'
2323

24-
VueTestUtils.config.stubs['my-component'] = '<div />'
24+
config.stubs['my-component'] = '<div />'
2525
```
2626

2727
#### `mocks`
@@ -34,9 +34,9 @@ VueTestUtils.config.stubs['my-component'] = '<div />'
3434
例:
3535

3636
```js
37-
import VueTestUtils from '@vue/test-utils'
37+
import { config } from '@vue/test-utils'
3838

39-
VueTestUtils.config.mocks['$store'] = {
39+
config.mocks['$store'] = {
4040
state: {
4141
id: 1
4242
}
@@ -53,9 +53,9 @@ VueTestUtils.config.mocks['$store'] = {
5353
例:
5454

5555
```js
56-
import VueTestUtils from '@vue/test-utils'
56+
import { config } from '@vue/test-utils'
5757

58-
VueTestUtils.config.methods['errors'] = () => {
58+
config.methods['errors'] = () => {
5959
any: () => false
6060
}
6161
```
@@ -70,9 +70,9 @@ VueTestUtils.config.methods['errors'] = () => {
7070
例:
7171

7272
```js
73-
import VueTestUtils from '@vue/test-utils'
73+
import { config } from '@vue/test-utils'
7474

75-
VueTestUtils.config.provide['$logger'] = {
75+
config.provide['$logger'] = {
7676
log: (...args) => {
7777
console.log(...args)
7878
}
@@ -89,9 +89,9 @@ VueTestUtils.config.provide['$logger'] = {
8989
例:
9090

9191
```js
92-
import VueTestUtils from '@vue/test-utils'
92+
import { config } from '@vue/test-utils'
9393

94-
VueTestUtils.config.logModifiedComponents = false
94+
config.logModifiedComponents = false
9595
```
9696

9797
### `silent`
@@ -104,7 +104,7 @@ Vue がコンポーネントの変更を感知するプロパティ(例えば pr
104104
例:
105105

106106
```js
107-
import VueTestUtils from '@vue/test-utils'
107+
import { config } from '@vue/test-utils'
108108

109-
VueTestUtils.config.silent = false
109+
config.silent = false
110110
```

‎docs/ru/api/config.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ Vue Test Utils включает объект конфигурации для о
2020
Пример:
2121

2222
```js
23-
import VueTestUtils from '@vue/test-utils'
23+
import { config } from '@vue/test-utils'
2424

25-
VueTestUtils.config.stubs['my-component'] = '<div />'
25+
config.stubs['my-component'] = '<div />'
2626
```
2727

2828
### `mocks`
@@ -35,9 +35,9 @@ VueTestUtils.config.stubs['my-component'] = '<div />'
3535
Пример:
3636

3737
```js
38-
import VueTestUtils from '@vue/test-utils'
38+
import { config } from '@vue/test-utils'
3939

40-
VueTestUtils.config.mocks['$store'] = {
40+
config.mocks['$store'] = {
4141
state: {
4242
id: 1
4343
}
@@ -54,9 +54,9 @@ VueTestUtils.config.mocks['$store'] = {
5454
Пример:
5555

5656
```js
57-
import VueTestUtils from '@vue/test-utils'
57+
import { config } from '@vue/test-utils'
5858

59-
VueTestUtils.config.methods['errors'] = () => {
59+
config.methods['errors'] = () => {
6060
any: () => false
6161
}
6262
```
@@ -71,9 +71,9 @@ VueTestUtils.config.methods['errors'] = () => {
7171
Пример:
7272

7373
```js
74-
import VueTestUtils from '@vue/test-utils'
74+
import { config } from '@vue/test-utils'
7575

76-
VueTestUtils.config.provide['$logger'] = {
76+
config.provide['$logger'] = {
7777
log: (...args) => {
7878
console.log(...args)
7979
}
@@ -90,9 +90,9 @@ VueTestUtils.config.provide['$logger'] = {
9090
Пример:
9191

9292
```js
93-
import VueTestUtils from '@vue/test-utils'
93+
import { config } from '@vue/test-utils'
9494

95-
VueTestUtils.config.logModifiedComponents = false
95+
config.logModifiedComponents = false
9696
```
9797

9898
### `silent`
@@ -105,7 +105,7 @@ VueTestUtils.config.logModifiedComponents = false
105105
Пример:
106106

107107
```js
108-
import VueTestUtils from '@vue/test-utils'
108+
import { config } from '@vue/test-utils'
109109

110-
VueTestUtils.config.silent = false
110+
config.silent = false
111111
```

‎docs/zh/api/config.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ Vue Test Utils 包含了一个定义其选项的配置对象。
2020
示例：
2121

2222
```js
23-
import VueTestUtils from '@vue/test-utils'
23+
import { config } from '@vue/test-utils'
2424

25-
VueTestUtils.config.stubs['my-component'] = '<div />'
25+
config.stubs['my-component'] = '<div />'
2626
```
2727

2828
### `mocks`
@@ -35,9 +35,9 @@ VueTestUtils.config.stubs['my-component'] = '<div />'
3535
示例：
3636

3737
```js
38-
import VueTestUtils from '@vue/test-utils'
38+
import { config } from '@vue/test-utils'
3939

40-
VueTestUtils.config.mocks['$store'] = {
40+
config.mocks['$store'] = {
4141
state: {
4242
id: 1
4343
}
@@ -54,9 +54,9 @@ VueTestUtils.config.mocks['$store'] = {
5454
示例：
5555

5656
```js
57-
import VueTestUtils from '@vue/test-utils'
57+
import { config } from '@vue/test-utils'
5858

59-
VueTestUtils.config.methods['errors'] = () => {
59+
config.methods['errors'] = () => {
6060
any: () => false
6161
}
6262
```
@@ -71,9 +71,9 @@ VueTestUtils.config.methods['errors'] = () => {
7171
示例：
7272

7373
```js
74-
import VueTestUtils from '@vue/test-utils'
74+
import { config } from '@vue/test-utils'
7575

76-
VueTestUtils.config.provide['$logger'] = {
76+
config.provide['$logger'] = {
7777
log: (...args) => {
7878
console.log(...args)
7979
}
@@ -90,9 +90,9 @@ VueTestUtils.config.provide['$logger'] = {
9090
示例：
9191

9292
```js
93-
import VueTestUtils from '@vue/test-utils'
93+
import { config } from '@vue/test-utils'
9494

95-
VueTestUtils.config.logModifiedComponents = false
95+
config.logModifiedComponents = false
9696
```
9797

9898
### `silent`
@@ -105,7 +105,7 @@ VueTestUtils.config.logModifiedComponents = false
105105
示例；
106106

107107
```js
108-
import VueTestUtils from '@vue/test-utils'
108+
import { config } from '@vue/test-utils'
109109

110-
VueTestUtils.config.silent = false
110+
config.silent = false
111111
```

‎packages/test-utils/types/test/mount.ts

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import Vuex from 'vuex'
2-
import { mount, createLocalVue, config } from '../'
3-
import { normalOptions, functionalOptions, Normal, ClassComponent } from './resources'
2+
import VueTestUtils, { mount, createLocalVue, config } from '../'
3+
import { normalOptions, functionalOptions, ClassComponent } from './resources'
44

55
/**
66
* Should create wrapper vm based on (function) component options or constructors
@@ -94,3 +94,6 @@ config.provide = {
9494
}
9595
config.logModifiedComponents = true
9696
config.silent = true
97+
98+
// Check we can use default export
99+
VueTestUtils.config.silent = false

‎packages/test-utils/types/test/shallow.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import Vuex from 'vuex'
22
import { shallowMount, createLocalVue } from '../'
3-
import { normalOptions, functionalOptions, Normal, ClassComponent } from './resources'
3+
import { normalOptions, functionalOptions, ClassComponent } from './resources'
44

55
/**
66
* Should create wrapper vm based on (function) component options or constructors

‎packages/test-utils/types/test/wrapper.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { mount, createWrapper } from '../'
2-
import { normalOptions, functionalOptions, Normal, ClassComponent } from './resources'
2+
import { normalOptions, functionalOptions, ClassComponent } from './resources'
33
import Vue from 'vue'
44

55
/**

‎packages/test-utils/types/tsconfig.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
"module": "es2015",
55
"moduleResolution": "node",
66
"strict": true,
7-
"noEmit": true
7+
"noEmit": true,
8+
"allowSyntheticDefaultImports": true
89
},
910
"include": [
1011
"**/*.ts"

0 commit comments

Comments
 (0)