【上】提高组件库 Level 必做好这六件事

2022-11-17
北京
本文字数：3403 字
阅读完需：约 11 分钟

今天带来一篇不一样的组件库开发文章，强烈推荐先收藏后阅读。

当你看了很多的从 0 到 1 开发的组件库的文章后会发现跟你主流使用的组件库总是天差地别，但又不是不能用。这样的组件库其实就严重缺少了工程化的支撑，缺少了全局的考虑。如果你已经看过了那些文章，那么你将通过这次介绍的 6 件事让你的组件库提升到更高的高度~

1. 留一个好的印象给 Contributor

1.1 背景描述

在 Workspace 模式的项目中各个子包都会有一定的相互依赖存在，当你未能构建某个特定子包时就会造成另外一个子包无法启动，为了避免这样的问题出现，也为了给 Contributor 留下一个好的印象，我决定在你拿到项目安装依赖之后就帮你把该做的事情都做好，达到开箱即可体验的目的。

1.2 回归案例

在这次的案例中按 Workspace 模式开发的组件库项目包含了有 ui、docs 和 example 三个子包，其中 docs 和 example 都依赖 ui 子包构建后的产物，那么我需要做的就是在你安装项目依赖后自动实现 ui 包构建。

1.3 技术调研

在查看NPM文档后得知在执行依赖安装前后其实都会触发特定的钩子，我将利用这一特性，在触发到postinstall钩子后自动执行 ui 包构建。

1.4 实现过程

在 Workspace 下的 package 下添加构建 ui 包的脚本；

通过 --filter 来限制脚本执行的子包集；

{    "scripts": {        "postinstall": "pnpm -r --filter=@gfe/ui run build"    }}

复制代码

2. Build Tools API 更适合

2.1 背景描述

在一些常规的项目中通常只需要应用到webpack或者vite的配置文件就可以让项目正常的运行及构建，当你的项目变得复杂的时候就或不停的往配置文件中增加更多的loader或plugins来充实构建工具的功能，在组件库开发的时候如果你仅使用配置文件来实现的话这一切将变得很复杂，所以就需要应用到构建工具提供的 API 来在构建脚本的函数中动态调用，实现更加灵活的执行。

2.2 回归案例

在这次的案例中将利用 Vite 构建工具来实现每个组件的打包，在后期使用组件时既可以引入全量的组件包又可以选择性的使用某一个指定的组件包。在组件包中我们还将利用脚本来充实组件包的内容达到更好的使用体验，这也是纯配置文件不那么容易搞定的事情。

2.3 实现过程

2.3.1 组件全量编译

全量编译不需要配置过多的信息，因为它会按照你在 vite 配置执行编译，只需要调用 vite 提供的build函数就可以了~

import { build } from "vite";
const buildAll = async () => {    // 全量打包    await build();}
buildAll();

复制代码

2.3.2 组件分包编译

分包编译就需要通过遍历组件目录得到符合组件包特征的组件列表，在遍历组件列表的时候实时配置组件编译选项再执行build函数。

// 按组件分别打包const srcDir = path.resolve(__dirname, "../src/");
// 提取包含index.ts入口的组件目录const componentsDir = fs.readdirSync(srcDir).filter(filename => {    const componentDir = path.resolve(srcDir, filename);    const isDir = fs.lstatSync(componentDir).isDirectory();    return isDir && fs.readdirSync(componentDir).includes("index.ts");})
// 遍历需要打包的组件分别打包for (let name of componentsDir) {    const outDir = path.resolve(output, name)
    const customConfig = {        lib: {            entry: path.resolve(srcDir, name),            name,            fileName: "index",            formats: ["esm", "umd"]        },        outDir,    }
    await build({ build: customConfig, } as InlineConfig);};

复制代码

2.3.3 调整 package 信息

在全量构建完成和每个分包构建完成都应该给它们维护其专属的 package 信息，在使用组件时将很有用。

// 输出package信息函数function outputPkgFile(filepath, pkg) {    fs.outputFile(path.resolve(filepath, `package.json`), JSON.stringify(pkg, null, 2), `utf-8`);}

复制代码

全量构建的 package 信息不需要全部重写，可以导入 ui 包下的 package 信息，在此基础上进行修改，补充 main、module、types 信息，分别指向 umd 输出产物路径、esm 输出产物路径、.d.ts 输出产物路径（在组件库的使用体验很重要一节会详细说明）；

outputPkgFile(output, {    ...require("../package.json"),    main: `gfe-ui.umd.js`,    module: `gfe-ui.esm.js`,    types: `gfe-ui.d.ts`,});

复制代码

每个分包构建后的 package 信息除了上面的三个属性外 name 属性也需要调整成每个组件自己的名称，因为它属于这个组件；

