【总结】1193- 记一次搭建业务平台组件库的过程

350次阅读  |  发布于3年以前

拓展阅读：[【总结】- 从 0 到 1 上手 Web Components 业务组件库开发]

前言

因业务平台扩大，组件越来越丰富，想通过抽离组件（包含功能组件，业务组件，基础组件）的方式分享给公司更多的小伙伴使用，所以有了这样的一次分享。

接下来，我将对自己的这次所学所得做一次总结。

耐心看完，你将收获到：

通过什么方式进行项目管理

背景

本着调研的目的去思考如何在开发一个组件库时，是将这些package放在一个仓库里维护还是放在多个仓库里单独维护？或者说一个仓库想基于多个不同框架开发的组件库，那么如何去管理呢？

那是将每个组件当成一个package进行管理（即多项目多仓库的形式，也称为Multirepo），还是用一个仓库去管理多个package(即Monorepo)

可能上述的表达有点抽象，用实例来看看两者的区别：

image.png

解决

为了降低多package项目的维护成本，我使用lerna作为流程管理工具。

// 进入项目文件夹
cd DDMC-UI- 
// 初始化 
lerna init
复制代码
DDMC-UI /
  packages /
  package.json
  lerna.json
复制代码

lerna.json是为Lerna的管理配置文件，在搭建过程中我是采用的是lerna的固定模式。那什么是固定模式呢？

固定模式的Lerna项目是在一条单一的版本线上操作的，这个版本是在项目根目录的 lerna.json文件中的 version字段中控制的。当执行 lerna publish时，如果一个模块自上次发布以来有更新，它将会更新为你要发布的新的版本，这意味着你只需在需要时发布新版本的package。

DDMC-UI /
  config /  
  example / 
      app.js
      index.html
  packages /
      demo1 /
          index.vue
          index.js
      demo2 /
          index.vue
          index.js
      index.js
  src /
      utils /
      common /
  package.json
  lerna.json
复制代码

webpack 构建项目

地基是打好了，但是作为打工人还要考虑项目如何构建。在构建项目这个过程中，我通过使用webpack实现项目的构建。

组件库demo环境，组件库开发环境以及组件库编译打包生成资源的存放位置，都是基于webpack的配置来实现。具体的配置目录是通过config文件。

项目中的example文件就是demo环境。它是给用户查看组件具体用法的例子。

创建dev.config.js- 新增开发环境的配置：

image.png

创建pro.config.js- 新增生产环境的配置：

image.png

这2个文件分别都是对应开发环境和生产环境的配置，组件可以在package文件下开发，example文件进行使用。

创建lib.config.js- 新增组件库编译打包生成资源的存放位置配置：

image.png

生成的lib文件主要是作为组件库发布到npm的一个入口文件。所以针对的入口是packages下的组件。

基于上面的配置之后，我们来实现package.json命令配置：

image.png

将文件区分开来，知道每个文件是用来干嘛的，分工明确是第一步其实是重要的。

我还创建了一个base.config.js是公共的配置文件。这个文件实现了一些基础配置：

自动化将组件注册为全局组件

为了避免使用组件的时候频繁的import...导入操作,我们可以将其注册为全局组件。需要用到Vue.component()和Vue.use()两个方法。

先来看看一个demo组件的目录结构：

demo
├—— index.vue  # 组件实现
│ 
└── index.js # 每个组件install方法，供全局引入
index.js 提供install方法，供Vue.use()使用 

复制代码

将组件注册为全局组件，具体的代码实现如下：

const fs=require('fs');
const path=require('path');
var endOfLine = require('os').EOL;
const render = require('json-templater/string');

const IMPORT_TEMPLATE='import {{name}} from \'./index.vue\';';
const USE_TEMPLATE='Vue.component({{name}}, {{component}});';
const MAIN_TEMPLATE=`
{{include}}
{{component}}.install = function (Vue) {
    {{list}}
};
export default {{component}};
`

const files=fs.readdirSync('./packages');

const folder =files.slice(0,-1)

console.log(folder)


const includeComponentTemplate = [];
const listComponentTemplate =[];

const writeFile=function(file,include,list){
    const p=path.resolve(__dirname,`../packages/${file}/index.js`);
    fs.writeFileSync(p,render(MAIN_TEMPLATE,{
        include:include,
        list: list,
        component:file
    }));
}

folder.forEach((item)=>{
    const include=render(IMPORT_TEMPLATE,{
        name:item,
        component:item,
    });
    const list=render(USE_TEMPLATE,{
        name:item,
        component:item,
    });
    writeFile(item,include,list);
});

复制代码

主要思路是组件提供install方法，并使用Vue.component()注册成全局组件。脚本中通过模块json-templater可以在js和json对象上进行胡子样式模板替换。执行命令：npm run build:cp，生成的demo文件下的index.js代码：

