vue封装第三方插件并发布到npm的方法


Posted in Javascript onSeptember 25, 2017

前言

写此文前特意google了一下,因为有较详细的开发教程我再写意义不大,有把插件封装成组件的教程,有把自己的组件封住成插件的教程,本文主要说明如何把第三方的插件封装成vue插件,简化配置,一键安装,主要提供思路,封装方法大同小异·,文章略长要有耐心。

gitment

gitment是一个基于github issues封装的评论插件,以这个插件作为演示,把它封装成vue插件。vue-gitment,该插件已发布到npm,并在自己的开源项目vueblog中安装使用

项目初始化

封装vue的插件用webpack-simple很合适,vue init webpack-simple vue-gitment此命令创建我们的项目的目录,创建文件夹和文件,最后结构是这样的

vue封装第三方插件并发布到npm的方法

lib目录是我们的插件目录,其他的默认就好

修改配置项

首先是修改package.json

{
 "name": "vue-gitment",
 "version": "0.1.1",
 "description": "A comment plugin by gitment",
 "main": "dist/vue-gitment.js",
 "directories": {
  "dist": "dist"
 },
 "scripts": {
  "dev": "cross-env NODE_ENV=development webpack-dev-server --open --hot",
  "build": "cross-env NODE_ENV=production webpack --progress --hide-modules"
 },
 "repository": {
  "type": "git",
  "url": "git+https://github.com/vue-blog/vue-gitment.git"
 },
 "dependencies": {
  "gitment": "^0.0.3",
  "vue": "^2.3.3"
 },
 "devDependencies": {
 },
 "author": "wmui",
 "license": "MIT",
 "bugs": {
  "url": "https://github.com/vue-blog/vue-gitment/issues"
 },
 "homepage": "https://github.com/vue-blog/vue-gitment#readme"
}

把依赖性gitment添加到dependencies,main是我们打包后的文件入口,你可以用npm init命令生成一个package.json

修改webpack.config.js

vue封装第三方插件并发布到npm的方法

我们只需配置入口和出口,不要删除默认的配置,因为后面开发好插件,我们需要查看工作效果

修改index.html

vue封装第三方插件并发布到npm的方法

因为我们修改了webpack配置,自然要把script的src修改一下

封装插件

VueComment.vue内容如下

<template>
 <div v-comment="options"></div>
</template>
<script>
// 引入依赖项
import Gitment from 'gitment'
export default {
 name: 'vue-comment',
 props: ['options'],
 directives: {
  // 自定义指令
  comment: {
   bind: function (el, binding) {
    const gitment = new Gitment({
     id: binding.value.id + '',
     owner: binding.value.owner,
     repo: binding.value.repo,
     oauth: {
      client_id: binding.value.oauth.client_id,
      client_secret: binding.value.oauth.client_secret
     }
    })
    gitment.render(el)
   }
  }
 }
}
</script>

相信熟悉vue的一眼都看懂了,render函数是gitment对象的方法,不用关心,和我们开发组件是一样一样的

index.js封装组件

import VueComment from './VueComment.vue'
const comment = {
 install: function(Vue) {
  Vue.component(VueComment.name, VueComment)
 }
}
// 这里的判断很重要
if (typeof window !== 'undefined' && window.Vue) { 
  window.Vue.use(comment) 
}
export default comment

我们在webpack配置的入口文件就是他,install是挂载组件的方法,有了它我们就可以在外部use一个插件了,简单吧

测试插件

首先测试build是否成功

npm run builddist目录会生成如下文件

vue封装第三方插件并发布到npm的方法

可喜可贺,接下来测试插件是否正常工作

我们需要把package和webpack的修改一下,这就是为什么我前面说不要删除而是注释掉 ,把package.json的main修改为dist/build.js,wepack的entry和filename换成默认配置,index.html的src也换成默认的

在main.js中引入我们的组件

import VueComment from './lib/index.js'
Vue.use(VueComment)

App.vue中使用我们的插件

<template>
 <div id="app">
  <vue-comment :options="options" v-if="options"></vue-comment>
 </div>
</template>
<script>
export default {
 name: 'App',
 data() {
  return {
   options: {
    id: 'article id',
    owner: 'Your GitHub ID',
    repo: 'The repo to store comments',
    oauth: {
     client_id: 'Your client ID', 
     client_secret: 'Your client secret',
    } 
   }
  }
 }
}
</script>
<style>
  @import '~gitment/style/default.css';
</style>

执行npm run dev

vue封装第三方插件并发布到npm的方法

哈哈,它正常工作了,Error: Not Found是因为我没配置client_id。

发布插件

