Vue插件打包与发布的方法示例


Posted in Javascript onAugust 20, 2018

插件打包与发布

插件功能开发完成后,若需要发布到公共组件库中(例如:npmjs),需要对插件进行打包并发布,简单说明一下这个过程,以插件名 dialog 为例

1、创建 dialog 目录,并进入

2、运行命令行,初始化项目,生成 package.json

npm init -y

3、使用 webpack-simple 模板构建项目基本结构(前提为已自行安装好 vue-cli)

vue init webpack-simple

根据导航提示,设置好项目后,基本结构生成完成

4、删除无用内容   删除 index.html 和 src 目录下的所有文件

5、复制插件内容到 src 目录中

6、修改 package.json 配置内容

{
 "name": "dialog",
 "description": "the dialog plguin",
 "version": "1.0.0",
 "author": "TerryZ <terry5@foxmail.com>",
 "license": "MIT",
 //删除原有的"priveate": true,发布到公共库的项目,不能设置该参数
 //增加 main 配置,设置插件在安装后的主入口文件
 "main": "dist/dialog.js",
 "scripts": {
  "dev": "cross-env NODE_ENV=development webpack-dev-server --open --hot",
  "build": "cross-env NODE_ENV=production webpack --progress --hide-modules"
 },
 "dependencies": {
  "vue": "^2.5.11"
 },
 //增加插件关键字描述,非必须,按需设置
 "keywords": [
  "front-end",
  "javascript",
  "dialog",
  "vue",
  "vuejs"
 ],
 "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",
  "node-sass": "^4.5.3",
  "sass-loader": "^6.0.6",
  "vue-loader": "^13.0.5",
  "vue-template-compiler": "^2.4.4",
  "webpack": "^3.6.0",
  "webpack-dev-server": "^2.9.1"
 }
}

7、修改 webpack.config.js 的 output 部分配置

output: {
  path: path.resolve(__dirname, './dist'),
  publicPath: '/dist/',
  //修改输出打包后的脚本文件名,该文件即是 package.json 中配置的 main 属性的对应文件
  filename: 'dialog.js',
  //增加以下库配置信息
  library: 'Dialog',
  libraryTarget: 'umd',
  umdNamedDefine: true
}

8、安装库,国内环境建议使用 cnpm 安装速度会快些

npm install -g cnpm --registry=https://registry.npm.taobao.org

9、编译插件

npm run build

10、发布插件,确定你的插件名当前公共库中不存在,否则会发布失败

npm publish

图片资源打包

插件中使用到的图片资源,在打包后,根据模板的默认配置,会将图片资源输出到 dist 目录中,此时就有图片引用路径问题。在样式内容中会发现原来设置的

background-image:url('../image/a.jpg')

会转换成

background-image:url('/dist/a.jpg')

实际的完整路径即是

http://xxx.com/dist/a.jpg

我们知道插件在安装后,会统一安装在 node_modules 目录中,这样的目录显然是不正确的

一种折中的办法,就是将图片资源转换成 base64 编码,不生成实体图片

webpack-simple 中默认使用 file-loader 来处理图片,这里换成 url-loader,两者的区别在于后者是前者的功能封装,还增加了将图片编码为 base64 的功能,所以可以放心使用

安装 url-loader

npm i url-loader --save-dev

webpack 配置修改(webpack-simple 模板)

module.exports = {
 ...
 module: {
  rules: [
   {...},
   {
    test: /\.(png|jpg|gif|svg)$/,
    loader: 'url-loader',
    options: {
     limit: 30000,
     name: '[name].[ext]?[hash]'
    }
   }
  ]
 },
 ...
}

上面的配置中,将原 file-loader 更换了 url-loader,并增加 limit 参数,该参数设置了图片容量在小于指定容量(上例设置为30kb)时,不会转换成 base64

如此调整配置后,再运行编译

npm run build

会发现编译到 dist 目录中的内容已经没有图片文件,只有编译完成的 build.js 和对应的 map 文件,所以在插件开发时,尽可能使用 CSS 处理样式,需要使用到图片或图标资源,尽可能也使用图片尺寸小的图片,方便打包处理

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

