经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » JS/JS库/框架 » Vue.js » 查看文章
浅谈Vue CLI 3结合Lerna进行UI框架设计
来源:jb51  时间:2019/4/15 8:38:25  对本文有异议

当前大部分UI框架设计的Webpack配置都相对复杂,例如 Element Ant Design Vue Muse-UI等Vue组件库。例如Element,为了实现业务层面的两种引入形式( 完整引入按需引入 ),以及抛出一些可供业务层面通用的 utilsi18n 等,Webpack配置变得非常复杂。为了简化UI框架的设计难度,这里介绍一种简单的UI框架设计,在此之前先简单介绍一下 Element 的构建流程,以便对比新的UI框架设计。

一般组件库的设计者将引入形式设计成 完整引入按需引入 两种形式: 完整引入 的开发相对便利,针对一些大型业务或者对于打包体积不是特别注重的业务, 按需引入 开发的颗粒度相对精细,可以减少业务的打包体积。

设计的UI框架实践项目的github地址是ziyi2/vue-cli3-lerna-ui,包括了preset.json、自己设计的Vue CLI插件以及自己设计的一系列UI组件(和生成的UI框架示例稍有不同),如果觉得整体结构有不合理的或者考虑不够全面的地方,欢迎大家提issue,这样我也可以对它进行完善。如果大家感兴趣,希望大家能够Star一下,这里拜谢大家了!

Element

首先了解 Element 的构建流程,查看 Element 2.7.0 版本 package.jsonnpm 脚本

  1. // 其中的`node build/bin/build-entry.js` 生成Webpack构建入口
  2. "build:file": "node build/bin/iconInit.js & node build/bin/build-entry.js & node build/bin/i18n.js & node build/bin/version.js",
  3. // 构建css样式
  4. "build:theme": "node build/bin/gen-cssfile && gulp build --gulpfile packages/theme-chalk/gulpfile.js && cp-cli packages/theme-chalk/lib lib/theme-chalk",
  5. // 构建commonjs规范的`utils`
  6. "build:utils": "cross-env BABEL_ENV=utils babel src --out-dir lib --ignore src/index.js",
  7. // 构建umd模块的语言包
  8. "build:umd": "node build/bin/build-locale.js",
  9. // 清除构建文件夹`lib`
  10. "clean": "rimraf lib && rimraf packages/*/lib && rimraf test/**/coverage",
  11. // 总体构建
  12. "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",
  13. // 执行eslint校验
  14. "lint": "eslint src/**/* test/**/* packages/**/* build/**/* --quiet"

这里重点关注Element的构建脚本,忽略 测试、发布、启动开发态调试页面、构建演示页面 等脚本。

npm run dist

Element 构建相关的npm脚本繁多,但是 总体构建脚本dist

"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"

&& 是继发执行,只有当前任务成功,才能执行下一个任务。

总体构建脚本包含了以下按顺序执行的脚本命令

  • npm run clean - 清除构建文件夹lib
  • npm run build:file - 其中的node build/bin/build-entry.js 生成Webpack构建入口
  • npm run lint - 执行eslint校验
  • webpack --config build/webpack.conf.js - 构建umd总文件
  • webpack --config build/webpack.common.js - 构建commonjs2总文件
  • webpack --config build/webpack.component.js - 构建commonjs2组件(提供按需引入)
  • npm run build:utils - 构建commonjs的utils(供commonjs2总文件、commonjs2组件以及业务使用)
  • npm run build:umd - 构建umd语言包
  • npm run build:theme - 构建css样式

如果对于对于 umdcommonjs2amd 等模块定义不是特别清晰,可参考Webpack文档模块定义系统

执行 npm run dist 后会在当前根目录生成新的 lib 文件夹,包含以下构建内容:

  1. lib
  2. ├── directives # commonjs指令(这里归为utils)
  3. ├── locale # commonjs国际化(commonjs语言包和API)
  4. ├── mixins # commonjs mixins(这里归为utils)
  5. ├── theme-chalk # css 样式文件
  6. ├── transitions # commonjs transitions(这里归为utils)
  7. ├── umd # umd语言包
  8. ├── utils
  9. ├── alert.js # commonjs组件
  10. ├── aside.js
  11. ├── ...
  12. ├── element-ui.common.js # commonjs2总文件
  13. ├── ...
  14. ├── index.js # umd总文件
  15. ├── ...