完成测试工作后我们就可以发布到npm了,这个就比较见到了,注册个npm账号,在你要发布的项目目录执行npm login,输入账号密码和邮箱,然后npm publish就发布成功了,npm install vue-gitment查看效果,建议直接看源代码,因为真的很简单。

结语

自己动手丰衣足食,我觉得每个前端开发者都要一个属于自己的轮子(虽然vue-gitment不是轮子),一个属于自己轮子,在造轮子的工程中你能学到很多很多

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
自己的js工具_Form 封装
Aug 21 Javascript
JQuery上传插件Uploadify使用详解及错误处理
Apr 27 Javascript
multiSteps 基于Jquery的多步骤滑动切换插件
Jul 22 Javascript
jQuery使用动态渲染表单功能完成ajax文件下载
Jan 15 Javascript
js实现的map方法示例代码
Jan 13 Javascript
jQuery在ul中显示某个li索引号的方法
Mar 17 Javascript
JS实现环形进度条(从0到100%)效果
Jul 05 Javascript
jQuery插件实现非常实用的tab栏切换功能【案例】
Feb 18 jQuery
node.JS事件机制与events事件模块的使用方法详解
Feb 06 Javascript
javascript canvas检测小球碰撞
Apr 17 Javascript
详细分析vue表单数据的绑定
Jul 20 Javascript
JavaScript大数相加相乘的实现方法实例
Oct 18 Javascript
javascript input输入框模糊提示功能的实现
Sep 25 #Javascript
vue-cli中的webpack配置详解
Sep 25 #Javascript
react.js 父子组件数据绑定实时通讯的示例代码
Sep 25 #Javascript
react native与webview通信的示例代码
Sep 25 #Javascript
Three.js利用orbit controls插件(轨道控制)控制模型交互动作详解
Sep 25 #Javascript
vuex中使用对象展开运算符的示例
Sep 25 #Javascript
Three.js利用性能插件stats实现性能监听的方法
Sep 25 #Javascript
You might like
PHP函数extension_loaded()用法实例
2015/01/19 PHP
Smarty foreach控制循环次数的一些方法
2015/07/01 PHP
PHP的时间戳与具体时间转化的简单实现
2016/06/13 PHP
手把手编写PHP框架 深入了解MVC运行流程
2016/09/19 PHP
让Laravel API永远返回JSON格式响应的方法示例
2018/09/05 PHP
php获取用户真实IP和防刷机制的实例代码
2018/11/28 PHP
JS获取父节点方法
2009/08/20 Javascript
ExtJS下grid的一些属性说明
2009/12/13 Javascript
jQuery学习2 选择器的使用说明
2010/02/07 Javascript
nullJavascript中创建对象的五种方法实例
2013/05/07 Javascript
jquery 获取标签名(tagName)示例代码
2013/07/11 Javascript
JavaScript prototype 使用介绍
2013/08/29 Javascript
js实现单行文本向上滚动效果实例代码
2013/11/28 Javascript
模拟用户点击弹出新页面不会被浏览器拦截
2014/04/08 Javascript
jQuery如何取id有.的值一般的方法是取不到的
2014/04/18 Javascript
React.js入门实例教程之创建hello world 的5种方式
2016/05/11 Javascript
Vue利用路由钩子token过期后跳转到登录页的实例
2017/10/26 Javascript
echarts鼠标覆盖高亮显示节点及关系名称详解
2018/03/17 Javascript
Vue 中mixin 的用法详解
2018/04/23 Javascript
vue2过滤器模糊查询方法
2018/09/16 Javascript
uni-app实现点赞评论功能
2019/11/25 Javascript
[01:11:10]2014 DOTA2华西杯精英邀请赛 5 24 iG VS VG加赛
2014/05/26 DOTA
python使用Matplotlib画饼图
2018/09/25 Python
python 将list转成字符串,中间用符号分隔的方法
2018/10/23 Python
python GUI库图形界面开发之PyQt5信号与槽多窗口数据传递详细使用方法与实例
2020/03/08 Python
python中函数返回多个结果的实例方法
2020/12/16 Python
德国baby-markt婴儿用品瑞士网站:baby-markt.ch
2017/06/09 全球购物
印度尼西亚电子产品购物网站:Kliknklik
2018/06/05 全球购物
数学专业毕业生自荐信
2013/11/10 职场文书
大二学期个人自我评价
2014/01/13 职场文书
教育科研先进个人材料
2014/01/26 职场文书
秘书英文求职信
2014/04/16 职场文书
王力宏牛津大学演讲稿
2014/05/22 职场文书
高中教师个人总结
2015/02/10 职场文书
详解php中流行的rpc框架
2021/05/29 PHP
Mysql文件存储图文详解
2021/06/01 MySQL