docs: update README.md (#588)

Author: 38elements

docs/en/README.md

@@ -17,7 +17,7 @@ Vue Test Utils is the official unit testing utility library for Vue.js.
   * [Using with Vuex](guides/using-with-vuex.md)
 * [API](api/README.md)
   * [mount](api/mount.md)
-  * [shallow](api/shallow.md)
+  * [shallowMount](api/shallowMount.md)
   * [render](api/render.md)
   * [renderToString](api/renderToString.md)
   * [Mounting Options](api/options.md)

docs/en/SUMMARY.md

@@ -13,7 +13,7 @@
   * [Using with Vuex](guides/using-with-vuex.md)
 * [API](api/README.md)
   * [mount](api/mount.md)
-  * [shallow](api/shallow.md)
+  * [shallowMount](api/shallowMount.md)
   * [render](api/render.md)
   * [renderToString](api/renderToString.md)
   * [Mounting Options](api/options.md)

docs/en/api/README.md

@@ -1,7 +1,7 @@
 # API
 
 * [mount](./mount.md)
-* [shallow](./shallow.md)
+* [shallowMount](./shallowMount.md)
 * [render](./render.md)
 * [renderToString](./renderToString.md)
 * [Mounting Options](./options.md)

docs/en/api/createLocalVue.md

@@ -10,17 +10,17 @@
 Use it with `options.localVue`:
 
 ```js
-import { createLocalVue, shallow } from '@vue/test-utils'
+import { createLocalVue, shallowMount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 
 const localVue = createLocalVue()
-const wrapper = shallow(Foo, {
+const wrapper = shallowMount(Foo, {
   localVue,
   mocks: { foo: true }
 })
 expect(wrapper.vm.foo).toBe(true)
 
-const freshWrapper = shallow(Foo)
+const freshWrapper = shallowMount(Foo)
 expect(freshWrapper.vm.foo).toBe(false)
 ```
 

docs/en/api/options.md

@@ -1,6 +1,6 @@
 # Mounting Options
 
-Options for `mount` and `shallow`. The options object can contain both Vue Test Utils mounting options and other options.
+Options for `mount` and `shallowMount`. The options object can contain both Vue Test Utils mounting options and other options.
 
 ## Vue Test Utils Specific Mounting Options
 
@@ -50,7 +50,7 @@ Example:
 import Foo from './Foo.vue'
 import Bar from './Bar.vue'
 
-const wrapper = shallow(Component, {
+const wrapper = shallowMount(Component, {
   slots: {
     default: [Foo, Bar],
     fooBar: Foo, // Will match `<slot name="FooBar" />`.
@@ -87,7 +87,7 @@ You can use [Puppeteer](https://github.com/karma-runner/karma-chrome-launcher#he
 Example:
 
 ```js
-const wrapper = shallow(Component, {
+const wrapper = shallowMount(Component, {
   scopedSlots: {
     foo: '<p slot-scope="props">{{props.index}},{{props.text}}</p>'
   }
@@ -110,7 +110,7 @@ mount(Component, {
   stubs: ['registered-component']
 })
 
-shallow(Component, {
+shallowMount(Component, {
   stubs: {
     // stub with a specific implementation
     'registered-component': Foo,
@@ -130,7 +130,7 @@ Example:
 
 ```js
 const $route = { path: 'http://www.example-path.com' }
-const wrapper = shallow(Component, {
+const wrapper = shallowMount(Component, {
   mocks: {
     $route
   }
@@ -206,7 +206,7 @@ When `sync` is `false`, the Vue component is rendered asynchronously.
 
 ## Other options
 
-When the options for `mount` and `shallow` contain the options other than the mounting options, the component options are overwritten with those using [extends](https://vuejs.org/v2/api/#extends).
+When the options for `mount` and `shallowMount` contain the options other than the mounting options, the component options are overwritten with those using [extends](https://vuejs.org/v2/api/#extends).
 
 ```js
 const Component = {

docs/en/api/selectors.md

@@ -32,10 +32,10 @@ export default {
 ```
 
 ```js
-import { shallow } from '@vue/test-utils'
+import { shallowMount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 
-const wrapper = shallow(Foo)
+const wrapper = shallowMount(Foo)
 expect(wrapper.is(Foo)).toBe(true)
 ```
 

docs/en/api/shallow.md renamed to docs/en/api/shallowMount.md

@@ -1,4 +1,4 @@
-# `shallow(component [, options])`
+# `shallowMount(component [, options])`
 
 - **Arguments:**
 
@@ -27,12 +27,12 @@ Like [`mount`](mount.md), it creates a [`Wrapper`](wrapper/README.md) that conta
 **Without options:**
 
 ```js
-import { shallow } from '@vue/test-utils'
+import { shallowMount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
   it('renders a div', () => {
-    const wrapper = shallow(Foo)
+    const wrapper = shallowMount(Foo)
     expect(wrapper.contains('div')).toBe(true)
   })
 })
@@ -41,12 +41,12 @@ describe('Foo', () => {
 **With Vue options:**
 
 ```js
-import { shallow } from '@vue/test-utils'
+import { shallowMount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
   it('renders a div', () => {
-    const wrapper = shallow(Foo, {
+    const wrapper = shallowMount(Foo, {
       propsData: {
         color: 'red'
       }
@@ -59,12 +59,12 @@ describe('Foo', () => {
 **Attach to DOM:**
 
 ```js
-import { shallow } from '@vue/test-utils'
+import { shallowMount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
   it('renders a div', () => {
-    const wrapper = shallow(Foo, {
+    const wrapper = shallowMount(Foo, {
       attachToDocument: true
     })
     expect(wrapper.contains('div')).toBe(true)
@@ -75,14 +75,14 @@ describe('Foo', () => {
 **Default and named slots:**
 
 ```js
-import { shallow } from '@vue/test-utils'
+import { shallowMount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 import Bar from './Bar.vue'
 import FooBar from './FooBar.vue'
 
 describe('Foo', () => {
   it('renders a div', () => {
-    const wrapper = shallow(Foo, {
+    const wrapper = shallowMount(Foo, {
       slots: {
         default: [Bar, FooBar],
         fooBar: FooBar, // Will match <slot name="FooBar" />,
@@ -97,13 +97,13 @@ describe('Foo', () => {
 **Stubbing global properties:**
 
 ```js
-import { shallow } from '@vue/test-utils'
+import { shallowMount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 
 describe('Foo', () => {
   it('renders a div', () => {
     const $route = { path: 'http://www.example-path.com' }
-    const wrapper = shallow(Foo, {
+    const wrapper = shallowMount(Foo, {
       mocks: {
         $route
       }

docs/en/api/wrapper-array/at.md

@@ -10,10 +10,10 @@ Returns `Wrapper` at `index` passed. Uses zero based numbering (i.e. first item
 - **Example:**
 
 ```js
-import { shallow } from '@vue/test-utils'
+import { shallowMount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 
-const wrapper = shallow(Foo)
+const wrapper = shallowMount(Foo)
 const divArray = wrapper.findAll('div')
 const secondDiv = divArray.at(1)
 expect(secondDiv.is('p')).toBe(true)

docs/en/api/wrapper-array/contains.md

@@ -12,11 +12,11 @@ Use any valid [selector](../selectors.md).
 - **Example:**
 
 ```js
-import { shallow } from '@vue/test-utils'
+import { shallowMount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 import Bar from './Bar.vue'
 
-const wrapper = shallow(Foo)
+const wrapper = shallowMount(Foo)
 const divArray = wrapper.findAll('div')
 expect(divArray.contains('p')).toBe(true)
 expect(divArray.contains(Bar)).toBe(true)

docs/en/api/wrapper-array/filter.md

@@ -14,9 +14,9 @@ A new `WrapperArray` instance containing `Wrapper` instances that returns true f
 - **Example:**
 
 ```js
-import { shallow } from '@vue/test-utils'
+import { shallowMount } from '@vue/test-utils'
 import Foo from './Foo.vue'
 
-const wrapper = shallow(Foo)
+const wrapper = shallowMount(Foo)
 const filteredDivArray = wrapper.findAll('div').filter(w => !w.hasClass('filtered'))
 ```