浅谈Vue CLI 3结合Lerna进行UI框架设计

// 其中的`node build/bin/build-entry.js` 生成webpack构建入口
"build:file": "node build/bin/iconinit.js & node build/bin/build-entry.js & node build/bin/i18n.js & node build/bin/version.js",
// 构建css样式
"build:theme": "node build/bin/gen-cssfile && gulp build --gulpfile packages/theme-chalk/gulpfile.js && cp-cli packages/theme-chalk/lib lib/theme-chalk",
// 构建commonjs规范的`utils`
"build:utils": "cross-env babel_env=utils babel src --out-dir lib --ignore src/index.js",
// 构建umd模块的语言包
"build:umd": "node build/bin/build-locale.js",
// 清除构建文件夹`lib`
"clean": "rimraf lib && rimraf packages/*/lib && rimraf test/**/coverage",
// 总体构建
"dist": "npm run clean && npm run build:file && npm run lint && webpack --config build/webpack.conf.js && webpack --config build/webpack.common.js && webpack --config build/webpack.component.js && npm run build:utils && npm run build:umd && npm run build:theme",
// 执行eslint校验
"lint": "eslint src/**/* test/**/* packages/**/* build/**/* --quiet"

lib
├── directives     # commonjs指令(这里归为utils)
├── locale      # commonjs国际化(commonjs语言包和api)
├── mixins  		# commonjs mixins(这里归为utils)
├── theme-chalk 		# css 样式文件
├── transitions			# commonjs transitions(这里归为utils)
├── umd   		# umd语言包 
├── utils
├── alert.js     # commonjs组件
├── aside.js
├── ...
├── element-ui.common.js 	# commonjs2总文件 
├── ...
├── index.js     # umd总文件
├── ...

// 注释说明该文件由build-entry.js脚本自动生成
/* automatically generated by './build/bin/build-entry.js' */

import pagination from '../packages/pagination/index.js';
// ... 这里省略大部分组件引入
import timelineitem from '../packages/timeline-item/index.js';
import locale from 'element-ui/src/locale';
import collapsetransition from 'element-ui/src/transitions/collapse-transition';

const components = [
 pagination,
 // ... 这里省略大部分组件
 timelineitem,
 collapsetransition
];

const install = function(vue, opts = {}) {
 locale.use(opts.locale);
 locale.i18n(opts.i18n);

 components.foreach(component => {
 vue.component(component.name, component);
 });

 vue.use(loading.directive);

 vue.prototype.$element = {
 size: opts.size || '',
 zindex: opts.zindex || 2000
 };

 vue.prototype.$loading = loading.service;
 // ...
};

/* istanbul ignore if */
if (typeof window !== 'undefined' && window.vue) {
 install(window.vue);
}

export default {
 version: '2.7.0',
 locale: locale.use,
 i18n: locale.i18n,
 install,
 collapsetransition,
 loading,
 pagination,
 // ... 这里省略大部分组件
 timelineitem
};

"lint": "eslint src/**/* test/**/* packages/**/* build/**/* --quiet",

lib
├── index.js     # umd 总文件

// build/webpack.conf.js

// ...忽略

module.exports = {
 mode: 'production',
 // 指定入口文件src/index.js，该入口文件由`build:file`脚本自动生成
 entry: {
 app: ['./src/index.js']
 },
 output: {
 // 在lib文件中生成
 path: path.resolve(process.cwd(), './lib'),
 // 生成lib/index.js
 filename: 'index.js',
 // 生成umd模块
 librarytarget: 'umd',
 // src/index.js文件采用export default语法抛出，因此需要设置libraryexport
 // 否则引入的ui组件库需要使用.default才能引用到抛出的对象
 // if your entry has a default export of `mydefaultmodule`
 // var mydefaultmodule = _entry_return_.default;
 // 这里踩过坑，所以说明一下，不配置的话遇到的问题是引入的ui组件库没法解构
 libraryexport: 'default',
 },
 resolve: {
 extensions: ['.js', '.vue', '.json'],
	// 'element-ui': path.resolve(__dirname, '../')
	// alias中的'element-ui'作为npm包抛出后指向了业务项目node_modules所在的npm包路径
 alias: config.alias
 },
 externals: {
 // 构建只排除vue
 // umd模块通过cdn形式引入，因此将所有的组件、utils、i18n等构建在内
 // umd模块没有按需引入功能
 vue: config.vue
 },
 // ...忽略
};

lib
├── element-ui.common.js 		# commonjs2 总文件 

// build/webpack.common.js

// ...忽略