Element官方文档的使用指南结合 lib 可以看出, Element 为我们提供了以下能力:

1、CDN引入(umd 总文件)
2、npm包完整引入(抛出commonjs2总文件)
3、按需引入(抛出commonjs2的所有UI组件)
4、支持国际化
5、提供utils方法(官方文档没有说明,但事实上业务可以使用)

CDN引入的umd总文件一般是全量构建的,不会有依赖问题,但是commonjs2模块的文件需要在业务层面再次使用Webpack构建。例如需要在业务层面支持 国际化提供utils 的功能,那么就不能将 国际化提供utils 的代码 bundlecommonjs2总文件commonjs2的所有UI组件 中(每一个组件都 bundle utils 的方法或者国际化API显然是不合理的),如果需要在业务层面支持 按需引入 的功能,那么不建议将 所有UI组件 的源码 bundlecommonjs2总文件 中,这样便可以实现层层引用,对外抛出功能的同时在业务层面可以防止Webpack二次打包,从而导致引入两遍甚至多遍相同的代码的问题。

在组件库中开发时,为了构建commonjs2模块的文件,需要对各个 utils 、组件等引入的路径做出强约定,这样不仅产生的Webpack配置会变得很难维护,对于开发者的开发也需要做出一定的规范限制。

接下来分析一下各个脚本的构建功能。

npm run build:file

build:file 脚本是自动生成一些源码文件的脚本:

"build:file": "node build/bin/iconInit.js & node build/bin/build-entry.js & node build/bin/i18n.js & node build/bin/version.js",

其中与构建相关的脚本是 node build/bin/build-entry.js ,主要用于生成Webpack构建的入口源文件 src/index.js

  1. // 注释说明该文件由build-entry.js脚本自动生成
  2. /* Automatically generated by './build/bin/build-entry.js' */
  3.  
  4. import Pagination from '../packages/pagination/index.js';
  5. // ... 这里省略大部分组件引入
  6. import TimelineItem from '../packages/timeline-item/index.js';
  7. import locale from 'element-ui/src/locale';
  8. import CollapseTransition from 'element-ui/src/transitions/collapse-transition';
  9.  
  10. const components = [
  11. Pagination,
  12. // ... 这里省略大部分组件
  13. TimelineItem,
  14. CollapseTransition
  15. ];
  16.  
  17. const install = function(Vue, opts = {}) {
  18. locale.use(opts.locale);
  19. locale.i18n(opts.i18n);
  20.  
  21. components.forEach(component => {
  22. Vue.component(component.name, component);
  23. });
  24.  
  25. Vue.use(Loading.directive);
  26.  
  27. Vue.prototype.$ELEMENT = {
  28. size: opts.size || '',
  29. zIndex: opts.zIndex || 2000
  30. };
  31.  
  32. Vue.prototype.$loading = Loading.service;
  33. // ...
  34. };
  35.  
  36. /* istanbul ignore if */
  37. if (typeof window !== 'undefined' && window.Vue) {
  38. install(window.Vue);
  39. }
  40.  
  41. export default {
  42. version: '2.7.0',
  43. locale: locale.use,
  44. i18n: locale.i18n,
  45. install,
  46. CollapseTransition,
  47. Loading,
  48. Pagination,
  49. // ... 这里省略大部分组件
  50. TimelineItem
  51. };

在组件的开发过程中如果组件较多,建议使用脚本自动生成构建入口文件。

npm run lint

构建之前使用 lint 脚本对构建的源码文件进行 eslint 校验:

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

Elementeslint 做了严格控制,一旦 eslint 报错那么 dist 总体构建脚本 执行停止,整体构建失败。这里的 eslint 校验可以使用eslint-loader 进行处理(如果你希望 eslint 校验失败也可以进行构建可以查看Errors and Warning )。

webpack --config build/webpack.conf.js

