手把手教你寫vue插件並發布（一）

本文轉載自查看原文 2018-06-21 21:18 25733 vue插件開發/ vueJs/ vue.install

vue的插件開發

這篇文章較長，需要一定的閱讀時間。這里有一份改善版本的插件筆記，在一個項目下完成開發、測試、發布的全過程。https://www.cnblogs.com/adouwt/p/9655594.html

--2019年1月15日更新。

反映問題：

執行 npm publish 報錯，因為有些同學本地設置了淘寶的npm 鏡像源，npm 包發布到這個鏡像源就有問題了，最簡單的方式是：發布時候指定地址

npm publish -registry=https://registry.npmjs.org/

--2019年4月3號更新　

1.本地開發

　　1.1 初始化本地開發項目

　　　　我們采用vue-cli，初始化一個vue 項目。這個不做詳解，請移步到這里 https://www.cnblogs.com/anxiaoyu/p/7071143.html，查看具體詳細。初始化后就是這樣的項目結構：

　　　　其他的文件目錄不是本節內容重點，不做詳解，請移步這里查看 https://blog.csdn.net/tanzhenyan/article/details/78871610。

　　1.2 test.js 的內容，這是插件的入口文件

　　關於為什么需要在install這個方法這里添加我們的方法，可以參考官網。https://cn.vuejs.org/v2/guide/plugins.html 這里只是用了其中的一部分的內容。

　　test.js的代碼如下：

import testPanel from './panel.vue'
import testToast from './toast.vue'
let test = {}
test.install = function (Vue, options) {
  Vue.prototype.$msg = 'Hello I am test.js'
  Vue.prototype.$myMethod = function (arr) {
    if (arr.length < 0) {
      return false
    } else {
      arr = arr.join('連接你我')
      return arr
    }
  }
  Vue.component(testPanel.name, testPanel) // testPanel.name 組件的name屬性
  Vue.component(testToast.name, testToast) // testPanel.name 組件的name屬性
}
export default test

　　test.js 里面引入的兩個vue 文件，這兩個文件就是我們需要開發的組件樣式。

　　panel.vue

<template>
  <div>
    <div class="number-panel">
      <p v-show="checkedNumber.length>0" class="number-show">{{checkedNumber}}</p>
      <p v-show="!checkedNumber" class="number-show">  </p>
      <ul>
        <li @click="clickThisNumber($event)" v-for="index in 9" :key="index">{{index}}</li>
        <li @click="clickThisNumber($event)">0</li>
      </ul>
    </div>
  </div>
</template>

<script>
export default {
  name: 'test-panel', // 這里需要注意下，我們是采用的全局注入我們的組件，所以在后面因為我們的組件后，會直接使用這個命名的標簽
  data () {
    return {
      checkedNumber: ''
    }
  },
  components: {
  },
  methods: {
    clickThisNumber (e) {
      this.checkedNumber = this.checkedNumber.concat(e.currentTarget.innerHTML)
    }
  }
}
</script>

<style>
  .number-show {
    height: 20px;
  }
  .number-panel ul {
    padding: 0;
  }
  .number-panel ul li{
    display: inline-block;
    width: 28%;
    height: 50px;
    line-height: 50px;
    margin-top: 20px;
    background: #ddd;
    border-radius: 8px;
    margin-right: 10px;
  }
  .number-panel ul li input {
    display: none;
  }
</style>

　實現的效果如下：

點擊面板上的數字，及時展現在上面，具體的樣式不做詳解，邏輯很簡單。

　　toast.vue

<template>
  <div>
    <div class="toast"  ref='toastPosition' :class="{active: toastHidden}">
      <div class="toast-warpper">
         {{text}}
      </div>
    </div>
  </div>
</template>

<script>
export default {
  name: 'test-toast',
  data () {
    return {
      text: '',
      toastHidden: false
    }
  },
  created () {
    // this.toastPlugin()
  },
  components: {
  },
  methods: {
    toastPlugin (msg, time) {
      this.text = msg
      this.toastHidden = true
      setTimeout(() => {
        this.toastHidden = false
      }, time)
    }
  }
}
</script>

<style>
  .toast {
    position: absolute;
    left: 50%;
    top: 50%;
    transform: translate(-50%, -50%);
    width: 0px;
    min-height: 0px;
    text-align: center;
    background: rgba(0, 0, 0, 0.5);
    border-radius: 5px;
    color: #fff;
    transition: all 0.5s;
    z-index: -1;
    opacity: 0;
  }
  .toast.active {
    width: 150px;
    min-height: 25px;
    opacity: 1;
    z-index: 11;
  }
</style>

　　效果如下：

這里模擬的是，調用該插件的toast 方法。

2.本地測試

　　我們上面就直接給出了我們要完成的內容，但是怎么確定我們這個寫的樣式或者方法可以用呢？所以需要測試下，我們到底寫的是個什么鬼。

　　main.js 全局import

　　具體頁面使用我們的插件：

　　兩個效果如下：

3.打包到npm

　　測試完成，可以實現我們的想要的內容。下面我們就要把我們的內容打包發布到npm 上去。

　　為了不和開發的項目環境發生沖突，我們采用另外一個項目，專門做打包發布的。

　　工具：

　　　　webpack-simple 這個簡化版的webpack。初始化項目，點擊這里, https://www.cnblogs.com/majj/p/9054471.html。刪掉我們不需要的文件夾，新建一個我們要放置我們開發代碼，完成如下：

　　修改webpack.config.js的打包名稱

　　代碼如下：

var path = require('path')
var webpack = require('webpack')

module.exports = {
  entry: './src/lib/index.js',
  output: {
    path: path.resolve(__dirname, './dist'),
    publicPath: '/dist/',
    filename: 'toastPanel.js',
    library: 'toastPanel', // library指定的就是你使用require時的模塊名，這里便是require("toastPanel")
    libraryTarget: 'umd', //libraryTarget會生成不同umd的代碼,可以只是commonjs標准的，也可以是指amd標准的，也可以只是通過script標簽引入的。
    umdNamedDefine: true // 會對 UMD 的構建過程中的 AMD 模塊進行命名。否則就使用匿名的 define。
  },
  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
    })
  ])
}