module.exports = {
 mode: 'production',
 entry: {
 app: ['./src/index.js']
 },
 output: {
 path: path.resolve(process.cwd(), './lib'),
 publicpath: '/dist/',
 filename: 'element-ui.common.js',
 chunkfilename: '[id].js',
 libraryexport: 'default',
 library: 'element',
 // 生成commonjs2模块
 librarytarget: 'commonjs2'
 },
 resolve: {
 extensions: ['.js', '.vue', '.json'],
	// 'element-ui': path.resolve(__dirname, '../')
 alias: config.alias,
 modules: ['node_modules']
 },
 // 这里用于排除ui组件、支持国际化、utils方法的源代码，这些源代码需要额外的脚本进行构建
 externals: config.externals,
 optimization: {
 // commonjs2无须压缩处理
 minimize: false
 },
 // ...忽略
};

[{ 
 vue: 'vue',
 // 排除所有ui组件的源代码
 'element-ui/packages/option'：'element-ui/lib/option',
 // ...
 // 排除国际化的源代码
 'element-ui/src/locale': 'element-ui/lib/locale',
 // 排除utils方法的源代码
 'element-ui/src/utils/vue-popper': 'element-ui/lib/utils/vue-popper',
 'element-ui/src/mixins/emitter': 'element-ui/lib/mixins/emitter',
 'element-ui/src/transitions/collapse-transition': 'element-ui/lib/transitions/collapse-transition' 
 // ...
 },
 // var nodeexternals = require('webpack-node-externals');
 // nodeexternals()
 [function] 
];

// pagination组件中需要用到option组件
import eloption from 'element-ui/packages/option';
// ...

// lib/element-ui.common.js
module.exports = require("element-ui/lib/option");

// 排除utils源码(utils源码会通过`npm run build:utils`脚本构建)
module.exports = require("element-ui/lib/utils/dom");
// 排除vue
module.exports = require("vue");
// 排除国际化源码(国际化源码会通过`npm run build:utils`脚本构建)
module.exports = require("element-ui/lib/locale");
// 需要注意和vue相关的jsx依赖（vue cli3系统构建的包也会有一个该功能的依赖）
module.exports = require("babel-helper-vue-jsx-merge-props");
// 排除一些elment组件使用的其他依赖
module.exports = require("throttle-debounce/throttle"); 
// 排除ui组件源码(ui组件源码会通过`webpack --config build/webpack.component.js`脚本构建)
module.exports = require("element-ui/lib/option");

lib
├── alert.js     # commonjs 组件
├── aside.js
├── button.js
├── ...

// ...忽略
const components = require('../components.json');

// components是所有组件的构建入口列表
// {
// "pagination": "./packages/pagination/index.js",
// ...
// "timeline-item": "./packages/timeline-item/index.js"
// }


const webpackconfig = {
 mode: 'production',
 // 多入口
 entry: components,
 output: {
 path: path.resolve(process.cwd(), './lib'),
 publicpath: '/dist/',
 filename: '[name].js',
 chunkfilename: '[id].js',
 librarytarget: 'commonjs2'
 },
 resolve: {
 extensions: ['.js', '.vue', '.json'],
 alias: config.alias,
 modules: ['node_modules']
 },
 // 排除其他ui组件、支持国际化、utils的源码，这些源码会额外构建
 externals: config.externals,
 },
 // ...忽略
};

"build:utils": "cross-env babel_env=utils babel src --out-dir lib --ignore src/index.js",

lib
├── directives     # commonjs 指令
├── locale      # commonjs 国际化api和语言包
├── mixins  		# commonjs 混入
├── transitions			# commonjs 过度动画
├── utils      # commonjs 工具方法

{
 "presets": [
 [
  "env",
  {
  "loose": true,
  "modules": false,
  "targets": {
   "browsers": ["> 1%", "last 2 versions", "not ie <= 8"]
  }
  }
 ],
 "stage-2"
 ],
 "plugins": ["transform-vue-jsx"],
 "env": {
 // cross-env babel_env=utils
 "utils": {
  "presets": [
  [
   "env",
   {
   // 松散模式，更像人手写的es5代码
   "loose": true,
   // es6转成commonjs
   "modules": "commonjs",
   "targets": {
    "browsers": ["> 1%", "last 2 versions", "not ie <= 8"]
   }
   }
  ],
  ],
  "plugins": [
  ["module-resolver", {
   "root": ["element-ui"],
   "alias": {
   // 类似于webpack的externals功能
   // 将源代码的引入路径更改成目标代码的引入路径
   "element-ui/src": "element-ui/lib"
   }
  }]
  ]
 },
 "test": {
  "plugins": ["istanbul"]
 }
 }
}

lib
├── theme-chalk 		# css 样式文件
│ ├── fonts     # icons
│ ├── alert.css    # 按需引入的组件样式
│ ├── ...      # 按需引入的组件样式
│ └── index.css    # 完整引入样式

'use strict';

