缘由

作为giser使用到了给地图添加图例这个功能，图例的标准是固定的所以就想发布到npm上以后方便使用。

说明：前端新手+第一次发布npm包一步一步都会说明通过下午阅读很多大佬写的总结出来的其中一些理解可能不对欢迎指正

搭建模板构建vue组件

开发组件我们使用 webpack-simple ：（看大佬们的还没开始学webpack）

vue init webpack-simple <project-name>

框架搭建

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组件中写上组件名不然会报个错误找不到组件

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
  // ...如果还有的话继续添加
}

引用组件

成功

有了输出还要有入口

入口在main.js中

通过这样导出组件

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打包成 .tgz

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

需要的地方使用

发布

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

npm login // 登陆

npm publish // 发布

就完成了！

发布组织包@my-org 组织名

npm init --scope=@my-org

发布

npm publish --access public

一个小问题

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

使用yarn LD和我说现在建议用yarn作为包管理工具所以现在加个使用yarn发布

安装： npm install -g yarn

发布 yarn publish

更新 yarn publish

和npm发布一样但是还没尝试下个组件跟新可以试试

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

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

缘由

搭建模板 构建vue组件