outputPkgFile(outDir, {    name: `@gfe-ui/${name.toLocaleLowerCase()}`,    main: `index.umd.js`,    module: `index.esm.js`,    types: `../types/${name}/index.d.ts`});

复制代码

2.3.4 输出自述文档

自述文档在没有项目的根目录下都会有一份，在 ui 包的根目录下的自述文档描述了组件库的安装、导入及使用的方式，在输出的产物中也需要包含这个文件；

fs.copyFileSync(path.resolve("./README.md"), path.resolve(output, `README.md`));

复制代码

输出结构：

dist                                   ├─ Button                     │  ├─ styles                  │  │  ├─ index.css            │  │  └─ style.css            │  ├─ index.esm.js            │  ├─ index.esm.js.map        │  ├─ index.iife.js           │  ├─ index.iife.js.map       │  ├─ index.umd.js            │  ├─ index.umd.js.map        │  └─ package.json                                                                  ├─ gfe-ui.d.ts                ├─ gfe-ui.esm.js              ├─ gfe-ui.esm.js.map          ├─ gfe-ui.iife.js             ├─ gfe-ui.iife.js.map         ├─ gfe-ui.umd.js              ├─ gfe-ui.umd.js.map          ├─ package.json               └─ README.md

复制代码

3. 顺手的工具远胜与一切

3.1 背景描述

前端项目从不需要构建到使用webpack、vite构建，还有最近新出现的Turbopack，无论选择哪种构建工具都会遇到某一些文件是没办法直接处理的，那么首先就会去寻找对应的插件来看是否可能满足要求，我想说的是其实没有那么必要拘泥于使用一种构建工具，有更顺手的构建工具配合将是一种不错的选择。

3.2 回归案例

在这次的案例中构建组件的主要是基于vite来做的，但是在 less 模块的构建中我选择了相对熟悉的gulp来编写构建脚本，通过遍历组件文件夹来提取到所有的 less 模块文件，在分别注册gulp任务，最后交由gulp来统一执行，定制化程度高，我想不到什么样的vite插件可以这么灵活的实现；

3.3 实现过程

配置gulp构建less模块的脚本，使用到了gulp-less模块支持，如果需要对 less 构建完的结果做进一步处理，比如要压缩，就可以继续使用pipe处理，因为gulp基于 node 强大的流(stream)能力：

import gulp from "gulp";import less from "gulp-less";
// gulp core codeconst register = (name, src, dist) => {  gulp.task(name, function () {    return gulp.src(src)      .pipe(less())      .pipe(gulp.dest(dist));  });}
// TODO register task
// 导出所有 gulp taskexport default gulp.series(...tasks);

复制代码

确定组件文件的和输出文件的路径，如果在vite.config.ts中指定了outDir选项将会被优先使用：

const srcDir = path.resolve(__dirname, "../src/");const output = path.resolve(require("../vite.config.ts").build?.outDir || "../dist");

复制代码

通过组件包特征（包含入口index.ts文件）来确定所有组件的目录：

const componentsDir = fs.readdirSync(srcDir).filter(filename => {  const componentDir = path.resolve(srcDir, filename);  const isDir = fs.lstatSync(componentDir).isDirectory();  return isDir && fs.readdirSync(componentDir).includes("index.ts");})

复制代码

最后遍历组件注册任务：

register(`${name}Task`,     path.resolve(entryDir, 'style.less'),     path.resolve(outDir, 'styles'));

复制代码

总结：

无论是刚参与到组件库开发、正处在组件库开发期间还是在使用组件库过程中都有考虑，倾力打造一款优秀体验的组件库，在组件库的工程化方面和组件开发当中还有哪些可以提升体验的地方欢迎一起讨论~

本文正在参加「金石计划 . 瓜分6万现金大奖」

本文转自 https://juejin.cn/post/7166497449194815524，如有侵权，请联系删除。

发布于: 刚刚阅读数: 4

原文链接:【http://xie.infoq.cn/article/a95e4cce8fd9149b7ba94acee】。文章转载请联系作者。

小鑫同学

关注

⚡InfoQ签约作者 2018-12-10 加入

⚡来【IT200.cn】找我

发布

暂无评论

创作场景

【上】提高组件库 Level 必做好这六件事

1. 留一个好的印象给 Contributor

1.1 背景描述

1.2 回归案例

1.3 技术调研

1.4 实现过程

2. Build Tools API 更适合

2.1 背景描述

2.2 回归案例

2.3 实现过程

2.3.1 组件全量编译

2.3.2 组件分包编译

2.3.3 调整 package 信息

2.3.4 输出自述文档

3. 顺手的工具远胜与一切

3.1 背景描述

3.2 回归案例

3.3 实现过程

总结：

小鑫同学

评论