ElementUI的构建流程

ElementUI的构建流程: https://juejin.cn/post/6844903680357957645

package.json中属性介绍

分类

必备属性(name、version)

描述信息(description、keywords、homepage、repository、bugs)

NPM脚本(scripts)

依赖(dependencies、devDependencies、peerDependencies)

协议(license) 指定软件的开源协议类型

目录文件相关(main、files、typings、faas、unpkg、style)

main

main 属性指定程序的主入口文件,当在应用程序中导入此软件包时,应用程序会在该位置搜索模块的导出
在代码中引入整个 Element import ElementUI from 'element-ui';,
实际上引入的就是 lib/element-ui.common.js 中暴露出去的模块。

{
  "main": "lib/element-ui.common.js"
}
files

files 属性用于描述 npm publish后推送到 npm 服务器的文件列表如果指定文件夹,则文件夹内的所有内容都会包含进来。
也可以通过配置 .npmignore 文件来忽略文件上传。

{
  "files": [
    "lib",
    "src",
    "packages",
    "types"
  ],
}
typings

typings 属性指定针对typescript的声明文件入口

{
 "typings": "types/index.d.ts",
}
style

style属性指定了样式入口文件。


{
  "style": "lib/theme-chalk/index.css"
}
unpkg

unpkg 是一个前端常用的公共 CDN,它通过 URL 语法可以访问NPM上任何包的任何文件。

unpkg.com/:package@:version/:file

当把包发布到 npm 上时, 不仅可以 NodeJs 环境使用,也可以通过 unpkg 获取在浏览器环境执行,不过需要符合 umd 规范。

{
    "unpkg": "lib/index.js"
}

main 属性值lib/element-ui.common.js是 commonjs 规范,由build/webpack.common.js打包生成。
unpkg属性值 lib/index.js是 umd 规范,由build/webpack.conf.js打包生成

设置 unpkg 属性后,访问 unpkg.com/element-ui,按照上述规则自动访问 https://unpkg.com/element-ui@2.15.1/lib/index.js
在之前的me-vue-ui包发布中,由于没有配置 unpkg 属性,访问 unpkg.com/me-vue-ui 时按照 main
属性定义的文件路径自动访问 https://unpkg.com/me-vue-ui@0.1.2/lib/me-vue-ui.common.js

CDN引入
若浏览器环境引入组件,只需要通过 unpkg.com/element-ui 获取到资源,
在页面上引入 js 和 css 文件即可开始使用。 CSS文件的路径是 style 属性值;
js文件的路径是基于umd规范的打包文件的路径--unpkg属性值

<!-- 引入样式 -->
<link rel="stylesheet" href="https://unpkg.com/element-ui/lib/theme-chalk/index.css">
<!-- 引入组件库 -->
<script src="https://unpkg.com/element-ui/lib/index.js"></script>

npm run 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",

该命令主要用于文件的自动化生成,其多个任务是 并行执行

  • 执行 build/bin/iconInit.js 生成 examples/icon.json 图标集合文件。
  • 执行 build/bin/build-entry.js 生成 src/index.js 组件库入口文件。
  • 执行 build/bin/i18n.js 生成官网的多语言网站文件。
  • 执行 build/bin/version.js 生成 examples/version.json 记录项目版本信息,用于网站版头部导航版本切换。
// iconInit.js
'use strict';

var postcss = require('postcss');
var fs = require('fs');
var path = require('path');
var fontFile = fs.readFileSync(path.resolve(__dirname, '../../packages/styles/src/icon.scss'), 'utf8');
/**
 * parser过程:将css字符串解析成可供我们操作的JavaScript对象
 * */
var nodes = postcss.parse(fontFile).nodes;
var classList = [];

nodes.forEach((node) => {
  var selector = node.selector || '';
  var reg = new RegExp(/\.el-icon-([^:]+):before/);
  var arr = selector.match(reg);

  if (arr && arr[1]) {
    classList.push(arr[1]);
  }
});
classList.reverse(); // 希望按 css 文件顺序倒序排列

fs.writeFile(path.resolve(__dirname, '../../examples/icon.json'), JSON.stringify(classList), () => {});


npm run build:theme

    "build:theme": "node build/bin/gen-cssfile &&
                             gulp build --gulpfile packages/theme-chalk/gulpfile.js && 
                             cp-cli packages/theme-chalk/lib lib/theme-chalk",

该命令主要用于项目的主题和样式生成。
1.执行 build/bin/gen-cssfile 执行 build/bin/gen-cssfile 生成 packages/theme-chalk/index.scss 样式总入口文件。
2.采用 gulp 进行样式构建,将packages/theme-chalk/src下的 scss 文件转换成 css 文件,输出至packages/theme-chalk/src/lib目录下;将packages/theme-chalk/src/fonts下的字体文件压缩处理,输出至 packages/theme-chalk/src/lib/fonts 目录下。
3.将构建内容 packages/theme-chalk/lib 拷贝到 lib/theme-chalk 下。前面 sytle 属性配置的路径文件 lib/theme-chalk/index.css 就是这样生成的。

需要安装 cp-cli 包,用于文件和文件夹复制,无需担心跨平台问题。

npm run build:utils

该命令作用把 src 目录下除了 src/index.js 入口文件外的其他文件通过 babel 转译后,输出至 lib 文件夹下。

需要安装 cross-env 包,是一款运行跨平台设置和使用环境变量的脚本,不同平台使用唯一指令,无需担心跨平台问题。

需安装babel-cli Babel 自带了一个内置的 CLI 命令行工具

npm run build:umd

    "build:umd": "node build/bin/build-locale.js",

该命令作用是执行 build/bin/build-locale.js 通过 babel 处理 src/locale/lang 目录下的文件,生成 umd 格式的文件,输出至 lib/umd/locale 目录下。

npm run dev

    "dev": "
npm run bootstrap && 
npm run build:file && 
cross-env NODE_ENV=development webpack-dev-server --config build/webpack.demo.js &
node build/bin/template.js
",

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,509评论 6 504
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,806评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,875评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,441评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,488评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,365评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,190评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,062评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,500评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,706评论 3 335
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,834评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,559评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,167评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,779评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,912评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,958评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,779评论 2 354

推荐阅读更多精彩内容