feat: add Vue2 export and deprecate Vue

Author: Justineo

.github/test.js

@@ -1,6 +1,6 @@
 const fs = require('fs')
 const { join } = require('path')
-const { execSync, exec } = require('child_process')
+const { execSync } = require('child_process')
 
 const DIR = '../vue-demi-test'
 
@@ -24,9 +24,16 @@ if (!cjs.includes(`exports.isVue2 = ${isVue2}`)) {
   process.exit(1)
 } 
 
-const value = execSync('node -e "console.log(require(\'vue-demi\').isVue2)"', { cwd: DIR }).toString().trim()
+const isVue2 = execSync('node -e "console.log(require(\'vue-demi\').isVue2)"', { cwd: DIR }).toString().trim()
 
-if (value !== `${isVue2}`) {
-  console.log("eval", value)
+if (isVue2 !== `${isVue2}`) {
+  console.log("isVue2", isVue2)
+  process.exit(1)
+}
+
+const hasVue2 = execSync('node -e "console.log(require(\'vue-demi\').Vue2 !== undefined)"', { cwd: DIR }).toString().trim()
+
+if (hasVue2 !== `${isVue2}`) {
+  console.log("hasVue2", hasVue2)
   process.exit(1)
 }

README.md

@@ -61,15 +61,26 @@ if (isVue2) {
 }
 ```
 
+### `Vue2`
+
+To avoid bringing in all the tree-shakable modules, we provide a `Vue2` export to support access to Vue 2's global API. (See [#41](https://github.com/vueuse/vue-demi/issues/41).)
+
+```ts
+import { Vue2 } from 'vue-demi'
+
+if (Vue2) {
+  Vue2.config.ignoredElements.push('x-foo')
+}
+```
+
 ### `install()`
 
 Composition API in Vue 2 is provided as a plugin and need to install to Vue instance before using. Normally, `vue-demi` will try to install it automatically. For some usages that you might need to ensure the plugin get installed correctly, the `install()` API is exposed to as a safe version of `Vue.use(CompositionAPI)`. `install()` in Vue 3 environment will be an empty function (no-op).
 
 ```ts
-import Vue from 'vue'
-import { install } from 'vue-demi'
+import { Vue2, install } from 'vue-demi'
 
-install(Vue)
+install(Vue2)
 ```
 
 ## CLI
@@ -101,10 +112,12 @@ import * as Vue from 'vue3'
 
 var isVue2 = false
 var isVue3 = true
+var Vue2 = undefined
 
 export * from 'vue3'
 export {
   Vue,
+  Vue2,
   isVue2,
   isVue3,
 }

lib/index.iife.js

@@ -15,6 +15,7 @@
         VueDemi.isVue3 = false
         VueDemi.install = function (){}
         VueDemi.Vue = Vue
+        VueDemi.Vue2 = Vue
         VueDemi.version = Vue.version
       } else {
         console.error(
@@ -29,6 +30,7 @@
       VueDemi.isVue3 = true
       VueDemi.install = function (){}
       VueDemi.Vue = Vue
+      VueDemi.Vue2 = undefined
       VueDemi.version = Vue.version
       VueDemi.set = function(target, key, val) {
         if (Array.isArray(target)) {

lib/v2/index.cjs.js

@@ -18,6 +18,7 @@ Object.keys(VueCompositionAPI).forEach(function(key) {
 })
 
 exports.Vue = Vue
+exports.Vue2 = Vue
 exports.isVue2 = true
 exports.isVue3 = false
 exports.install = install

lib/v2/index.d.ts

@@ -1,12 +1,16 @@
 import Vue from 'vue'
 declare const isVue2: boolean
 declare const isVue3: boolean
+declare const Vue2: Vue
 declare const version: string
 declare const install: (vue?: Vue) => void
+/** @deprecated */
+declare const V: Vue
 
 export * from '@vue/composition-api'
 export {
-  Vue,
+  V as Vue,
+  Vue2,
   isVue2,
   isVue3,
   version,

lib/v2/index.esm.js

@@ -11,6 +11,7 @@ install(Vue)
 
 var isVue2 = true
 var isVue3 = false
+var Vue2 = Vue
 var version = Vue.version
 
 /**VCA-EXPORTS**/
@@ -19,6 +20,7 @@ export * from '@vue/composition-api'
 
 export {
   Vue,
+  Vue2,
   isVue2,
   isVue3,
   version,

lib/v3/index.cjs.js

@@ -23,6 +23,7 @@ exports.del = function(target, key) {
 }
 
 exports.Vue = Vue
+exports.Vue2 = undefined
 exports.isVue2 = false
 exports.isVue3 = true
 exports.install = function(){}

lib/v3/index.d.ts

@@ -1,14 +1,18 @@
 import * as Vue from 'vue'
 declare const isVue2: boolean
 declare const isVue3: boolean
+declare const Vue2: any
 declare const install: (vue?: any) => void
+/** @deprecated */
+declare const V: Vue
 
 export function set<T>(target: any, key: any, val: T): T
 export function del(target: any, key: any)
 
 export * from 'vue'
 export {
-  Vue,
+  V as Vue,
+  Vue2,
   isVue2,
   isVue3,
   install,

lib/v3/index.esm.js

@@ -2,6 +2,7 @@ import * as Vue from 'vue'
 
 var isVue2 = false
 var isVue3 = true
+var Vue2 = undefined
 
 function install() {}
 
@@ -26,6 +27,7 @@ export function del(target, key) {
 export * from 'vue'
 export {
   Vue,
+  Vue2,
   isVue2,
   isVue3,
   install,