vue 打包项目发布到NPM做公共组件使用

自己写的组件 有的也挺好的,为了方便以后用自己再用或者给别人用,把组件打包发布到npm是最好不过了,本次打包支持 支持正常的组件调用方式,也支持Vue.use, 也可以直接引用打包好的js文件, 配合vue.js 就不需要webpakc这种构建工具了,可以直接在页面内使用,下面以 vue-test 这个包为例

第一步:使用 vue init webpack-simple vue-test 初始化项目

提示: 不要用 vue init webpack npm-practice 初始化项目,因为我们就开发个组件,不需要那么多配置,配置多了修改起来也麻烦,webpack-simple足够了。

初始完项目,按照提示输入项目信息即可,然后 npm install , npm run dev 让项目跑起来,如下图:

image

第二步:修改文件目录

1.在src目录下新建components文件夹,然后在此文件夹下建立HelloWorld.vue文件

HelloWorld.vue 名字也可以是其他,我们写的这个组件就是放在该文件里面,之前的App.vue是用于本地开发,测试用的入口文件,也就是用于 npm run dev 的入口文件。

2.在webpack.config.js同级目录(也是该组件的根目录)下新建 index.js文件, index.js是把HelloWorld.vue文件暴露出去的出口。

修改完之后的文件目录如下,标红的就是新增的内容:

image.png

第三步:修改文件内容,配置

1.Main.vue内容如下(注意name):

<template>
  <div class="container">
  <div>{{msg}}</div>
  <div>{{propData}}</div>
  </div>
</template>

<script>
export default {
  name: 'yyl-npm-practice',
  data () {
    return {
      msg: 'Welcome to Your Vue.js App'
    }
  },
  props: {
      propData: {
      type: String,
      default: '我是默认值'
      }
  }
}
</script>

<style >
.container{
    text-align: center;
}
</style>

2.App.vue内容如下:

<template>
  <div id="app">
    <hello-world :propData="msg"/>
  </div>
</template>

<script>
import helloWorld from 'vue-test-lxw'
export default {
  name: 'app',
 components:{
    helloWorld
  },
  data () {
    return {
      msg: 'Hey man!!!!'
    }
  }
}
</script>

<style>

  </style>

3.index.js内容如下:

import HelloWorld from './src/component/HelloWorld.vue'
import _Vue from 'vue'

HelloWorld .install = Vue => {
if (!Vue) {
window.Vue = Vue = _Vue
}
Vue.component(HelloWorld .name, HelloWorld )
}
export default HelloWorld ;

4.修改package.json

package.json需要修改private字段(private是true的时候不能发布到npm,需设置成false); 并增加main字段, main字段是require方法可以通过这个配置找到入口文件,这输入模块加载规范,具体可以参考 这里, 主要内内容截图如下:

image

修改完package.json如下,标红的就是新增和改变的属性。

image.png

5.修改 webpack.config.js

其实就是修改entry 和output,截图如下:


image.png

说明:入口会根据开发环境 ,生产环境切换, main.js 是npm run dev 的入口,就是App.vue, 用于调试/测试我们开发的组件; index.js是Main.vue, 就是我们开发的组件,我们打包到生产环境打包就只是单纯的 vue-test-lxw 组件

6.修改index.html的js引用路径,因为我们修改了output 的 filename,所以引用文件的名字也得变。

image.png

到此组件就开发完了,打包下看看, npm run build dist下生成了俩文件,如下:

image.png

这个.map文件怎么回事,其实就是这段代码:

image

生产环境的时候, 我们就不调试了,也不想要这个.map文件,那就先把这个 devtool删了,然后放在这里,看下图,只要在开发环境的时候才启用这个调试,

image

把dist目录下的俩文件删除,再npm run build 就不会产生.map文件了。

npm run dev 让项目跑起来,我们在App.vue里面调用该组件,并做测试,调试。


第四步: 发布到npm

1. 去 npm 官网注册个账号 https://www.npmjs.com/

2.在该组件根目录下的终端(就是 平常输入 npm run dev的地方),运行npm login,会提示输入个人信息,Email是发布成功后,自动给这个邮箱发送一个邮件,通知发布成功,输入完,登录成功。

image.png

3.最后就可以发布了, npm publish, 如下,发布成功(每次发布的时候packa.json 里面的 version不能一样,不然不能发布出去,手动改下版本就行)

image.png

去自己的npm上点击Packages ,就能看到发布的包

image.png

包的具体信息如下:

image.png

使用方法 :

1.组件内部使用

 <template>
      <div id="app">
        <hello-world :propData="msg"/>
      </div>
 </template>

<script>
import helloWorld from 'vue-test-lxw'
export default {
  name: 'app',
 components:{
    helloWorld
  },
  data () {
    return {
      msg: 'Hey man!!!!'
    }
  }
}
</script>

<style>

  </style>

2. main.js 全局安装:

import HelloWorld from 'vue-test-lxw'

Vue.use(HelloWorld )

然后在其他.vue文件里面,直接使用组件 <hello-world/> 即可

3.直接引用打包后的 vue-test-lxw.js

这种方式就不需要webpack这类的构建工具,跟jquery的方式差不多,可以直接页面引用,使用方法示例如下

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
</head>
<body>
<div id="app">
  <vue-test-lxw :propData="propData"></vue-test-lxw>
</div>
<script src="https://unpkg.com/vue/dist/vue.js"></script>
<script src="./dist/vue-test-lxw.js"></script>
<script>
  new Vue({
    el: '#app',
    data: function() { return {
        propData: 'Hey man!!!' }
    },
    methods: {
    }
  }) </script>
</body>
</html>

采坑记录:

1.在webpack.config.js里设置 resolve(比如 设置@做为根目录 ), 开发环境没问题,生产环境就用不了了,所以大家就用平常的相对路径类吧,虽然麻烦了点。

2.图片生产环境不能用,解决方法可以把图片转成base64, 可以用这个 在线图片转base64,或者把图片放在网上,引用图片的网上资源路径。

3.字体图标在生产环境也用不了,如果用到了字体图标,就别把字体图标的资源打包进去了,引用该组件的时候,需要再引用字体图标的资源。

start ====> 2019-04-17更新

后来发现其实图片和字体图标也可一起打包到js里面,需要用到 url-loader 把limit参数设置大点就行,这样就可以把图片,字体图标也都打包到js里面了,这样使用的时候,就不用单独引用这些静态资源了, 代码如下:

 {
        test: /\.(png|jpg|gif|svg)$/,
        loader: 'url-loader',
        options: {
          name: '[name].[ext]?[hash]',
          limit: 99999
        }
      },
      { 
        test: /\.(svg|ttf|eot|woff|woff2)$/, 
        loader: 'url-loader', 
        options:{ 
                name:'[name].[ext]',
                limit: 9999999
        } 
      }

end ====> 2019-04-17更新

想看源码的话,只要在自己项目里 npm install yyl-npm-practice 就可以在 node_modules 下找到了。

原文转帖:https://www.cnblogs.com/yalong/p/10388384.html

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,390评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,821评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,632评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,170评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,033评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,098评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,511评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,204评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,479评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,572评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,341评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,893评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,171评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,486评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,676评论 2 335