refactor: rename scopedVue and instance to createLocalVue and localVue

Author: eddyerburgh

docs/en/SUMMARY.md

@@ -2,9 +2,9 @@
 
 * [Introduction](README.md)
 * [API](api/README.md)
+  * [createLocalVue](api/createLocalVue.md)
   * [mount](api/mount.md)
   * [shallow](api/shallow.md)
-  * [scopedVue](api/scopedVue.md)
   * [Wrapper](api/wrapper/README.md)
     * [contains](api/wrapper/contains.md) 
     * [find](api/wrapper/find.md)

docs/en/api/createLocalVue.md

@@ -0,0 +1,26 @@
+# createLocalVue()
+
+- **Returns:**
+  - `{Component}`
+
+- **Usage:**
+
+createLocalVue returns a Vue class for you to add components, mixins and install plugins without polluting the global Vue class.
+
+Use it with `options.localVue`
+
+```js
+import { createLocalVue, shallow } from 'vue-test-utils'
+import { expect } from 'chai'
+import Foo from './Foo.vue'
+
+const localVue = createLocalVue()
+const wrapper = shallow(Foo, {
+  localVue,
+  intercept: { foo: true }
+})
+expect(wrapper.vm.foo).to.equal(true)
+
+const freshWrapper = shallow(Foo)
+expect(freshWrapper.vm.foo).to.equal(false)
+```

docs/en/api/mount.md

@@ -25,6 +25,8 @@
 
 `options.context` (`Object`): Passes context to functional component. Can only be used with functional components
 