webpack --config build/webpack.conf.js 脚本用于构建umd总文件,执行该脚本最终会在 lib 下生成 index.js 文件:

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

webpack.conf.js 配置如下:

  1. // build/webpack.conf.js
  2.  
  3. // ...忽略
  4.  
  5. module.exports = {
  6. mode: 'production',
  7. // 指定入口文件src/index.js,该入口文件由`build:file`脚本自动生成
  8. entry: {
  9. app: ['./src/index.js']
  10. },
  11. output: {
  12. // 在lib文件中生成
  13. path: path.resolve(process.cwd(), './lib'),
  14. // 生成lib/index.js
  15. filename: 'index.js',
  16. // 生成umd模块
  17. libraryTarget: 'umd',
  18. // src/index.js文件采用export default语法抛出,因此需要设置libraryExport
  19. // 否则引入的UI组件库需要使用.default才能引用到抛出的对象
  20. // if your entry has a default export of `MyDefaultModule`
  21. // var MyDefaultModule = _entry_return_.default;
  22. // 这里踩过坑,所以说明一下,不配置的话遇到的问题是引入的UI组件库没法解构
  23. libraryExport: 'default',
  24. },
  25. resolve: {
  26. extensions: ['.js', '.vue', '.json'],
  27. // 'element-ui': path.resolve(__dirname, '../')
  28. // alias中的'element-ui'作为npm包抛出后指向了业务项目node_modules所在的npm包路径
  29. alias: config.alias
  30. },
  31. externals: {
  32. // 构建只排除vue
  33. // umd模块通过CDN形式引入,因此将所有的组件、utils、i18n等构建在内
  34. // umd模块没有按需引入功能
  35. vue: config.vue
  36. },
  37. // ...忽略
  38. };

构建文件 lib/index.js 主要的功能是用于CDN形式引入项目,并且无法做到按需加载,产生的体积非常大,对于简单的应用可能不适用。

webpack --config build/webpack.common.js

webpack --config build/webpack.common.js 脚本用于构建commonjs2总文件,执行该脚本最终会在 lib 下生成 element-ui.common.js 文件:

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

由于该文件需要在业务层面再次使用Webpack构建,因此考量的方面较多。在分析Webpack配置之前,再次回顾一下 Element 能为我们做什么:

