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 相关文章推荐
JavaScript 联动的无限级封装类,数据采用非Ajax方式,随意添加联动
Jun 29 Javascript
jquery绑定事件不生效的解决方法
Feb 11 Javascript
JavaScript+CSS实现仿天猫侧边网页菜单效果
Aug 25 Javascript
jQuery给元素添加样式的方法详解
Dec 30 Javascript
动态加载js文件简单示例
Apr 21 Javascript
jQueryUI DatePicker 添加时分秒
Jun 04 Javascript
javascript实现抽奖程序的简单实例
Jun 07 Javascript
Javascript ES6中数据类型Symbol的使用详解
May 02 Javascript
基于vue+axios+lrz.js微信端图片压缩上传方法
Jun 25 Javascript
序列化模块json代码实例详解
Mar 03 Javascript
Vue优化:常见会导致内存泄漏问题及优化详解
Aug 04 Javascript
Vue.js使用axios动态获取response里的data数据操作
Sep 08 Javascript
实例详解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
snoopy PHP版的网络客户端提供本地下载
2008/04/15 PHP
PHP使用正则表达式获取微博中的话题和对象名
2015/07/18 PHP
Discuz论坛密码与密保加密规则
2016/12/19 PHP
详解no input file specified 三种解决方法
2019/11/29 PHP
随窗体滑动的小插件sticky源码
2013/06/21 Javascript
jQuery使用toggleClass方法动态添加删除Class样式的方法
2015/03/26 Javascript
js实现简单锁屏功能实例
2015/05/27 Javascript
JS特效实现图片自动播放并可控的效果
2015/07/31 Javascript
JS+CSS实现下拉列表框美化效果(3款)
2015/08/15 Javascript
Bootstrap布局之栅格系统详解
2016/06/13 Javascript
微信小程序 require机制详解及实例代码
2016/12/14 Javascript
js实现增加数字显示的环形进度条效果
2017/02/05 Javascript
详解nodeJS之路径PATH模块
2017/05/31 NodeJs
bootstrap fileinput实现文件上传功能
2017/08/23 Javascript
js中this对象用法分析
2018/01/05 Javascript
微信小程序自定义组件实现tabs选项卡功能
2018/07/14 Javascript
JavaScript中为事件指定处理程序的五种方式分析
2018/07/27 Javascript
详解JavaScript类型判断的四种方法
2020/10/21 Javascript
基于python编写的微博应用
2014/10/17 Python
python统计文本字符串里单词出现频率的方法
2015/05/26 Python
Python语言的面相对象编程方式初步学习
2016/03/12 Python
解决python opencv无法显示图片的问题
2018/10/28 Python
Python中最大递归深度值的探讨
2019/03/05 Python
图文详解Django使用Pycharm连接MySQL数据库
2019/08/09 Python
Python paramiko 模块浅谈与SSH主要功能模拟解析
2020/02/29 Python
python由已知数组快速生成新数组的方法
2020/04/08 Python
Python 如何查找特定类型文件
2020/08/17 Python
解决Python3.7.0 SSL低版本导致Pip无法使用问题
2020/09/03 Python
python解包用法详解
2021/02/17 Python
浅谈HTML5 服务器推送事件(Server-sent Events)
2017/08/01 HTML / CSS
HTML5 FileReader对象的具体使用方法
2020/05/22 HTML / CSS
C面试题
2015/10/08 面试题
大学生水文观测实习自我鉴定
2013/09/29 职场文书
关于梦想的演讲稿
2014/05/05 职场文书
奥运会口号
2014/06/13 职场文书
普希金诗歌赏析(6首)
2019/08/22 职场文书