npm插件開發-Vue插件

1、初始化項目

vue init webpack-simple npm-vue-ui

2、修改入口文件

{
  "name": "npm-vue-ui",
  "description": "npm插件庫",
  "version": "1.0.5",
  "author": "gengbigbing",
  "license": "MIT",
  "private": false,         // 插件的話，需要設置爲false
  "main": "dist/build.js",  // 修改這個入口文件
  "scripts": {
    "dev": "cross-env NODE_ENV=development webpack-dev-server --open --hot",
    "build": "cross-env NODE_ENV=production webpack --progress --hide-modules"
  },
  "dependencies": {
    "npm-vue-ui": "^1.0.5",
    "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",
    "less": "^3.11.1",
    "less-loader": "^5.0.0",
    "vue-loader": "^13.0.5",
    "vue-template-compiler": "^2.4.4",
    "webpack": "^3.6.0",
    "webpack-dev-server": "^2.9.1"
  }
}

3、修改webpack（主要打包）

const path = require('path')
const webpack = require('webpack')
const NODE_ENV = process.env.NODE_ENV

module.exports = {
  entry: NODE_ENV == 'development' ? './src/main.js' : './src/lib/index.js',
  output: {
    path: path.resolve(__dirname, './dist'),
    publicPath: '/dist/',
    filename: 'build.js',
    library: 'build', // 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: false,
      compress: {
        warnings: false
      }
    }),
    new webpack.LoaderOptionsPlugin({
      minimize: false
    })
  ])
}

4、src文件夾下新建lib放置插件源碼

①lib文件包含index.js文件（拋出需要的方法）

import backToTop from './backToTop.vue'

const toTop = {
     install: function (Vue) {
         Vue.component(backToTop.name, backToTop)
     }
}
// global 情況下 自動安裝
 if (typeof window !== 'undefined' && window.Vue) {
     window.Vue.use(toTop)
 }

export default toTop 

②backToTop.vue（自己開發的插件）

<template>
  <div class="backToTop" :style="'z-index: ' + zIndex" @click="backToTop" v-show="bVisible">
    <div class="icon"></div>
  </div>
</template>

<script>
export default {
  name: "back-to-top",
  props: {
    zIndex: {
      type: Number,
      default: 9999
    },
    triggerHeight: {
      type: Number
    },
    smooth: {
      type: Boolean,
      default: true
    },
    scrollInterval: {
      type: Number,
      default: 10
    },
    scrollHeight: {
      type: Number,
      default: 100
    }
  },
  data() {
    return {
      interval: null, // 計時器
      bVisible: false // 按鈕顯示狀態
    };
  },
  methods: {
    resetToTop() {
      window.pageYOffset = 0;
      document.documentElement.scrollTop = 0;
      document.body.scrollTop = 0;
    },
    buttonStatus() {
      var currentHeight =
        window.pageYOffset ||
        document.documentElement.scrollTop ||
        document.body.scrollTop;
      let browserHeight = this.triggerHeight || window.outerHeight / 4;
      this.bVisible = currentHeight > browserHeight;
    },
    backToTop() {
      if (this.smooth) {
        var that = this,
          _interval = this.scrollInterval,
          _height = this.scrollHeight;
        // 間隔{_interval}移動{_height}
        this.interval = setInterval(function() {
          that.smoothScroll(_height);
        }, _interval);
      } else {
        this.resetToTop();
      }
    },
    smoothScroll(y) {
      if (window.pageYOffset > 0) {
        window.pageYOffset = window.pageYOffset - y;
      }
      if (document.documentElement.scrollTop > 0) {
        document.documentElement.scrollTop =
          document.documentElement.scrollTop - y;
      }
      if (document.body.scrollTop > 0) {
        document.body.scrollTop = document.body.scrollTop - y;
      }
      var positionNow =
        window.pageYOffset ||
        document.documentElement.scrollTop ||
        document.body.scrollTop;
      if (positionNow <= 0) {
        clearInterval(this.interval);
        // 清除計時器後，全部重置爲零，預防回滾爲負數時，不再顯示的bug
        this.resetToTop();
      }
    }
  },
  created() {
    window.addEventListener("scroll", this.buttonStatus);
  },
  destroyed() {
    window.removeEventListener("scroll", this.buttonStatus);
  }
};
</script>

<style lang="less" scoped>
.backToTop {
  position: fixed;
  right: 100px;
  bottom: 50px;
  width: 40px;
  height: 40px;
  size: 40px;
  border-radius: 20px;
  cursor: pointer;
  transition: 0.3s;
  box-shadow: 0 0 6px rgba(0, 0, 0, 0.12);
  background-color: #fff;
  overflow: hidden;
  .icon {
    position: absolute;
    margin: auto;
    left: 0;
    top: -8px;
    bottom: 0;
    right: 0;
    width: 0;
    height: 0;
    border-width: 8px;
    border-style: solid;
    border-color: transparent #0099cc transparent transparent;
    transform: rotate(90deg); /*順時針旋轉90°*/
  }
}
.backToTop:hover {
  box-shadow: 0 0 20px #000;
}
</style>

5、上傳npm庫

// 登錄npm
npm login

// 推送插件到npm庫
npm publish

6、錯誤解決方法

①如下報錯

這是由於同一個name下不能下載名稱相同的插件，修改package.json的那麼即可；

②npm publish推送報錯

看下自己npm的代理地址，是否設置爲了淘寶鏡像，改回來即可。

npm地址：http://registry.npmjs.org/