const { series, src, dest } = require('gulp');
const sass = require('gulp-sass');
const autoprefixer = require('gulp-autoprefixer');
const cssmin = require('gulp-cssmin');

function compile() {
 return src('./src/*.scss')
 // sass转化成css
 .pipe(sass.sync())
 // parse css and add vendor prefixes to rules by can i use 
 // css浏览器兼容处理
 .pipe(autoprefixer({
  browsers: ['ie > 9', 'last 2 versions'],
  cascade: false
 }))
 // 压缩css
 .pipe(cssmin())
 .pipe(dest('./lib'));
}

function copyfont() {
 return src('./src/fonts/**')
 .pipe(cssmin())
 .pipe(dest('./lib/fonts'));
}

exports.build = series(compile, copyfont);

{
 "useconfigfiles": true,
 "router": true,
 "routerhistorymode": true,
 "vuex": false,
 "csspreprocessor": "less",
 // mac os x下生效，windows下不生效，具体未深入研究
 "packagemanager": "yarn",
 "plugins": {
 "@vue/cli-plugin-babel": {},
 "@vue/cli-plugin-eslint": {
  "linton": ["save", "commit"]
 },
 "@ziyi2/vue-cli-plugin-ui-base": {},
 "@ziyi2/vue-cli-plugin-ui-cz": {},
 "@ziyi2/vue-cli-plugin-ui-lint": {}
 }
}

// 可能获取会有点慢，大家耐心等待
vue create --preset ziyi2/vue-cli3-lerna-ui my-project

vue create --preset preset.json my-project

// 启动开发服务
"serve": "vue-cli-service serve",
// 生成静态资源
"build": "vue-cli-service build",
// eslint校验
"lint": "vue-cli-service lint",
// 安装和链接lerna repo的依赖
"bootstrap": "lerna bootstrap",
// 更新升级日志
"cz:changelog": "conventional-changelog -p angular -i changelog.md -s && git add changelog.md",
// 构建
"lib": "lerna run lib"

lerna bootstrap

.
├── packages     		# workspaces
│ ├── alert    		# 警告（不构建）
│ │  ├── alert.vue  		# 组件源码
│ │  ├── index.js  		# npm包入口文件
│ │  └── package.json 		# npm包描述文件
│ ├── btn     		# 按钮
│ │  ├── lib  	  		# 目标文件
│ │  │ └── lib.common.js	# npm包入口文件
│ │  ├── btn.vue  		# 组件源码
│ │  ├── index.js  		# 构建入口文件
│ │  ├── package.json 		# npm包描述文件(需要vue cli的开发态依赖)
│ │  └── vue.config.js 		# 构建配置文件
│ ├── locale    		# 国际化
│ │  ├── lang  	  	# 语言包
│ │  │ ├── enjs 		# 英文
│ │  │ └── zh_cn.js		# 中文
│ │  ├── mixins  		# 各个组件调用的国际化api
│ │  ├── src  		# 源码
│ │  ├── index.js  		# npm包入口文件
│ │  ├── alert.vue  		# 组件源码
│ │  ├── index.js  		# npm包入口文件
│ │  └── package.json 		# npm包描述文件
│ ├── select    		# 选择器(类似于alert)
│ ├── theme    		# 样式
│ │  ├── lib  	  		# 目标文件
│ │  │ ├── alert.css 		# 警告样式
│ │  │ ├── btn.css 		# 按钮样式
│ │  │ ├── index.css 		# 总体样式
│ │  │ └── select.css		# 选择器样式
│ │  ├── src  	  		# 源文件
│ │  │ ├── utils 		# 通用方法和变量
│ │  │ ├── alert.less		# 警告样式
│ │  │ ├── btn.less 		# 按钮样式
│ │  │ ├── index.less 	# 总体样式
│ │  │ └── select.less		# 选择器样式
│ │  ├── gulpfile.js  	 	# 构建配置文件
│ │  └── package.json 		# npm包描述文件
│ └── utils    		# 工具方法
│   ├── lib  		# 目标文件（这里也可以采用lodash的方式，去掉lib文件夹这一层）
│   ├── src  		# 源文件
│   ├── babel.config.js		# 构建配置文件
│   └── package.json 		# npm包描述文件
├── public     		# 公共资源目录
├── src      		# 开发态目录
├── .browserslistrc     	# ui框架目标浏览器配置
├── .cz-config.js      	# cz定制化提交说明配置
├── .gitignore      	# git忽略配置
├── .lintstagedrc			# lint-staged配置
├── babel.config.js			# vue cli的babel配置
├── lerna.json				# lerna配置
├── package.json			# vue cli容器描述文件（容器不是npm包）
├── postcss.config.js			# postcss配置
├── readme.md				# 说明
└── vue.common.js			# 通用的组件构建配置文件