vue 外掛開發教程與釋出

前言

對於外掛的好處就不用多說了~~~~

看了vue官方的vue外掛開發的文件，講的比較粗略，看完一頭霧水的，所以決定自己研究開發了一個元件，並寫成一個教程。

就拿基於vue的一個toast元件開始吧

專案初始化 封裝vue的外掛用webpack-simple很合適，vue init webpack-simple project-name此命令建立我們的專案的目錄，建立資料夾和檔案，最後結構是這樣的

lib目錄是我們的外掛目錄，其他的預設就好

toast.vue的內容如下：

<template>
  <div class="vue-toast-wraper" v-show="isSHowToast" style="display:none">
        {{toastMsg}}
  </div>
</template>
<script>
export default {
  name:'toast',
  props:{
     toastMsg:{
         default:"",
         type:String
     },
     isSHowToast:{
       default:false,
       type:Boolean
     } 
  },
  mounted(){
    if(this.isSHowToast){
      setTimeout(() => {
        this.isSHowToast=false
      },2500);
    }
  }
}
</script>
<style scoped>
.vue-toast-wraper{
    background: rgba(0, 0, 0, 0.6);
    color: #fff;
    font-size: 17px;
    padding: 10px;
    border-radius:12px; 
    display: -webkit-box;
    -webkit-box-pack: center;
    -webkit-box-align: center;
    position: fixed;
    top: 50%;
    left: 50%;
    z-index: 2000;
    -webkit-transform: translateY(-50%);
    transform: translateY(-50%);
    -webkit-transform: translateX(-50%);
    transform: translateX(-50%);
}
</style>




toast.js中寫install方法，內容如下：


import VueToastPlugin from './toast.vue'
const toastPlugin = {
  install: function(Vue) {
    Vue.component(VueToastPlugin.name, VueToastPlugin)
  }
}
// global 情況下 自動安裝
if (typeof window !== 'undefined' && window.Vue) { 
    window.Vue.use(toastPlugin) 
}
// 匯出模組
export default toastPlugin


我們在webpack配置的入口檔案就是toast.js，install是掛載元件的方法，有了它我們就可以在外部use一個外掛了。 

接下來就是修改配置檔案，為打包釋出做準備


修改配置項
修改package.json
{
  "name": "vue-toast-plugin-catbea",
  "description": "A Vue.js project",
  "version": "1.0.1",
  "author": "catbea<xxxxx@qq.com>",
  "main": "dist/toast.js",
  "license": "MIT",
  "private": false,
  "scripts": {
    "dev": "cross-env NODE_ENV=development webpack-dev-server --open --hot",
    "build": "cross-env NODE_ENV=production webpack --progress --hide-modules"
  },
  "dependencies": {
    "vue": "^2.5.11"
  },
  "browserslist": [
    "> 1%",
    "last 2 versions",
    "not ie <= 8"
  ],
  "keywords": [
    "vue",
    "toast"
  ],
  "repository": {
    "type": "git",
    "url": "git+https://github.com/linmoer/catbea/vue-toast.git"
  },
  "homepage": "https://github.com/catbea/vue-toast/new/master?readme=1",
  "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",
    "vue-loader": "^13.0.5",
    "vue-template-compiler": "^2.4.4",
    "webpack": "^3.6.0",
    "webpack-dev-server": "^2.9.1"
  }
}
複製程式碼

修改webpack.config.js

var webpack = require('webpack')

module.exports = {
  // entry: './src/main.js',
  entry: './src/lib/toast.js',
  output: {
    path: path.resolve(__dirname, './dist'),
    publicPath: '/dist/',
    filename: 'toast.js',
    library: 'vueToast',
    libraryTarget: 'umd',
    umdNamedDefine: true 
  },
  module: {
    rules: [
      {
        test: /\.css$/,
        use: [
          'vue-style-loader',
          'css-loader'
        ],
      },      {
        test: /\.vue$/,
        loader: 'vue-loader',
        options: {
          loaders: {
          }
          // 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]'
        }
      }
    ]
  },
  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
    })
  ])
}

修改.gitignore 檔案
因為要用dist資料夾，所以在.gitignore檔案中把dist/去掉。

修改index.html


打包專案：

npm run build 


釋出到NPM
在 npm官網 註冊一個npm賬號
切換到需要發包的專案根目錄下，npm adduser 輸入npm賬號，輸入使用者名稱、密碼、郵箱
最後一步，執行npm publish即可
釋出到NPM後，使用外掛時可以用npm install 元件名稱 來安裝

這裡我封裝了一個toast元件toast，可以在檢視 https://github.com/catbea/vue-toast  檢視

覺得可以，小哥哥小姐姐  歡迎star  ——


複製程式碼