如何将自动化构建工作流封装

对于一个项目组,甚至说一些公司对于整个前端的架构都有一定的要求,解决方案架构组或者前端技术架构组往往会推出一套自动化构建的工作流。那么当我们制定好了这么一套工作流,如何封装起来,使得大家在项目的开始都能应用上。那么本篇文章就是为了解决这么一个问题。

创建一个cli项目

  • 创建一个lib目录,目录下创建一个index.js文件,内容为我们之前的gulpfile.js
  • 将我们上次项目值介绍的插件添加到本次项目的dependencies
  "dependencies": {
    "@babel/core": "^7.5.5",
    "@babel/preset-env": "^7.5.5",
    "browser-sync": "^2.26.7",
    "del": "^5.1.0",
    "gulp": "^4.0.2",
    "gulp-babel": "^8.0.0",
    "gulp-clean-css": "^4.2.0",
    "gulp-htmlmin": "^5.0.1",
    "gulp-if": "^3.0.0",
    "gulp-imagemin": "^6.1.0",
    "gulp-load-plugins": "^2.0.1",
    "gulp-sass": "^4.0.2",
    "gulp-swig": "^0.9.1",
    "gulp-uglify": "^3.0.2",
    "gulp-useref": "^3.1.6"
  },
  • npm install & npm link
  • 那么就可以在我们新的项目中通过 npm link <项目名>

项目应用

  • 我们新项目中的gulpfile.js就可以通过导出我们link模块的形式使用
module.exports = require("zicoo-gulp-cli")

这个时候当我们满心以为yarn gulp build没有问题了的时候

yarn gulp build
yarn run v1.22.10
error Command "gulp" not found.

然后我们再去yarn add gulp gulp-cli

yarn gulp build
yarn run v1.22.10
build
Starting 'build'...
Finished 'build' after 1.59 s
✨  Done in 3.29s.

成功啦!!
由于我们之前的项目用所使用的路径为之前项目的路径并且像我们日常使用的这种工作流或者脚手架来说都会有配置项,因此我们只需要将之前写死的目录封装成一个对象,在根目录下创建一个config文件目的是用户可以自定义配置这些对象的属性,在我们的lib下的index.js中也留有一个默认数据,并且 require引入我们新建的对象的文件。让新配置对象去覆盖默认对象。注意我们这里用的是覆盖,因为自定义配置中的项目可能不会配置完全。

包装Gulp Cli

我们再刚才的测试用发现我们已经已经使用了我们封装的这个模块,为什么还得去安装gulp并且还得需要gulpfile.js,很显然我们的封装还不是很完善。因此我们需要取进一步包装一下我们的cli。
我们使用的gulpfile.js其实本身就是cli的lib目录下的index.js,所以我们可以尝试去先使用命令行的形式先去指定一下gulpfile这个文件的最终使用地址

yarn gulp build --gulpflie ./node_moudle/<cli项目名>/lib/index.js

我们发现它实际build目录是lib这个目录,所以需要我们再重新指定一下workdir(工作目录)。

yarn gulp build --gulpflie ./node_moudle/<cli项目名>/lib/index.js --cwd .

这个时候我们发现运行是正常的。达到了我们的目的。
要想让我们指定的工作流像cli一样执行,需要我们创建一个bin目录,目录中自定义命名一个js文件,比如zicoo-cli.js。因此我们还需要在package.json中指向一下我们cli的可执行文件。

"bin": "bin/zicoo-cli.js"

当我们再去npm link的时候,就可以只写使用项目名去执行。
我们可以看一下gulp的cli源文件,执行gulp的时候本身就是执行了gulp-cli

image.png

所以我们就需要在zicoo-cli.js文件中require一下即可

#!/usr/bin/env node
process.argv.push("--cwd")
process.argv.push(process.cwd())
process.argv.push("--gulpfile")
process.argv.push(require.resolve("..")) //代表着从我们的bin的上层目录去找package.json文件中指向的gulpfile

require("gulp/bin/gulp")

我们可以使用process.argv来获取执行命令的参数,并且gulp.cmd这个文件可以看出本身就是执行一段node命令,因此我们只需要把参数push到命令参数里就可以了。

执行 zicoo-gulp-cli build 成功完成打包 nice~

发布

yarn publish --registry https://registry.yarnpkg.com

发布完成后需要等待同步,之后我们就可以直接使用 yarn或者npm去拉取我们的模块使用了。

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

推荐阅读更多精彩内容