image.png

将组件注册为全局组件之后，需要在index.js引入。也是通过脚本自动化引入，具体的实现可参考如上代码。通过执行命令：npm run build:pck，生成的代码：

image.png

如何实现按需引入

开发完组件库之后，在其他所需该组件的项目中，我们班可以通过import XXX from 'ddmc-ui'。这样的方式叫做全局引入，将组件库都引入到所需的项目中。

那如何实现按需引入呢？例如import {XXX} from 'ddmc-ui/lib/demo'

注意：这里的按需引入是指你所开发的项目中需要按需引入这个组件库

要想实现如上的方式引入组件，我们需要把组件一个一个单独打包的，所以要获取每个组件的路径。通过webpack配置，将输出lib目录要和packages目录结构一致。在lib.config.js配置需要更改。

主要是获取packages文件的目录是关键点，如下代码可实现获取入口对象：

function getEntries(path) {
  let files =  fs.readdirSync(resolve(path));
  const entries = files.reduce( (ret, item) => {
        const itemPath =`${path}/${item}`;
        const isDir =  fs.statSync(resolve(itemPath)).isDirectory();
        console.log(isDir,itemPath)
        if (isDir) {
            ret[item] = resolve(join(itemPath, 'index.js'));
        } else {
            const [name] = item.split('.');
            ret[name] = resolve(itemPath);
        }
        return ret;
  }, {})
  return entries;
}

复制代码

好了，到这里组件库的按需引入是完成了。但是有个缺点，就是每次使用按需引入就要写一大串import {XXX} from 'ddmc-ui/lib/demo'这样的引入方式。

这个时候就需要用到babel-plugin-import这个插件了。

注意：babel-plugin-import是指你所开发的项目中用到并修改其配置

具体的配置是：

// .babelrc
{
    ...
    "plugins":[
        "import", {
            "libraryName": "ddmc-ui",
        }
    ]
}

复制代码

约束规范

组件库的管理和构建功能都有了，但是在多人共建的一个项目中，必须得有一个规范去进行约束，而规范除了书面上的阐述外，还需要一些自动化的、强制性的约束。所以需要在代码提交前对每个打工仔的代码进行一遍验证，防止乱提交。

husky 给GIT提交添加钩子执行一些我们需要做的验证，并执行一些脚本去验证代码是否有问题是否规范。

lint-staged 是一个在git暂存文件上运行linters的工具。可以搭配husky进行git commit前的代码校验。

commitlint 提交信息校验，基于以上的两个工具包，我们有能力在Git的钩子里做一些事情。首先不得不提的是代码的提交规范和规范的校验，优雅的提交方便团队协作和快速定位问题。

一般GIT比较常见的提交格式规范是：<type>: <subject>。

实现约束规范的过程：

npm install -D husky lint-staged

复制代码
npx husky install
npx husky add .husky/pre-commit "npm run test"
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
复制代码
"lint-staged": { "src/* */* .{js,json,vue,ts,tsx}": [ "npm run lint" ] }
复制代码
module.exports = { extends: ['@commitlint/config-conventional'] }
复制代码

如何将一个组件库发布到npm上

在package.json配置：

{
  "name": "foxit-ui"
}
复制代码

注意：这个组件库名称要在 npm 上是独一无二，不能重复，否则发布时会提示你无权限修改此库

{
   "private": true
}
复制代码
{
  "description": "XXX 组件库",
  "keywords": [
    "element",
    "vue",
    "ddmc-ui"
  ],
  "author": "hhl"
}

复制代码
{
  "main": "lib/index/index.js"
}
复制代码

一个组件库只有编译后的 lib 文件夹、package.json 文件、README.md 文件才是需要被发布的。其他都不需要的，需要在根目录下创建一个 .npmignore 文件中把没必要发布的资源忽略掉，减少依赖包大小。

思考

在搭建的过程，主要是工具包之间本身的版本兼容问题，还有就是和node版本相关的问题。

过程中使用vue-loader的高版本出现了Error: Cannot find module 'webpack/lib/RuleSet'。查阅vue-loader源码最后解决方案是降低版本。

虽然整体上的仓库以及组件库已完成，但是随着仓库的扩大还是需要迭代优化的。也可以从webpack配置进行优化。

因时间的关系比较赶，后续将会慢慢迭代上去。

总结

以上是我从零开发一款组件库遇到的问题踩过的坑总结下来并实际使用的工具和方法，希望能给大家带来帮助。

除了上面提到的这些比较常用的工具和方法外，对于前端工程化/自动化还有很多探索和学习。

觉得不错给文章点个赞，是对我最大的支持和鼓励

Copyright© 2013-2020

All Rights Reserved 京ICP备2023019179号-8