如何制作一个vue组件,并将自己的vue组件发布为npm包

2019 年 5 月 21 日 0 条评论 445 次阅读 1 人点赞

首先问题:开发中我们往往需要做某些功能,这个功能可能会出现很多次,也会出现在不同的项目。需要使用时候又不想重新写,怎么办呢?

解决思路:  把这个特殊的需求功能做成属于自己的组件,当下次需要去使用它的时候。那么我们就可以打包这个组件并上传到npm管理库,这个库可以是自己的私有库,也可以是npmjs公共库。如何创建自己的私有npm服务器,详见上一篇文章。

一、初始化一个空项目

1、新建一个文件夹,然后进入到该文件夹目录下,执行

npm init

初始化项目。然后会让你填一些项目相关的信息,跟着提示填就是了。没啥说的。注意name不要和现有的其他npm包重名了,不然一会儿发Npm包的时候会失败,可以先去npmjs.com搜一下有没有重名的。
这一步完成后,目录下会生成package.json文件。

2、由于本教程是发布一个vue的组件包,而且使用了es6和webpack,所以在devDependencies字段中,应该至少加入对应的依赖,可以参考我这个配置
name 为npm包的名称,一定不能跟别人的重复,可以自己去npmjs.com 上面检查下是否重复,否则提交不成功的
main 自己定义的程序的入口文件,比如我希望打包后是 dist/helloWorld.js
private 要设置为 false

{
  "name": "hello-world",
  "description": "",
  "version": "1.0.0",
  "author": "十三月",
  "license": "MIT",
  "private": false,
  "main": "dist/helloWorld.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1",
    "start": "webpack-dev-server --hot --inline",
    "build": "webpack --display-error-details --config webpack.config.js"
  },
  "dependencies": {
    "vue": "^2.5.11"
  },
  "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",
    "style-loader": "^0.23.1",
    "stylus": "^0.54.5",
    "stylus-loader": "^3.0.2",
    "vue-loader": "^13.0.5",
    "vue-template-compiler": "^2.4.4",
    "webpack": "^3.12.0",
    "webpack-dev-server": ">=3.4.1"
  }
}

具体这些依赖都有什么用处自己查查就明白了。

3、执行npm install,下载这些依赖包。
4、项目根目录下创建2个文件夹:dist 和 src,名字按照个人习惯可以变动。我习惯使用dist代表发布的目录,src是开发目录。dist文件夹里的js是到时候通过webpack打包后的文件。待会只会提交dist目录到npm官网上,src不提交。

src里,我们创建一个常规的vue组件。hello-world.vue 内容大致如下:

<template>
  <div>
    <h2>{{name}}</h2>
  </div>
</template>

<script>
  export default {
    name: "hello-world",
    components: {},
    props: {
      name: {
        type: String,
        default: ''
      }
    },
    data() {
      return {}
    },
    mounted() {

    },
    methods: {},
    destroyed() {
    }
  }
</script>

<style scoped>

</style>

接下来我们还需要创建一个js文件。index.js  内容如下(这里的写法主要是把这个组件 export 出去):

import helloWorld from './hello-world.vue'
export default helloWorld;

5、接下来配置 webpack 打包,把src中的内容打包进 dist 目录内:
根目录下新增 webpack.config.js 大致内容如下:

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

module.exports = {
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, './dist'),//输出路径,就是上步骤中新建的dist目录
    publicPath: '/dist/',//路径

    filename: 'helloWorld.js',//打包之后的名称
    library: 'helloWorld', // 指定的就是你使用require时的模块名

    libraryTarget: 'umd', // 指定输出格式
    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|eot|ttf|woff|woff2)$/,
        loader: 'file-loader',
        options: {
          name: '[name].[ext]?[hash]'
        }
      }
    ]
  },
  resolve: {
    alias: {
      'vue$': 'vue/dist/vue.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
    })
  ])
}

然后执行npm run build,就会在dist目录下生成helloWorld.js。这个js即是我们这个npm包的主文件。

6、新建一个文件,名为.npmignore,是不需要发布到npm的文件和文件夹,规则和.gitignore一样。如果你的项目底下有.gitignore但是没有.npmignore,那么会使用.gitignore里面的配置。大致可以参考我的:
.npmignore

.DS_Store
node_modules/
dist/
build/
npm-debug.log
yarn-error.log
package-lock.json

# Editor directories and files
.idea
*.suo
*.ntvs*
*.njsproj
*.sln

至此,一个npm组件包就做完了,剩下的,只是提交到npm官网去。

(如果要严谨点,当然还需要加入单元测试通过后再发包。。。但是。。。但是。。。

 

二、发布到NPM上的流程

1、前提,得有个npm账号,没有就新注册一个账号
https://www.npmjs.com/signup

2、进入到项目的根目录下,运行 npm login 执行登录
一般情况下回提示你输入 你的用户名,密码和邮箱,若登录成功一般会显示:

Logged in as 你的名字 on https://registry.npmjs.org/.

3、登录成功后就可以执行 npm publish  即可将这个npm包发布到npm官网。大概过个10来分钟就可以搜索到并下载,我们执行npm install hello-world --save-dev 即可在自己的项目中import导入进来当做组件使用了。
4、更新包的时候,需要手动修改 package.json 中的version版本号,一般惯例都是+1,比如1.0.0 --> 1.0.1。更改完成后,分别执行打包、登录npm、发布即可。

npm run build

npm login
npm publish

三、一般问题

1、发包时提示name名错误,name名称不能有大写字母,一般建议小写字母加中横线连接

雷雷

这个人太懒什么东西都没留下

文章评论(0)

(Spamcheck Enabled)