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

发表于 3年以前  | 总阅读数:348 次

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

前言

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

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

耐心看完,你将收获到:

  • 通过什么方式进行项目管理
  • 如何搭建组件库的demo环境
  • 如何搭建组件库的开发环境
  • 如何搭建组件库编译打包生成资源的存放位置
  • 自动化将组件注册为全局组件
  • 如何实现按需引入
  • 约束规范
  • 如何将一个组件库发布到npm上

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

背景

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

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

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

image.png

解决

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

  • 初始化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是公共的配置文件。这个文件实现了一些基础配置:

  • js模块将es6转成es5
  • 将css文件和js文件分离打包
  • css的转换
  • 配置别名
  • 图片处理之类

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

为了避免使用组件的时候频繁的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"'
复制代码
  • package.json配置
"lint-staged": { "src/* */* .{js,json,vue,ts,tsx}": [ "npm run lint" ] }
复制代码
  • 新建commitlint.js
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配置进行优化。

  • 删除无用的css样式
  • 将打包后的图片进行压缩
  • CDN加载文件
  • 过滤第三方包。比如vue,vuex之类的。使用webpack的externals选项。externals来防止这些依赖包被打包
  • tree-shaking :没有用的代码剔除掉等。后续会慢慢迭代项目优化这块
  • happypack 多线程打包,可以将不同的逻辑交给不同的线程来处理
  • DllReferencePlugin 和 DllPlugin提前打包,大幅度提升构建速度
  • 动态加载 通过import引入文件:添加webpackChunkName字段,webpack配置output选项

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

总结

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

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

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

本文由哈喽比特于3年以前收录,如有侵权请联系我们。
文章来源:https://mp.weixin.qq.com/s/p4vJ7JK1jhfI_UL2ukVBLw

 相关推荐

刘强东夫妇:“移民美国”传言被驳斥

京东创始人刘强东和其妻子章泽天最近成为了互联网舆论关注的焦点。有关他们“移民美国”和在美国购买豪宅的传言在互联网上广泛传播。然而,京东官方通过微博发言人发布的消息澄清了这些传言,称这些言论纯属虚假信息和蓄意捏造。

发布于:1年以前  |  808次阅读  |  详细内容 »

博主曝三大运营商,将集体采购百万台华为Mate60系列

日前,据博主“@超能数码君老周”爆料,国内三大运营商中国移动、中国电信和中国联通预计将集体采购百万台规模的华为Mate60系列手机。

发布于:1年以前  |  770次阅读  |  详细内容 »

ASML CEO警告:出口管制不是可行做法,不要“逼迫中国大陆创新”

据报道,荷兰半导体设备公司ASML正看到美国对华遏制政策的负面影响。阿斯麦(ASML)CEO彼得·温宁克在一档电视节目中分享了他对中国大陆问题以及该公司面临的出口管制和保护主义的看法。彼得曾在多个场合表达了他对出口管制以及中荷经济关系的担忧。

发布于:1年以前  |  756次阅读  |  详细内容 »

抖音中长视频App青桃更名抖音精选,字节再发力对抗B站

今年早些时候,抖音悄然上线了一款名为“青桃”的 App,Slogan 为“看见你的热爱”,根据应用介绍可知,“青桃”是一个属于年轻人的兴趣知识视频平台,由抖音官方出品的中长视频关联版本,整体风格有些类似B站。

发布于:1年以前  |  648次阅读  |  详细内容 »

威马CDO:中国每百户家庭仅17户有车

日前,威马汽车首席数据官梅松林转发了一份“世界各国地区拥车率排行榜”,同时,他发文表示:中国汽车普及率低于非洲国家尼日利亚,每百户家庭仅17户有车。意大利世界排名第一,每十户中九户有车。

发布于:1年以前  |  589次阅读  |  详细内容 »

研究发现维生素 C 等抗氧化剂会刺激癌症生长和转移

近日,一项新的研究发现,维生素 C 和 E 等抗氧化剂会激活一种机制,刺激癌症肿瘤中新血管的生长,帮助它们生长和扩散。

发布于:1年以前  |  449次阅读  |  详细内容 »

苹果据称正引入3D打印技术,用以生产智能手表的钢质底盘

据媒体援引消息人士报道,苹果公司正在测试使用3D打印技术来生产其智能手表的钢质底盘。消息传出后,3D系统一度大涨超10%,不过截至周三收盘,该股涨幅回落至2%以内。

发布于:1年以前  |  446次阅读  |  详细内容 »

千万级抖音网红秀才账号被封禁

9月2日,坐拥千万粉丝的网红主播“秀才”账号被封禁,在社交媒体平台上引发热议。平台相关负责人表示,“秀才”账号违反平台相关规定,已封禁。据知情人士透露,秀才近期被举报存在违法行为,这可能是他被封禁的部分原因。据悉,“秀才”年龄39岁,是安徽省亳州市蒙城县人,抖音网红,粉丝数量超1200万。他曾被称为“中老年...

