Skip to content

docs: update docs (fix #873) #874

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 29, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions docs/api/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ When passing `stubs` as an array in the mounting options, `config.stubs` are con
Example:

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

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

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

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

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

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

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

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

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

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

VueTestUtils.config.logModifiedComponents = false
config.logModifiedComponents = false
```

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

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

VueTestUtils.config.silent = false
config.silent = false
```
8 changes: 4 additions & 4 deletions docs/ja/api/components/TransitionGroupStub.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@
デフォルトではすべての `transition-group` コンポーネントは `TransitionGroupStub` でスタブされます。これは `vue-test-utils` の `config` で設定されています。スタブせずに既存の `transition-group` コンポーネントを使用したい場合は、 `config.stubs['transition-group']` に `false` をセットします。:

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

VueTestUtils.config.stubs['transition-group'] = false
config.stubs['transition-group'] = false
```

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

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

VueTestUtils.config.stubs['transition-group'] = TransitionGroupStub
config.stubs['transition-group'] = TransitionGroupStub
```

マウンティングオプションでスタブとしてセットするには以下のようにします。
Expand Down
24 changes: 12 additions & 12 deletions docs/ja/api/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ vue-test-utils にはオプションを定義するための `config` オプシ
例:

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

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

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

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

VueTestUtils.config.mocks['$store'] = {
config.mocks['$store'] = {
state: {
id: 1
}
Expand All @@ -53,9 +53,9 @@ VueTestUtils.config.mocks['$store'] = {
例:

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

VueTestUtils.config.methods['errors'] = () => {
config.methods['errors'] = () => {
any: () => false
}
```
Expand All @@ -70,9 +70,9 @@ VueTestUtils.config.methods['errors'] = () => {
例:

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

VueTestUtils.config.provide['$logger'] = {
config.provide['$logger'] = {
log: (...args) => {
console.log(...args)
}
Expand All @@ -89,9 +89,9 @@ VueTestUtils.config.provide['$logger'] = {
例:

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

VueTestUtils.config.logModifiedComponents = false
config.logModifiedComponents = false
```

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

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

VueTestUtils.config.silent = false
config.silent = false
```
24 changes: 12 additions & 12 deletions docs/ru/api/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ Vue Test Utils включает объект конфигурации для о
Пример:

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

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

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

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

VueTestUtils.config.mocks['$store'] = {
config.mocks['$store'] = {
state: {
id: 1
}
Expand All @@ -54,9 +54,9 @@ VueTestUtils.config.mocks['$store'] = {
Пример:

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

VueTestUtils.config.methods['errors'] = () => {
config.methods['errors'] = () => {
any: () => false
}
```
Expand All @@ -71,9 +71,9 @@ VueTestUtils.config.methods['errors'] = () => {
Пример:

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

VueTestUtils.config.provide['$logger'] = {
config.provide['$logger'] = {
log: (...args) => {
console.log(...args)
}
Expand All @@ -90,9 +90,9 @@ VueTestUtils.config.provide['$logger'] = {
Пример:

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

VueTestUtils.config.logModifiedComponents = false
config.logModifiedComponents = false
```

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

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

VueTestUtils.config.silent = false
config.silent = false
```
24 changes: 12 additions & 12 deletions docs/zh/api/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ Vue Test Utils 包含了一个定义其选项的配置对象。
示例:

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

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

### `mocks`
Expand All @@ -35,9 +35,9 @@ VueTestUtils.config.stubs['my-component'] = '<div />'
示例:

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

VueTestUtils.config.mocks['$store'] = {
config.mocks['$store'] = {
state: {
id: 1
}
Expand All @@ -54,9 +54,9 @@ VueTestUtils.config.mocks['$store'] = {
示例:

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

VueTestUtils.config.methods['errors'] = () => {
config.methods['errors'] = () => {
any: () => false
}
```
Expand All @@ -71,9 +71,9 @@ VueTestUtils.config.methods['errors'] = () => {
示例:

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

VueTestUtils.config.provide['$logger'] = {
config.provide['$logger'] = {
log: (...args) => {
console.log(...args)
}
Expand All @@ -90,9 +90,9 @@ VueTestUtils.config.provide['$logger'] = {
示例:

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

VueTestUtils.config.logModifiedComponents = false
config.logModifiedComponents = false
```

### `silent`
Expand All @@ -105,7 +105,7 @@ VueTestUtils.config.logModifiedComponents = false
示例;

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

VueTestUtils.config.silent = false
config.silent = false
```
7 changes: 5 additions & 2 deletions packages/test-utils/types/test/mount.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import Vuex from 'vuex'
import { mount, createLocalVue, config } from '../'
import { normalOptions, functionalOptions, Normal, ClassComponent } from './resources'
import VueTestUtils, { mount, createLocalVue, config } from '../'
import { normalOptions, functionalOptions, ClassComponent } from './resources'

/**
* Should create wrapper vm based on (function) component options or constructors
Expand Down Expand Up @@ -94,3 +94,6 @@ config.provide = {
}
config.logModifiedComponents = true
config.silent = true

// Check we can use default export
VueTestUtils.config.silent = false
2 changes: 1 addition & 1 deletion packages/test-utils/types/test/shallow.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import Vuex from 'vuex'
import { shallowMount, createLocalVue } from '../'
import { normalOptions, functionalOptions, Normal, ClassComponent } from './resources'
import { normalOptions, functionalOptions, ClassComponent } from './resources'

/**
* Should create wrapper vm based on (function) component options or constructors
Expand Down
2 changes: 1 addition & 1 deletion packages/test-utils/types/test/wrapper.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { mount, createWrapper } from '../'
import { normalOptions, functionalOptions, Normal, ClassComponent } from './resources'
import { normalOptions, functionalOptions, ClassComponent } from './resources'
import Vue from 'vue'

/**
Expand Down
3 changes: 2 additions & 1 deletion packages/test-utils/types/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"module": "es2015",
"moduleResolution": "node",
"strict": true,
"noEmit": true
"noEmit": true,
"allowSyntheticDefaultImports": true
},
"include": [
"**/*.ts"
Expand Down