1、完整引入(抛出commonjs2总文件)
2、按需引入(抛出commonjs2的所有UI组件)
3、支持国际化(commonjs2)
4、提供utils方法(commonjs2,当然官方没有对外说明

webpack --config build/webpack.common.js 脚本主要用于构建完整引入功能,同时为了可以在业务层面抛出 按需引入、支持国际化 等功能,构建 element-ui.common.js 时需要将 UI组件、支持国际化、utils方法 的源代码排除。

webpack.common.js 配置如下:

  1. // build/webpack.common.js
  2.  
  3. // ...忽略
  4.  
  5. module.exports = {
  6. mode: 'production',
  7. entry: {
  8. app: ['./src/index.js']
  9. },
  10. output: {
  11. path: path.resolve(process.cwd(), './lib'),
  12. publicPath: '/dist/',
  13. filename: 'element-ui.common.js',
  14. chunkFilename: '[id].js',
  15. libraryExport: 'default',
  16. library: 'ELEMENT',
  17. // 生成commonjs2模块
  18. libraryTarget: 'commonjs2'
  19. },
  20. resolve: {
  21. extensions: ['.js', '.vue', '.json'],
  22. // 'element-ui': path.resolve(__dirname, '../')
  23. alias: config.alias,
  24. modules: ['node_modules']
  25. },
  26. // 这里用于排除UI组件、支持国际化、utils方法的源代码,这些源代码需要额外的脚本进行构建
  27. externals: config.externals,
  28. optimization: {
  29. // commonjs2无须压缩处理
  30. minimize: false
  31. },
  32. // ...忽略
  33. };

重点需要关注一下 config.externals 属性,打印输出该变量的值:

  1. [{
  2. vue: 'vue',
  3. // 排除所有UI组件的源代码
  4. 'element-ui/packages/option''element-ui/lib/option',
  5. // ...
  6. // 排除国际化的源代码
  7. 'element-ui/src/locale': 'element-ui/lib/locale',
  8. // 排除utils方法的源代码
  9. 'element-ui/src/utils/vue-popper': 'element-ui/lib/utils/vue-popper',
  10. 'element-ui/src/mixins/emitter': 'element-ui/lib/mixins/emitter',
  11. 'element-ui/src/transitions/collapse-transition': 'element-ui/lib/transitions/collapse-transition'
  12. // ...
  13. },
  14. // var nodeExternals = require('webpack-node-externals');
  15. // nodeExternals()
  16. [Function]
  17. ];

externals属性可以将一些特定的依赖从输出的bundle中排除,例如在开发态中组件之间有依赖关系, element-ui/packages/pagination 中引入 element-ui/packages/option 组件:

pagecages/pagination/src/pagination.js

  1. // pagination组件中需要用到option组件
  2. import ElOption from 'element-ui/packages/option';
  3. // ...

Webpack构建后,可以发现在 element-ui.common.js 中并没有将 element-ui/packages/option 组件打包在内,而只是更改了它的引入路径 element-ui/lib/option (在实现 按需引入 功能时会用 webpack --config build/webpack.component.js 脚本构建出该文件)。

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

因此以上列出的 config.externals 属性的 keyvalue 可以排除 UI组件、支持国际化、utils方法 功能的代码。

config.externals 属性的最后一个值是 [Function] ,是由webpack-node-externals 生成的。这里解释一下 webpack-node-externals 的作用:

Webpack allows you to define externals - modules that should not be bundled. When bundling with Webpack for the backend - you usually don't want to bundle its node_modules dependencies. This library creates an externals function that ignores node_modules when bundling in Webpack.

例如在 Elment 组件库开发中需要依赖 deepmerge ,那么Webpack构建的时候不需要将该依赖bundle到 element-ui.common.js 中,而是将其添加到 Element 组件库(作为npm包发布)的 dependencies ,这样通过npm安装 Element 的同时也会安装它的依赖 deepmerge ,从而使得 element-ui.common.js 通过 require("deepmerge") 的形式引入该依赖不会报错。

这里列出 element-ui.common.js 排除的一些代码:

  1. // 排除utils源码(utils源码会通过`npm run build:utils`脚本构建)
  2. module.exports = require("element-ui/lib/utils/dom");
  3. // 排除vue
  4. module.exports = require("vue");
  5. // 排除国际化源码(国际化源码会通过`npm run build:utils`脚本构建)
  6. module.exports = require("element-ui/lib/locale");
  7. // 需要注意和Vue相关的JSX依赖(Vue CLI3系统构建的包也会有一个该功能的依赖)
  8. module.exports = require("babel-helper-vue-jsx-merge-props");
  9. // 排除一些Elment组件使用的其他依赖
  10. module.exports = require("throttle-debounce/throttle");
  11. // 排除UI组件源码(UI组件源码会通过`webpack --config build/webpack.component.js`脚本构建)
  12. module.exports = require("element-ui/lib/option");

需要注意 Element 发布的npm包入口文件就是 element-ui.common.js ,可以通过package.json中的 main 字段信息查看。

webpack --config build/webpack.component.js

webpack --config build/webpack.component.js 脚本用于构建commonjs2的UI组件(提供按需引入功能),执行该脚本最终会在 lib 下生成所有 Element 支持的UI组件(同时这些文件也会被 element-ui.common.js 总入口文件引用):

  1. lib
  2. ├── alert.js # commonjs 组件
  3. ├── aside.js
  4. ├── button.js
  5. ├── ...

查看 build/webpack.component.js 配置:

  1. // ...忽略
  2. const Components = require('../components.json');
  3.  
  4. // Components是所有组件的构建入口列表
  5. // {
  6. // "pagination": "./packages/pagination/index.js",
  7. // ...
  8. // "timeline-item": "./packages/timeline-item/index.js"
  9. // }
  10.  
  11.  
  12. const webpackConfig = {
  13. mode: 'production',
  14. // 多入口
  15. entry: Components,
  16. output: {
  17. path: path.resolve(process.cwd(), './lib'),
  18. publicPath: '/dist/',
  19. filename: '[name].js',
  20. chunkFilename: '[id].js',
  21. libraryTarget: 'commonjs2'
  22. },
  23. resolve: {
  24. extensions: ['.js', '.vue', '.json'],
  25. alias: config.alias,
  26. modules: ['node_modules']
  27. },
  28. // 排除其他UI组件、支持国际化、utils的源码,这些源码会额外构建
  29. externals: config.externals,
  30. },
  31. // ...忽略
  32. };