+`options.localVue` ('Object): vue class to use in `mount`. See [createLocalVue](/api/createLocalVue.md)
+
 `options.slots` (`Object`): Render component with slots.
 
 `options.slots.default` (`Array[Component]|Component|String`): Default slot object to render, can be a Vue component or array of Vue components
@@ -33,9 +35,7 @@
 
 `options.globals` (`Object`): Add globals to Vue instance.
 
-`options.instance` ('Object): instance for vue-test-utils to use. See [scopedVue](/api/scopedVue.md)
-
-`options.stub` ('Object): Stubs components matchng the name passed with a string 
+`options.stub` ('Object): Stubs components matching the name passed with a string 
 
 - **Usage:**
 

docs/en/api/scopedVue.md

@@ -25,6 +25,8 @@
 
 `options.context` (`Object`): Passes context to functional component. Can only be used with functional components
 
+`options.localVue` ('Object): vue class to use in `mount`. See [createLocalVue](/api/createLocalVue.md)
+
 `options.slots` (`Object`): Render component with slots.
 
 `options.slots.default` (`Array[Component]|Component|String`): Default slot object to render, can be a Vue component or array of Vue components
@@ -33,9 +35,7 @@
 
 `options.globals` (`Object`): Add globals to Vue instance.
 
-`options.instance` ('Object): instance for vue-test-utils to use. See [scopedVue](/api/scopedVue.md)
-
-`options.stub` ('Object): Stubs components matchng the name passed with a string 
+`options.stub` ('Object): Stubs components matching the name passed with a string 
 
 - **Usage:**
 

docs/en/api/shallow.md

@@ -2,7 +2,7 @@ declare type Options = { // eslint-disable-line no-undef
     attachToDocument?: boolean,
     intercept?: Object,
     slots?: Object,
-    instance?: Component,
+    localVue?: Component,
     stub?: Object,
     context?: Object
 }

flow/options.js

@@ -3,12 +3,12 @@
 import Vue from 'vue'
 import { cloneDeep } from 'lodash'
 
-function scopedVue (): Component {
+function createLocalVue (): Component {
   const instance = Vue.extend()
   instance.version = Vue.version
   instance.config = cloneDeep(Vue.config)
   instance.util = cloneDeep(Vue.util)
   return instance
 }
 
-export default scopedVue
+export default createLocalVue

src/scoped-vue.js src/create-local-vue.js

@@ -1,9 +1,9 @@
 import shallow from './shallow'
 import mount from './mount'
-import scopedVue from './scoped-vue'
+import createLocalVue from './create-local-vue'
 
 export default {
+  createLocalVue,
   mount,
-  shallow,
-  scopedVue
+  shallow
 }

src/index.js

@@ -9,7 +9,7 @@ import { throwError } from './util'
 import { cloneDeep } from 'lodash'
 
 export default function createConstructor (component: Component, options: Options): Component {
-  const instance = options.instance || Vue
+  const vue = options.localVue || Vue
 
   if (options.context) {
     if (!component.functional) {
@@ -35,7 +35,7 @@ export default function createConstructor (component: Component, options: Option
     stubComponents(component, options.stub)
   }
 
-  const Constructor = instance.extend(component)
+  const Constructor = vue.extend(component)
 
   if (options.intercept) {
     const globals = addGlobals(options.intercept)

src/lib/create-instance.js

@@ -10,14 +10,14 @@ import mount from './mount'
 import type VueWrapper from './wrappers/vue-wrapper'
 
 export default function shallow (component: Component, options: Options = {}): VueWrapper {
-  const instance = options.instance || Vue
+  const vue = options.localVue || Vue
   const clonedComponent = cloneDeep(component)
 
   if (clonedComponent.components) {
     stubAllComponents(clonedComponent)
   }
 
-  stubGlobalComponents(clonedComponent, instance)
+  stubGlobalComponents(clonedComponent, vue)
 
   return mount(clonedComponent, options)
 }

src/shallow.js

@@ -1,13 +1,13 @@
-import scopedVue from '~src/scoped-vue'
+import createLocalVue from '~src/create-local-vue'
 import Vuex from 'vuex'
 import VueRouter from 'vue-router'
 import mount from '~src/mount'
 import Component from '~resources/components/component.vue'
 
-describe('scopedVue', () => {
+describe('createLocalVue', () => {
   it('installs Vuex without polluting global Vue', () => {
-    const instance = scopedVue()
-    instance.use(Vuex)
+    const localVue = createLocalVue()
+    localVue.use(Vuex)
     const store = new Vuex.Store({
       state: {
         test: 0
@@ -18,22 +18,22 @@ describe('scopedVue', () => {
         }
       }
     })
-    const wrapper = mount(Component, { instance, store })
+    const wrapper = mount(Component, { localVue, store })
     expect(wrapper.vm.$store).to.be.an('object')
     const freshWrapper = mount(Component)
     expect(typeof freshWrapper.vm.$store).to.equal('undefined')
   })
 
   it('installs Router without polluting global Vue', () => {
-    const instance = scopedVue()
-    instance.use(VueRouter)
+    const localVue = createLocalVue()
+    localVue.use(VueRouter)
     const routes = [
             { path: '/foo', component: Component }
     ]
     const router = new VueRouter({
       routes
     })
-    const wrapper = mount(Component, { instance, router })
+    const wrapper = mount(Component, { localVue, router })
     expect(wrapper.vm.$route).to.be.an('object')
     const freshWrapper = mount(Component)
     expect(typeof freshWrapper.vm.$route).to.equal('undefined')

test/integration/specs/scoped-vue.spec.js test/integration/specs/create-local-vue.js

@@ -2,11 +2,11 @@ import Vue from 'vue'
 import mount from '~src/mount'
 import Component from '~resources/components/component.vue'
 
-describe('mount.instance', () => {
-  it('mounts component using passed instance as base instance', () => {
-    const ScopedVue = Vue.extend()
-    ScopedVue.version = '2.3'
-    const wrapper = mount(Component, { instance: ScopedVue, intercept: { test: true }})
+describe('mount.localVue', () => {
+  it('mounts component using passed localVue as base Vue', () => {
+    const localVue = Vue.extend()
+    localVue.version = '2.3'
+    const wrapper = mount(Component, { localVue: localVue, intercept: { test: true }})
     expect(wrapper.vm.test).to.equal(true)
     const freshWrapper = mount(Component)
     expect(typeof freshWrapper.vm.test).to.equal('undefined')

test/integration/specs/mount/options/instance.spec.js

@@ -9,21 +9,21 @@ import ComponentWithNestedChildren from '~resources/components/component-with-ne
 import ComponentWithLifecycleHooks from '~resources/components/component-with-lifecycle-hooks.vue'
 
 describe('shallow', () => {
-  it('returns new VueWrapper of Vue instance if no options are passed', () => {
+  it('returns new VueWrapper of Vue localVue if no options are passed', () => {
     const compiled = compileToFunctions('<div><input /></div>')
     const wrapper = shallow(compiled)
     expect(wrapper).to.be.instanceOf(VueWrapper)
     expect(wrapper.vm).to.be.an('object')
   })
 
-  it('returns new VueWrapper of Vue instance with all children stubbed', () => {
+  it('returns new VueWrapper of Vue localVue with all children stubbed', () => {
     const wrapper = shallow(ComponentWithNestedChildren)
     expect(wrapper).to.be.instanceOf(VueWrapper)
     expect(wrapper.findAll(Component).length).to.equal(0)
     expect(wrapper.findAll(ComponentWithChildComponent).length).to.equal(1)
   })
 
-  it('returns new VueWrapper of Vue instance with all children stubbed', () => {
+  it('returns new VueWrapper of Vue localVue with all children stubbed', () => {
     const wrapper = shallow(ComponentWithNestedChildren)
     expect(wrapper).to.be.instanceOf(VueWrapper)
     expect(wrapper.findAll(Component).length).to.equal(0)
@@ -37,15 +37,15 @@ describe('shallow', () => {
     expect(mountedWrapper.findAll(Component).length).to.equal(1)
   })
 
-  it('stubs globally registered components when options.instance is provided', () => {
-    const freshVue = Vue.extend()
+  it('stubs globally registered components when options.localVue is provided', () => {
+    const localVue = Vue.extend()
     const log = sinon.stub(console, 'log')
-    freshVue.component('registered-component', ComponentWithLifecycleHooks)
+    localVue.component('registered-component', ComponentWithLifecycleHooks)
     const Component = {
       render: h => h('registered-component')
     }
-    shallow(Component, { instance: freshVue })
-    mount(Component, { instance: freshVue })
+    shallow(Component, { localVue })
+    mount(Component, { localVue })
 
     expect(log.callCount).to.equal(4)
     log.restore()