发布于:1年以前  |  445次阅读  |  详细内容 »

亚马逊股东起诉公司和贝索斯,称其在购买卫星发射服务时忽视了 SpaceX

9月3日消息,亚马逊的一些股东,包括持有该公司股票的一家养老基金,日前对亚马逊、其创始人贝索斯和其董事会提起诉讼,指控他们在为 Project Kuiper 卫星星座项目购买发射服务时“违反了信义义务”。

发布于:1年以前  |  444次阅读  |  详细内容 »

苹果上线AppsbyApple网站,以推广自家应用程序

据消息,为推广自家应用,苹果现推出了一个名为“Apps by Apple”的网站,展示了苹果为旗下产品(如 iPhone、iPad、Apple Watch、Mac 和 Apple TV)开发的各种应用程序。

发布于:1年以前  |  442次阅读  |  详细内容 »

特斯拉美国降价引发投资者不满:“这是短期麻醉剂”

特斯拉本周在美国大幅下调Model S和X售价,引发了该公司一些最坚定支持者的不满。知名特斯拉多头、未来基金(Future Fund)管理合伙人加里·布莱克发帖称,降价是一种“短期麻醉剂”,会让潜在客户等待进一步降价。

发布于:1年以前  |  441次阅读  |  详细内容 »

光刻机巨头阿斯麦:拿到许可,继续对华出口

据外媒9月2日报道,荷兰半导体设备制造商阿斯麦称,尽管荷兰政府颁布的半导体设备出口管制新规9月正式生效,但该公司已获得在2023年底以前向中国运送受限制芯片制造机器的许可。

发布于:1年以前  |  437次阅读  |  详细内容 »

马斯克与库克首次隔空合作:为苹果提供卫星服务

近日,根据美国证券交易委员会的文件显示,苹果卫星服务提供商 Globalstar 近期向马斯克旗下的 SpaceX 支付 6400 万美元(约 4.65 亿元人民币)。用于在 2023-2025 年期间,发射卫星,进一步扩展苹果 iPhone 系列的 SOS 卫星服务。

发布于:1年以前  |  430次阅读  |  详细内容 »

𝕏(推特)调整隐私政策,可拿用户发布的信息训练 AI 模型

据报道,马斯克旗下社交平台𝕏(推特)日前调整了隐私政策,允许 𝕏 使用用户发布的信息来训练其人工智能(AI)模型。新的隐私政策将于 9 月 29 日生效。新政策规定,𝕏可能会使用所收集到的平台信息和公开可用的信息,来帮助训练 𝕏 的机器学习或人工智能模型。

发布于:1年以前  |  428次阅读  |  详细内容 »

荣耀CEO谈华为手机回归:替老同事们高兴,对行业也是好事

9月2日,荣耀CEO赵明在采访中谈及华为手机回归时表示,替老同事们高兴,觉得手机行业,由于华为的回归,让竞争充满了更多的可能性和更多的魅力,对行业来说也是件好事。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI操控无人机能力超越人类冠军

《自然》30日发表的一篇论文报道了一个名为Swift的人工智能(AI)系统,该系统驾驶无人机的能力可在真实世界中一对一冠军赛里战胜人类对手。

发布于:1年以前  |  423次阅读  |  详细内容 »

AI生成的蘑菇科普书存在可致命错误

近日,非营利组织纽约真菌学会(NYMS)发出警告,表示亚马逊为代表的电商平台上,充斥着各种AI生成的蘑菇觅食科普书籍,其中存在诸多错误。

发布于:1年以前  |  420次阅读  |  详细内容 »

社交媒体平台𝕏计划收集用户生物识别数据与工作教育经历

社交媒体平台𝕏(原推特)新隐私政策提到:“在您同意的情况下,我们可能出于安全、安保和身份识别目的收集和使用您的生物识别信息。”

发布于:1年以前  |  411次阅读  |  详细内容 »

国产扫地机器人热销欧洲,国产割草机器人抢占欧洲草坪

2023年德国柏林消费电子展上,各大企业都带来了最新的理念和产品,而高端化、本土化的中国产品正在不断吸引欧洲等国际市场的目光。

发布于:1年以前  |  406次阅读  |  详细内容 »

罗永浩吐槽iPhone15和14不会有区别,除了序列号变了

罗永浩日前在直播中吐槽苹果即将推出的 iPhone 新品,具体内容为:“以我对我‘子公司’的了解,我认为 iPhone 15 跟 iPhone 14 不会有什么区别的,除了序(列)号变了,这个‘不要脸’的东西,这个‘臭厨子’。

发布于:1年以前  |  398次阅读  |  详细内容 »
 相关文章
Android插件化方案 5年以前  |  237273次阅读
vscode超好用的代码书签插件Bookmarks 2年以前  |  8108次阅读
 目录