小白手把手教你封装Vue组件,并使用npm发布

缘由

作为giser使用到了给地图添加图例这个功能,图例的标准是固定的所以就想发布到npm上以后方便使用。
说明:前端新手+第一次发布npm包 一步一步都会说明
通过下午阅读很多大佬写的总结出来的 其中一些理解可能不对 欢迎指正

搭建模板 构建vue组件

开发组件我们使用 webpack-simple :(看大佬们的 还没开始学webpack)

vue init webpack-simple <project-name>

image.png

框架搭建

image.png

1 中主要是需要发布的组件
2 是输出文件 输出发布的组件

这里代码就不详细说了 就说明一下这些index.js文件

文件说明

package下的index.js


//定义插件 插件有个install方法 传入两个参数
//SipLegend.name 组件名 SipLegend 组件
SipLegend.install = Vue => Vue.component(SipLegend.name, SipLegend);


//导出
export default SipLegend;
复制代码

这里重点说下问题我遇到的问题

代码Vue.component(SipLegend.name, SipLegend); 中SipLegend.name 指的是需要在sip-legend.vue组件中 写上组件名 不然会报个错误

image.png

src目录下的index 主要是组件的输出口

// ...如果还有的话继续添加

const components = [
    SipLegend
  // ...如果还有的话继续添加
]

const install = function(Vue, opts = {}) {
  components.map(component => {
    Vue.component(component.name, component);
  })
}

/* 支持使用标签的方式引入 */
if (typeof window !== 'undefined' && window.Vue) {
  install(window.Vue);
}

export default {
  install,
  SipLegend
  // ...如果还有的话继续添加
}
复制代码

引用组件

image.png

image.png

成功

有了输出 还要有入口

入口在main.js中

image.png
通过这样导出组件

webpack.config.js配置

var webpack = require('webpack')

// 执行环境
//process 当前node进程 process.env包含着关于系统环境的信息,但是process.env中并不存在NODE_ENV这个东西。
//NODE_ENV是一个用户自定义的变量 用于判断生产环境或开发环境
const NODE_ENV = process.env.NODE_ENV

module.exports = {
  // 根据不同的执行环境配置不同的入口
  entry: NODE_ENV == 'development' ? './src/main.js' : './src/index.js',
  output: {
    // 修改打包出口,在最外级目录打包出一个 index.js 文件,我们 import 默认会指向这个文件
    path: path.resolve(__dirname, './dist'),
    publicPath: '/dist/',
    filename: 'gis-ui.js',
    library: 'gis-ui', // 指定的就是你使用require时的模块名
    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
    })
  ])
}

复制代码

package.js配置 文件打包

  {
      "name": "gisui", //npm包名
      "main": "dist/gis-ui.js",//build打包文件名
  }
复制代码

准备发布

本地测试

npm run build 打包
使用npm back打包成

image.png
在所需要的项目中 npm i 地址/gisui-1.0.0.tgz
之后就 像组件一样在main引入

image.png
需要的地方使用

image.png

发布

需要到npm 官网注册
注册成功需要验证邮箱
之后

npm login // 登陆

npm publish // 发布

就完成了!

一个小问题

发布完成后 再到发布的vue组件中启动发现报错
最后发现是webpack.config.js配置的问题 这里面的配置是打包发布的配置 需要重新改成原来的配置才能正常启动。暂时不知道什么问题,毕竟webpack还没学,之后会学习一下。

image.png

感谢:juejin.cn/post/684490… 参考

© 版权声明
THE END
喜欢就支持一下吧
点赞0 分享