前言:当我写这篇博客之前我想过这些问题,是否你也被困扰过呢?
1:当你有自己觉得写的好的组件,是不是有一种想存下来,方便下一次使用的情况?
2:是不是大多数时候都是使用cv大法?from "a" to "b" to “c” to anyWhere.....
3:是不是你的的组件跟你npm install下来的有很大区别?
4:是不是想定义一套规则来管理公司项目的组件?(当然前提你得是,,,,大佬)
一:创建默认项目
使用 vue create xxx 创建一个默认项目
二:修改原始目录结构
创建的默认目录如下,我们需要将原本的src目录改为examples,然后创建packages目录来编写自己的组件库文件,(其实目录命名你开心就好,,)
好了,接下来划重点!
三:配置example & packages
到这里你可能发现了,项目无法跑起来了,因为我们没有了原始默认的入口文件
在根目录下创建vue.config.js配置文件(vue-cli3的配置文件,在这里的配置会覆盖脚手架webpack默认的配置项)。
//不熟悉配置的可官网查看 https://cli.vuejs.org/zh/config/#pages module.exports = { pages: { index: { entry: 'examples/main.js', template: 'public/index.html', filename: 'index.html' } } }
进入packages目录创建一个组件目录(HelloWorld),一个index文件(用来暴露所有的组件),然后在组件目录新建index(暴露出当前组件)文件与src组件源码。
在HelloWorld下面的index中引入组件。
import HelloWord from './src/HelloWorld.vue'; HelloWord.install = (Vue)=>{ Vue.components(HelloWord.name,HelloWord) } export default HelloWord;
在packages目录下面的index中引入所有的组件并注册。
import HelloWorld from './HelloWorld'; // 将引入的组件模块存储,方便循环注册所有组件 const components = [ HelloWorld ]; const install = (Vue,options)=>{ if (install.installed) return; install.installed = true console.log(options) components.forEach(component => { Vue.component(component.name, component) }) } // 如果是直接引入的 if (typeof window !== 'undefined' && window.Vue) { install(window.Vue) } export default { // 使用Vue.use必须具有install方法 // https://cn.vuejs.org/v2/api/#Vue-use install, // 同时导出组件列表 ...components }
在examples中的入口文件main.js引入注册的全局组件。
//main.js ... import libs from "../packages" ... Vue.use(libs,{a:'test'})
到现在项目基本已经跑起来了,在项目中可以直接调用组件了,无需在components里注册,平时开发中你的全局组件也可以这样来注册使用。
四:组件打包
vue-cli3中提供了 ,默认是构建应用,这个方法提供的几个配置项主要有以下几个
target: 改为 lib 可启用构建库模式;
name: 构建库输出的文件名;
dest: 构建的输出目录,默认为 dist;
entry: 入口文件路径;
vue-cli-service build --target lib --name myLib --dest libs [entry]
所以需要在项目的package.json文件中添加一条上面的执行脚本
"scripts": { "lib": "vue-cli-service build --target lib --name common --dest lib packages/index.js" }
vue-cli3的默认配置是只对src目录下的文件进行编译的,所有这里我们还需要在vue.config.js文件中将packages文件夹也加入loader编译的配置(后测试可不加)。
chainWebpack:(config)=>{ config.module .rule('js') .include .add('/packages/') .end() .use('babel') .loader('babel-loader') .tap(options=>{ //TODO return options }) }
然后执行npm run lib会在跟目录下生成lib文件夹,lib会生成三种形式的文件(commonjs,umd,umd-min)
五:发布npm
有了上面的四步,基本上开发阶段算是完成了,接下来就是如何让你的库有一个存储的地方,方便下一次的复用,首先你应该想到了 npm ,这个node包管理库。
一个基础的npm包,你首先需要知道package.json中这些配置的作用
name -----> 包的名称,必须唯一,不能跟已有的npm包重名,否则发布不上去;
version -----> 包的版本,当你需要迭代版本时,必须修改这个值(可手动修改,可运行以下命令修改);