构建单个组件和构建总体入口文件 element-ui.common.js 的Webpack配置类似,需要将 utilslocale 以及其他一些依赖排除。

npm run build:utils

build:utils 脚本主要用于构建commonjs的 utils (提供国际化以及 utils 功能):

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

可以发现该命令并不是通过Webpack进行多文件构建,而是通过Babel直接进行转义处理(Webpack构建会产生额外的Webpack代码,并且配置繁琐,Babel转义处理构建的代码非常干净),将 src 目录下除了Webpack构建入口文件 src/index.js 以外的所有其他文件进行转义处理。执行该脚本最终会在 lib 下生成所有的 utils 文件:

  1. lib
  2. ├── directives # commonjs 指令
  3. ├── locale # commonjs 国际化API和语言包
  4. ├── mixins # commonjs 混入
  5. ├── transitions # commonjs 过度动画
  6. ├── utils # commonjs 工具方法

生成的这些工具方法会被 lib 下的 element-ui.common.js 和各个组件引用,同时在业务层面也可以引用这些工具方法。查看 .babelrc 文件的配置信息:

  1. {
  2. "presets": [
  3. [
  4. "env",
  5. {
  6. "loose": true,
  7. "modules": false,
  8. "targets": {
  9. "browsers": ["> 1%", "last 2 versions", "not ie <= 8"]
  10. }
  11. }
  12. ],
  13. "stage-2"
  14. ],
  15. "plugins": ["transform-vue-jsx"],
  16. "env": {
  17. // cross-env BABEL_ENV=utils
  18. "utils": {
  19. "presets": [
  20. [
  21. "env",
  22. {
  23. // 松散模式,更像人手写的ES5代码
  24. "loose": true,
  25. // es6转成commonjs
  26. "modules": "commonjs",
  27. "targets": {
  28. "browsers": ["> 1%", "last 2 versions", "not ie <= 8"]
  29. }
  30. }
  31. ],
  32. ],
  33. "plugins": [
  34. ["module-resolver", {
  35. "root": ["element-ui"],
  36. "alias": {
  37. // 类似于Webpack的externals功能
  38. // 将源代码的引入路径更改成目标代码的引入路径
  39. "element-ui/src": "element-ui/lib"
  40. }
  41. }]
  42. ]
  43. },
  44. "test": {
  45. "plugins": ["istanbul"]
  46. }
  47. }
  48. }

utils 文件源代码之间互相引用的路径是 element-ui/src ,转义成目标代码后互相之间的引用路径是 element-ui/lib ,因此需要有类似于Webpack的 externals 的功能去更改目标代码的引用路径,进行Babel转义时插件babel-plugin-module-resolver 可以实现该功能。

npm run build:theme

build:theme 脚本主要用于构建UI组件的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",

这里主要关注 gulp build --gulpfile packages/theme-chalk/gulpfile.js 脚本,该脚本使用Gulp构建工具构建css样式文件,Glup构建多文件样式会非常简单。最终将当前构建的 packages/theme-chalk/lib 目录下的内容拷贝到 lib/theme-chalk 目录下供外部业务使用:

  1. lib
  2. ├── theme-chalk # css 样式文件
  3. ├── fonts # icons
  4. ├── alert.css # 按需引入的组件样式
  5. ├── ... # 按需引入的组件样式
  6. └── index.css # 完整引入样式