Javascript 相关文章推荐
jquery一句话全选/取消全选
Mar 01 Javascript
js的2种继承方式详解
Mar 04 Javascript
jQuery中$(function() {});问题详解
Aug 10 Javascript
jquery实现简单实用的弹出层效果代码
Oct 15 Javascript
js print打印网页指定区域内容的简单实例
Nov 01 Javascript
微信公众平台开发教程(六)获取个性二维码的实例
Dec 02 Javascript
解决vue组件中使用v-for出现告警问题及v for指令介绍
Nov 11 Javascript
js+css实现打字效果
Jun 24 Javascript
vue实现页面滚动到底部刷新
Aug 16 Javascript
vue中的过滤器及其时间格式化问题
Apr 09 Javascript
浅谈vue项目利用Hbuilder打包成APP流程,以及遇到的坑
Sep 12 Javascript
jQuery实现计算器功能
Oct 19 jQuery
实例详解Vue项目使用eslint + prettier规范代码风格
Aug 20 #Javascript
解决jquery有正确返回值但不执行success函数的问题
Aug 20 #jQuery
解决vue-quill-editor上传内容由于图片是base64的导致字符太长的问题
Aug 20 #Javascript
Vue2.0生命周期的理解
Aug 20 #Javascript
JavaScript作用域、闭包、对象与原型链概念及用法实例总结
Aug 20 #Javascript
RequireJS用法简单示例
Aug 20 #Javascript
JavaScript实现多态和继承的封装操作示例
Aug 20 #Javascript
You might like
ThinkPHP中自定义错误页面和提示页面实例
2014/11/22 PHP
PHP根据图片色界在不同位置加水印的方法
2015/07/01 PHP
php-redis中的sort排序函数总结
2015/07/08 PHP
基于Swoole实现PHP与websocket聊天室
2016/08/03 PHP
iis6手工创建网站后无法运行php脚本的解决方法
2017/06/08 PHP
Javascript 面向对象 重载
2010/05/13 Javascript
js 函数调用模式小结
2011/12/26 Javascript
js获取多个tagname的节点数组
2013/09/22 Javascript
javascript中的括号()用法小结
2014/04/14 Javascript
使用jQuery的attr方法来修改onclick值
2014/07/07 Javascript
JavaScript中的ubound函数使用实例
2014/11/04 Javascript
node.js中的socket.io的广播消息
2014/12/15 Javascript
jQuery操作DOM之获取表单控件的值
2015/01/23 Javascript
JavaScript获取表格(table)当前行的值、删除行、增加行
2015/07/03 Javascript
Bootstrap每天必学之js插件
2015/11/30 Javascript
AngularJS 实现JavaScript 动画效果详解
2016/09/08 Javascript
基于bootstrap风格的弹框插件
2016/12/28 Javascript
Jil,高效的json序列化和反序列化库
2017/02/15 Javascript
基于Vue实现支持按周切换的日历
2020/09/24 Javascript
javascript中的this作用域详解
2019/07/15 Javascript
layer弹出层自定义提交取消按钮的例子
2019/09/10 Javascript
javascript实现移动端红包雨页面
2020/06/23 Javascript
原生js实现俄罗斯方块
2020/10/20 Javascript
[48:48]完美世界DOTA2联赛PWL S3 Magama vs GXR 第一场 12.19
2020/12/24 DOTA
python正则表达式match和search用法实例
2015/03/26 Python
Python编程实现删除VC临时文件及Debug目录的方法
2017/03/22 Python
pycharm安装图文教程
2017/05/02 Python
python中使用 xlwt 操作excel的常见方法与问题
2019/01/13 Python
python自定义函数实现一个数的三次方计算方法
2019/01/20 Python
浅析python中的del用法
2020/09/02 Python
Python创建文件夹与文件的快捷方法
2020/12/08 Python
美国高端医师级美容产品电商:BeautifiedYou.com
2017/04/17 全球购物
有原因的手表:Flex Watches
2019/03/23 全球购物
Java如何支持I18N?
2016/10/31 面试题
经济贸易专业自荐信
2014/06/11 职场文书
Python打包为exe详细教程
2021/05/18 Python