Merge pull request #1 from imcvampire/master

从fork来源处合并代码

Author: xiaofan9

.github/workflows/npm-publish.yml

@@ -0,0 +1,31 @@
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+      - run: npm ci
+      - run: npx gulp
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npx gulp
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

@@ -35,3 +35,5 @@ jspm_packages
 
 # Optional REPL history
 .node_repl_history
+
+dist/

Gulpfile.js

@@ -1,16 +1,73 @@
+// Gulp
 const gulp = require('gulp');
-const babel = require('gulp-babel');
-const uglify = require('gulp-uglifyjs');
-const rename = require('gulp-rename');
-
-gulp.task('default', () => {
-  return gulp.src('src/index.js')
-    .pipe(babel({
-      presets: ['es2015']
-    }))
-    .pipe(rename('vue-axios.es5.js'))
-    .pipe(gulp.dest('dist'))
-    .pipe(uglify())
-    .pipe(rename('vue-axios.min.js'))
-    .pipe(gulp.dest('dist'));
+const plumber = require('gulp-plumber');
+const file = require('gulp-file');
+const filter = require('gulp-filter');
+const merge = require('merge-stream');
+const sourcemaps = require('gulp-sourcemaps');
+const uglify = require('gulp-uglify');
+const clean = require('gulp-clean');
+const commonjs = require('@rollup/plugin-commonjs')
+
+// Rollup
+const { rollup } = require('rollup');
+const babel = require('rollup-plugin-babel');
+const { nodeResolve } = require('@rollup/plugin-node-resolve')
+
+// Const
+const buildPath = 'dist/';
+
+/**
+ * Generate scripts with commonjs module
+ * @param {import('rollup').RollupBuild} bundle
+ */
+function bundleCommonJs(bundle) {
+  return bundle.generate({
+    format: 'commonjs',
+  });
+}
+
+/**
+ * Bundle index.js using rollup + babel
+ */
+async function bundle() {
+  const bundle = await rollup({
+    input: 'src/index.js',
+    plugins: [
+      nodeResolve({ browser: true }),
+      commonjs(),
+      babel({
+        presets: [
+          ["@babel/env"]
+        ],
+        sourceMaps: true
+      })
+    ]
+  });
+  return bundleCommonJs(bundle);
+}
+
+gulp.task('build', async function () {
+  const generatedBundle = await bundle();
+  const f = filter(['*', '!**/*.js.map',], { restore: true });
+  const data = ['vue-axios.es5.js', 'vue-axios.min.js'];
+  const streams = data.map((name) => {
+    return file(name, generatedBundle.output.map(o => o.code).join(" "), { src: true })
+      .pipe(plumber())
+      .pipe(sourcemaps.init({ loadMaps: true }))
+      .pipe(f)
+      .pipe(uglify())
+      .pipe(sourcemaps.write('./'))
+      .pipe(gulp.dest(buildPath));
+  });
+
+  return merge(streams);
 });
+
+gulp.task('clean', function () {
+  return gulp.src('dist/*').pipe(clean({
+    force: true
+  }));
+})
+
+gulp.task('default', gulp.series('clean', 'build'))

README.md

@@ -1,21 +1,37 @@
 # vue-axios
 A small wrapper for integrating axios to Vuejs
 
+## Support matrix
+
+|VueJS \ VueAxios|1.x|2.x|3.x|
+|-|-|-|-|
+|1.x|✔|✔|✔|
+|2.x|✔|✔|✔|
+|3.x|❌|❌|✔|
+
 ## How to install:
-### CommonJS:
+### ES6 Module:
 ```bash
 npm install --save axios vue-axios
 ```
-
-And in your entry file:
+Import libraries in entry file:
 ```js
 import Vue from 'vue'
 import axios from 'axios'
 import VueAxios from 'vue-axios'
+```
 
+Usage in Vue 2:
+```js
 Vue.use(VueAxios, axios)
 ```
 
+Usage in Vue 3:
+```js
+const app = Vue.createApp(...)
+app.use(VueAxios, axios)
+```
+
 ### Script:
 Just add 3 scripts in order: `vue`, `axios` and `vue-axios` to your `document`.
 

dist/vue-axios.es5.js

@@ -1,20 +1,17 @@
-import Vue, {PluginFunction, PluginObject} from "vue";
 import { AxiosStatic } from "axios";
+import { App } from "vue";
 
-declare module "vue/types/vue" {
-
-  interface Vue {
-    axios: AxiosStatic;
+declare module "@vue/runtime-core" {
+  export interface ComponentCustomProperties {
     $http: AxiosStatic;
+    axios: AxiosStatic;
   }
 
-  interface VueConstructor {
+  export interface App {
     axios: AxiosStatic;
   }
 }
 
-declare class VueAxios {
-  static install: PluginFunction<AxiosStatic>;
-}
+declare function VueAxios(app: App, axios: AxiosStatic): void;
 
 export default VueAxios;