查看 gulpfile.js 文件:

  1. 'use strict';
  2.  
  3. const { series, src, dest } = require('gulp');
  4. const sass = require('gulp-sass');
  5. const autoprefixer = require('gulp-autoprefixer');
  6. const cssmin = require('gulp-cssmin');
  7.  
  8. function compile() {
  9. return src('./src/*.scss')
  10. // sass转化成css
  11. .pipe(sass.sync())
  12. // Parse CSS and add vendor prefixes to rules by Can I Use
  13. // css浏览器兼容处理
  14. .pipe(autoprefixer({
  15. browsers: ['ie > 9', 'last 2 versions'],
  16. cascade: false
  17. }))
  18. // 压缩css
  19. .pipe(cssmin())
  20. .pipe(dest('./lib'));
  21. }
  22.  
  23. function copyfont() {
  24. return src('./src/fonts/**')
  25. .pipe(cssmin())
  26. .pipe(dest('./lib/fonts'));
  27. }
  28.  
  29. exports.build = series(compile, copyfont);

Vue CLI 3 & Lerna

构建整个 Element 组件库的脚本繁多,构建的代码之间互相还有引用关系,对于开发的引用路径也会产生一定的约束。因此设计类似于 Element 的UI框架相对开发者而言需要一定的开发门槛。

这里基于Vue CLI 3的 开发/构建目标/库 能力以及 Lerna 工具设计了一个UI框架,这个UI框架集成了以下特点:

1、 结构特点 :每个UI组件都是一个npm包, 多语言、工具和样式 都是自成体系的npm包,可被业务或UI组件灵活引用,同时天然按需加载。

2、 配置特点 :如果需要进行构建处理,那么每个npm包可单独进行构建配置,配置变得更加简单。结合Vue CLI3的 构件库 能力,对于简单UI组件的构建几乎可以做到webpack零配置,当然需要特殊的webpack loader除外。

3、 发布特点 :组件库的版本迭代可以更快,不需要进行整体构建,每个组件可单独快速发布 PATCHMINOR 版本。

这里设定业务层面需要进行webpack构建处理,因此可以对UI框架的组件不进行构建处理,当然如果UI组件的设计需要特殊的webpack loader处理除外,否则业务层面需要做额外的webpack配置。当然不构建处理是相对于一定的使用场景的,不构建处理可能也会产生额外的一些问题。

这个UI框架的设计也会有一些缺陷:

1、没有完整引入功能(也可以进行整体构建,但是这里不推荐)

2、不提供UMD模块

3、业务层面引入繁琐(可以出额外的引入工具,简化业务中的UI组件引入)

 Vue CLI 3

构建库

为了简化UI框架的webpack配置,这里将Vue CLI 3作为开发的容器引入,借用Vue CLI 3的构建库功能( 构建web-components-组件 功能应该更合适,这里没有进行验证),几乎可以做到UI组件构建的零配置。通过审查项目的-webpack-配置 能力,可以查看Vue CLI 3为我们预先设置的通用webpack配置(几乎可以满足大部分的UI组件构建)。

插件体系

这里使用Vue CLI 3的插件和Preset功能开发了几个插件,以便于快速构建起步的UI设计框架,具体的 preset.json 配置如下:

  1. {
  2. "useConfigFiles": true,
  3. "router": true,
  4. "routerHistoryMode": true,
  5. "vuex": false,
  6. "cssPreprocessor": "less",
  7. // MAC OS X下生效,Windows下不生效,具体未深入研究
  8. "packageManager": "yarn",
  9. "plugins": {
  10. "@vue/cli-plugin-babel": {},
  11. "@vue/cli-plugin-eslint": {
  12. "lintOn": ["save", "commit"]
  13. },
  14. "@ziyi2/vue-cli-plugin-ui-base": {},
  15. "@ziyi2/vue-cli-plugin-ui-cz": {},
  16. "@ziyi2/vue-cli-plugin-ui-lint": {}
  17. }
  18. }

这里采用了官方设计的 @vue/cli-plugin-babel @vue/cli-plugin-eslint 插件,同时自己设计了额外的三个插件来支持整个新的UI框架的起步:

@ziyi2/vue-cli-plugin-ui-base :UI框架基础插件,生成Monorepo结构的源码目录(加入Lerna管理工具),生成基础通用的webpack配置(在VUE CLI 3的webpack配置上进行再配置,VUE CLI3提供了 vue.config.js 文件供开发者进行webpack再配置),提供了几个基础UI组件的示例(仅参考价值)。

@ziyi2/vue-cli-plugin-ui-cz : UI框架的 cz 适配器插件,加入了 cz-customizable commitlint conventional-changelog ,用于生成Angular规范的Git提交说明、检测提交说明是否符合规范以及自动生成UI框架的升级日志等。

@ziyi2/vue-cli-plugin-ui-lint :UI框架的lint-staged 插件,代码提交前会执行Eslint校验,校验不通过则不允许提交辣鸡代码。

这三个插件已经发布在npm的仓库里,如果是已有的Vue CLI 3项目,可直接通过 vue add @ziyi2/ui-cz 等命令进行安装使用,插件源码地址ziyi2/vue-cli3-lerna-ui/plugins ,如果想学习设计Vue CLI 3插件,可参考插件开发指南,不过官方文档可能不够详细,建议参考官方设计的插件或者别人设计的优秀插件。

Lerna

Lerna是一个Monorepo管理工具,使所有的组件(npm包)设计都集成在一个git仓库里,同时可以利用yarn的workspace特性,模拟发布的组件环境,从而使组件的开发和测试变得简单,不需要多次进行组件的发布测试(这里用Lerna进行Vue CLI插件开发也非常方便)。

同时Lerna还集成了版本发布工具,可以快速的对UI框架进行版本发布。

UI组件各自修复问题可以各自快速发布 patch 版本,如果UI组件整体有非兼容性更新,可以利用Lerna进行 MAJOR 版本发布,更多关于版本发布规范可查看语义化版本

UI框架实践

利用Vue CLI 3的远程Preset,这里将自己设计的UI框架分享给大家进行实践使用:

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

如果报错 unable to get local issuer certificate ,可以设置 git config --global http.sslVerify false

如果远程确实获取preset.json失败,可以采用本地的方式,将preset.json 配置复制下来,放入新建的 preset.json 文件,执行以下命令生成UI框架:

  1. vue create --preset preset.json my-project

执行后的生成过程如下:

 

脚本命令

  1. // 启动开发服务
  2. "serve": "vue-cli-service serve",
  3. // 生成静态资源
  4. "build": "vue-cli-service build",
  5. // Eslint校验
  6. "lint": "vue-cli-service lint",
  7. // 安装和链接Lerna repo的依赖
  8. "bootstrap": "lerna bootstrap",
  9. // 更新升级日志
  10. "cz:changelog": "conventional-changelog -p angular -i CHANGELOG.md -s && git add CHANGELOG.md",
  11. // 构建
  12. "lib": "lerna run lib"

如果需要利用GitHub Pages发布静态资源,可以新增命令 "deploy": "npm run build && gh-pages -d dist" ,需要安装 gh-page 依赖。

启动

进入项目目录,使用 yarn serve 命令启动开发态视图,如果是Windows系统,可能会报以下错误:

在Windows下 vue create 可能会采用npm进行依赖安装,MAC OS X下无此问题,此时需要额外使用yarn进行再一次安装操作(这里使用了yarn的workspace特性,因此安装依赖建议都使用yarn进行操作):

  1. lerna bootstrap

执行 yarn serve

这里给出了国际化、选择器、警告以及按钮等UI设计示例。

构建

执行 lerna run lib 后(构建可以配合 npm run lint 校验,校验不通过则构建失败),Lerna工具会对每一个npm包执行 lib 脚本:

这里分别对 utilsbtntheme 包进行了构建处理,其中 btn 采用了Vue CLI 3默认的构建库配置。

Monorepo结构

