[Vue] Write a Vue plugin and publish it to NPM

Register an NPM account

• https://www.npmjs.com/

---

Initialize the Vue plugin project

# 安装vue cli
# 初始化插件项目
vue init webpack-simple v-dplayer

• index.js: the entry file for the plugin
• v-dplayer.vue: the vue component of the plugin

---

Vue components for writing plugins

• v-dplayer.vue

<template>
    <div id="dplayer"></div>
</template>
<script>
import DPlayer from 'DPlayer'
export default {
  name: 'VDplayer',
  props: {
    options: {
      type: Object,
      default: {}
    }
  },
  data() {
    return {
      dp: null
    }
  },
  methods: {
  },
  mounted() {
    this.options.container = document.getElementById('dplayer')
    const player = this.dp = new DPlayer(this.options)
    const events = player.events
    Object.keys(events).forEach(item => {
      if (item === 'events') {
        return false
      } else {
        events[item].forEach(event => {
          player.on(event, () => this.$emit(event))
        })
      }
    })
  }
}
</script>
<style scoped>
  @import url("../../node_modules/dplayer/dist/DPlayer.min.css");
</style>

---

Write the entry file of the plugin

• index.js

import VDplayer from './v-dplayer.vue'
import '../../node_modules/dplayer/dist/DPlayer.min.css'

VDplayer.install = function(Vue) {
    Vue.component('VDplayer', VDplayer)
}

if (typeof window !== 'undefined' && window.Vue) {
    window.Vue.use(VDplayer)
}

export default VDplayer

---

configure webpack.config.js

• webpack.config.js

var path = require('path')
var webpack = require('webpack')
var ExtractTextPlugin = require("extract-text-webpack-plugin")

module.exports = {
  entry: './src/assets/index.js',
  output: {
    path: path.resolve(__dirname, './dist'),
    publicPath: '/dist/',
    filename: 'v-dplayer.js',
    library: 'v-dplayer',
    libraryTarget: 'umd',
    umdNamedDefine: true
  },
  module: {
    rules: [
      {
        test: /\.css$/,
        use: [
          'vue-style-loader',
          'css-loader'
        ],
      },
      {
        test: /\.scss$/,
        use: [
          'vue-style-loader',
          'css-loader',
          'sass-loader'
        ],
      },
      {
        test: /\.sass$/,
        use: [
          'vue-style-loader',
          'css-loader',
          'sass-loader?indentedSyntax'
        ],
      },
      {
        test: /\.vue$/,
        loader: 'vue-loader',
        options: {
          extractCSS: true
          // other vue-loader options go here
        }
      },
      {
        test: /\.js$/,
        loader: 'babel-loader',
        exclude: /node_modules/
      },
      {
        test: /\.(png|jpg|gif|svg)$/,
        loader: 'file-loader',
        options: {
          name: '[name].[ext]?[hash]'
        }
      }
    ]
  },
  plugins: [
    new ExtractTextPlugin("style.css")
  ],
  resolve: {
    alias: {
      'vue$': 'vue/dist/vue.esm.js'
    },
    extensions: ['*', '.js', '.vue', '.json']
  },
  devServer: {
    historyApiFallback: true,
    noInfo: true,
    overlay: true
  },
  performance: {
    hints: false
  },
  devtool: '#eval-source-map'
}

if (process.env.NODE_ENV === 'production') {
  module.exports.devtool = '#source-map'
  // http://vue-loader.vuejs.org/en/workflow/production.html
  module.exports.plugins = (module.exports.plugins || []).concat([
    new webpack.DefinePlugin({
      'process.env': {
        NODE_ENV: '"production"'
      }
    }),
    new webpack.optimize.UglifyJsPlugin({
      sourceMap: true,
      compress: {
        warnings: false
      }
    }),
    new webpack.LoaderOptionsPlugin({
      minimize: true
    })
  ])
}

Build project

npm run build

---

configure package.json

• package.json

{
  "name": "v-dplayer",
  "description": "A Plugin For Vue2 Based On Dplayer",
  "version": "1.0.7",
  "author": "ns2250225 <[email protected]>",
  "keywords": [
    "Vue2",
    "Dplayer"
  ],
  "main": "dist/v-dplayer.js",
  "license": "MIT",
  "private": false,
  "repository": {
    "type": "git",
    "url": "https://github.com/ns2250225/v-dplayer"
  },
  "scripts": {
    "dev": "cross-env NODE_ENV=development webpack-dev-server --open --hot",
    "build": "cross-env NODE_ENV=production webpack --progress --hide-modules"
  },
  "dependencies": {
    "dplayer": "^1.22.2",
    "extract-text-webpack-plugin": "^3.0.2",
    "vue": "^2.5.11"
  },
  "browserslist": [
    "> 1%",
    "last 2 versions",
    "not ie <= 8"
  ],
  "devDependencies": {
    "babel-core": "^6.26.0",
    "babel-loader": "^7.1.2",
    "babel-preset-env": "^1.6.0",
    "babel-preset-stage-3": "^6.24.1",
    "cross-env": "^5.0.5",
    "css-loader": "^0.28.7",
    "file-loader": "^1.1.4",
    "node-sass": "^4.5.3",
    "sass-loader": "^6.0.6",
    "vue-loader": "^13.0.5",
    "vue-template-compiler": "^2.4.4",
    "webpack": "^3.6.0",
    "webpack-dev-server": "^2.9.1"
  }
}

---

Publish to NPM

• Login to npm:npm login
• release:npm publish

---

Github address

• https://github.com/ns2250225/v-dplayer