UI框架生成并构建后的Monorepo结构如下:

  1. .
  2. ├── packages # workspaces
  3. ├── alert # 警告(不构建)
  4. ├── alert.vue # 组件源码
  5. ├── index.js # npm包入口文件
  6. └── package.json # npm包描述文件
  7. ├── btn # 按钮
  8. ├── lib # 目标文件
  9. └── lib.common.js # npm包入口文件
  10. ├── btn.vue # 组件源码
  11. ├── index.js # 构建入口文件
  12. ├── package.json # npm包描述文件(需要vue cli的开发态依赖)
  13. └── vue.config.js # 构建配置文件
  14. ├── locale # 国际化
  15. ├── lang # 语言包
  16. ├── enjs # 英文
  17. └── zh_CN.js # 中文
  18. ├── mixins # 各个组件调用的国际化API
  19. ├── src # 源码
  20. ├── index.js # npm包入口文件
  21. ├── alert.vue # 组件源码
  22. ├── index.js # npm包入口文件
  23. └── package.json # npm包描述文件
  24. ├── select # 选择器(类似于alert)
  25. ├── theme # 样式
  26. ├── lib # 目标文件
  27. ├── alert.css # 警告样式
  28. ├── btn.css # 按钮样式
  29. ├── index.css # 总体样式
  30. └── select.css # 选择器样式
  31. ├── src # 源文件
  32. ├── utils # 通用方法和变量
  33. ├── alert.less # 警告样式
  34. ├── btn.less # 按钮样式
  35. ├── index.less # 总体样式
  36. └── select.less # 选择器样式
  37. ├── gulpfile.js # 构建配置文件
  38. └── package.json # npm包描述文件
  39. └── utils # 工具方法
  40. ├── lib # 目标文件(这里也可以采用lodash的方式,去掉lib文件夹这一层)
  41. ├── src # 源文件
  42. ├── babel.config.js # 构建配置文件
  43. └── package.json # npm包描述文件
  44. ├── public # 公共资源目录
  45. ├── src # 开发态目录
  46. ├── .browserslistrc # UI框架目标浏览器配置
  47. ├── .cz-config.js # cz定制化提交说明配置
  48. ├── .gitignore # git忽略配置
  49. ├── .lintstagedrc # lint-staged配置
  50. ├── babel.config.js # vue cli的babel配置
  51. ├── lerna.json # lerna配置
  52. ├── package.json # vue cli容器描述文件(容器不是npm包)
  53. ├── postcss.config.js # postcss配置
  54. ├── README.md # 说明
  55. └── vue.common.js # 通用的组件构建配置文件

这里重点说明 src 文件, src 文件可以根据开发需要自行选定方案:

1、使用默认的CLI服务进行开发和UI框架Demo演示,这里UI框架采用原生的 .vue 文件形式进行Demo演示,如果想使用 .md 文件进行演示,可以采用vue-markdown-loader

2、使用Vue 驱动的静态网站生成器VuePress,这个目前不是很稳定。 发布

发布

完全可以按照语义化版本进行:

1、各自npm包可以使用 npm publish 快速发布 MINORPATCH 版本。

2、如果某个npm包有非兼容性更新,那么可以使用 lerna publish 发布 MAJOR 版本。

使用Lerna工具发布的npm包建议采用scope的形式发布,UI框架示例没有给出Demo,如果想采用scope形式发布可以查看 ziyi2/vue-cli3-lerna-ui ,需要在每个npm包的 package.json 中做额外的配置,具体可查看 vue-cli3-lerna-ui/plugins/vue-cli-plugin-ui-base/package.json publishConfig 字段信息。

总结

对比Element的UI框架设计,采用Vue CLI 3 & Lerna的形式可以简化UI框架的配置,使各个UI组件的构建配置互相独立,对于简单的UI组件可以利用Vue CLI 3的默认webpack配置。同时采用Monorepo的设计结构( Why is Babel a monorepo? ),配合Lerna工具,可以使得UI框架修复问题和发布新功能的响应能力变得更快。

生成UI框架实践项目的github地址是 ziyi2/vue-cli3-lerna-ui ,包括了 preset.json 、自己设计的Vue CLI插件以及自己设计的一系列UI组件(和生成的UI框架示例稍有不同),如果觉得整体结构有不合理的或者考虑不够全面的地方,欢迎大家提issue,这样我也可以对它进行完善。如果大家感兴趣,希望大家能够Star一下,这里拜谢大家了!

参考链接

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

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号