我理想中的前端工作流

segmentfaultmp / 2018年06月11日 23:39

互联网+

在日常的前端开发中,我们会遇到 LESS/SASS编译CSS前缀自动补全CSS压缩图片压缩JS合并压缩布署发布等各种各样的操作。通常,我们都会根据实际情况定制一个 流程性的工具来实现所有常规的功能,这,就是我理解的 前端工作流

CssGaga

曾经,使用过一段时间的 CssGaga,为它的强大功能而感到震憾,几乎解决了所有常见的需求。

那一段时间里,习惯了 CssGaga 拖图片即压缩上传,拖 CSS 文件即压缩+合并雪碧图上传,拖啥就做啥。也就是说,你想要做什么操作,就手动拖拉什么文件就好了。

但随着自己慢慢变胖,慢慢的越来越懒,有时候就想,为什么每次完成开发后,要手动拖几次文件,而不是一键就搞定所有必要的功能呢?

CssGaga的模式非常值得借鉴学习,特别是它的 雪碧图合成方式,见过很多优秀的雪碧图插件都是参照其写法,如:grunt-spritegulp-tmtsprite

我理想中的工作流

一个人,想某件事,想得多了,就会有所行动,比如我曾经喜欢的妹子,现在成了我的老婆。。。。。

不好意思,扯远了,继续讲我想要的工作流模式。

结合公司的工作模式和实际业务实践,我把一个这个流程分成两个过程: 开发过程布署过程

1. 开发过程

当我开始开发时,我希望是所见即所得的,我的每一次代码编辑,都能即时的响应反馈在我面前; 我用的是能提升我效率的 CSS预处理语言,我希望她能即时的帮我编译成 CSS; 我用 rem, 但我写的是 px,我希望她能帮我转换......

我想要的 开发过程很简单,就是能帮我提升效率!

2. 布署过程

开发完后,终于到了要发布的时候了。发布前,需要生成可以放到 生产环境中的代码,而这个过程,要做的工作有非常多,大概有如下:

  • Less/Sass -> CSS

  • CSS Autoprefixer 前缀自动补全

  • CSS 压缩合并

  • CSS Sprite 雪碧图合成

  • Retina @2x & @3x 自动生成适配

  • imagemin 图片压缩

  • JS 合并压缩

  • EJS 模版语言

  • ...

我希望这个过程是一个命令或一键就可以完成的,而不是多次拖拉生成。

我要的流程其实很简单,就是越简单越好!

下面,介绍一下因此而诞生的解决方案------tmt-workflow

tmt-workflow

tmt-workflow 是一个基于 Gulp(v4.0)、跨平台(Mac & Win)、高效、可定制的前端工作流程。

功能特性

她除了实现了以上设想的各种功能外,还有:

  1. 基于 Gulp4 ,超好用的流程化(gulp.series, gulp.parallel)控制 API,更高的性能

  2. 跨平台的,支持 Win 和 Mac,满足各类开发者

  3. 所有项目共享一个 node_modules,只需一次 npm install即可

  4. 可定制的,你可以根据自己的需求修改实现你自己想要的功能

  5. 自带 rem适配方案智能Webp解决方案去缓存文件Reversion(MD5)解决方案

快速开始

以下 2 种方式任选,请确保已安装 Node.js环境

  • 使用 Yoeman脚手架 generator-workflow自动安装(推荐):

    • npm install-g generator-workflow

    • yo workflow

  • 直接下载安装:

    1. 全局安装 Gulp 4,执行: npm install gulpjs/gulp#4.0 -g

    2. 点击下载 tmt-workflow,进入根目录执行: npm install

注1:Gulp 4目前 尚未正式发布,Windows

用户请先安装 git, 然后在 Git Bash下执行 npm install即可(非 CMD)。

注2:如遇 npm install网络问题,推荐尝试 cnpm安装环境依赖

工作流目录结构
  1. tmt-workflow/

  2. ├── _tasks // Gulp任务目录

  3. │ ├── TaskBuildDev.js // gulp build_dev

  4. │ ├── TaskBuildDist.js // gulp build_dist

  5. │ ├── TaskFTP.js // gulp ftp

  6. │ ├── TaskZip.js // gulp zip

  7. │ │

  8. │ ├── common

  9. │ │ └── webp.js

  10. │ │

  11. │ ├── index.js

  12. │ │

  13. │ ├── lib

  14. │ │ └── util.js

  15. │ │

  16. │ └── plugins // 插件目录

  17. │ ├── TmTIndex.js

  18. │ └── ftp.js

  19. ├── package.json

  20. └── project // 项目目录,详见下述项目结构 ↓↓↓

  21. ├── src

  22. ├── dev

  23. ├── dist

  24. └── gulpfile.js

项目目录结构
  1. project/ // 项目目录

  2. ├── gulpfile.js // Gulp工作流配置文件

  3. ├── src // 源文件目录,`gulp build_dev`阶段会监听此目录下的文件变动

  4. │ ├── css // 存放 Less文件的目录,只有 style-*.less 的文件名会被编译

  5. │ │ ├── lib-reset.less

  6. │ │ ├── lib-mixins.less

  7. │ │ ├── lib-rem.less

  8. │ │ └── style-index.less // CSS 编译出口文件

  9. │ │

  10. │ ├── html

  11. │ ├── img // 存放背景图等无需合并雪碧图处理的图片

  12. │ └── slice // 切片图片素材,将会进行雪碧图合并,同名 @2x图片也会合并

  13. │ ├── icon-dribbble.png

  14. │ └── icon-dribbble@2x.png

  15. ├── dev // 开发目录,由 `gulp build_dev`任务生成

  16. │ ├── css

  17. │ ├── html

  18. │ ├── img

  19. │ └── slice // 开发阶段,仅从 src/slice 拷贝至此,不做合并雪碧图处理

  20. └── dist // 生产目录,由 `gulp build_dist`任务生成

  21. ├── css

  22. ├── html

  23. ├── img

  24. └── sprite // 将 /src/slice 合并雪碧图,根据 /css 文件名,命名为 style-*.png

  25. ├── style-index.png

  26. └── style-index@2x.png

配置文件 .tmtworkflowrc

.tmtworkflowrc配置文件,位于工作流根目录,可存放配置信息或开启相关功能,如:FTP 配置信息、开启 WebP功能,开启 REM 支持等。

  1. {

  2. // FTP 发布配置

  3. "ftp": {

  4. "host": "xx.xx.xx.xx",

  5. "port": "8021",

  6. "user": "tmt",

  7. "pass": "password",

  8. "remotePath": "remotePath", // 默认上传至根目录,此属性可指定子目录路径

  9. "includeHtml": true // FTP 上传时是否包含 .html 文件

  10. },

  11. // 浏览器自动刷新

  12. "livereload": {

  13. "available": true, // 开启

  14. "port": 8080,

  15. "startPath": "html/TmTIndex.html"// 启动时自动打开的路径

  16. },

  17. // 插件功能

  18. // 路径相对于 tasks/plugins 目录

  19. "plugins": {

  20. "build_devAfter": ["TmTIndex"], // build_dev 任务执行完成后,自动执行

  21. "build_distAfter": [], // build_dist 任务执行完成后,自动执行

  22. "ftpAfter": ["ftp"] // ftp 任务执行完成后,自动执行

  23. },

  24. "lazyDir": ["../slice"], // gulp-lazyImageCSS 启用目录

  25. "supportWebp": false, // 开启 WebP解决方案

  26. "supportREM": false, // 开启 REM 适配方案,自动转换 px -> rem

  27. "reversion": false // 开启 新文件名 md5 功能

  28. }

任务简要说明

1. 开发任务 gulp build_dev

按照 目录结构创建好项目后,执行 gulp build_dev生成开发文件位于 /dev,包含以下过程

  • 完成 ejs->htmlless->css编译

  • 自动监听文件改动,触发浏览器刷新

注:浏览器刷新功能可在 .tmtworkflowrc中进行配置,默认开启。_

2. 生产任务 gulp build_dist

开发完成后,执行 gulp build_dist生成最终文件到 /dist目录,包含以下过程:

  • LESS/EJS 编译

  • CSS/JS/IMG 压缩合并

  • slice 图片合并成雪碧图

  • 文件添加版本号

  • WebP 图片支持

3. FTP 部署 gulp ftp

依赖于 生产任务,执行后,会先执行 gulp build_dist,然后将其生成的 /dist目录上传至 .tmtworkflowrc指定的 FTP服务器。

4. 打包任务 gulp zip

依赖于 生产任务,执行后,会先执行 gulp build_dist,然后将其生成的 /dist目录压缩成 zip格式。

注1:./src为源文件目录, /dev/dist目录为流程自动生成的目录。

注2: FTPzip任务执行后会自动删除/dist目录。

使用预览

推荐配合 WebStorm等编辑器的 Gulp 任务管理器使用更佳。

tmt-workflow具有良好的 定制性扩展性,用户可针对自身团队的具体需求定制,更多可查看:

Github:https://github.com/weixin/tmt-workflowWiki:https://github.com/weixin/tmt-workflow/wiki

最后,或许你会问:为什么叫 tmt-workflow?

TmT : 我们的组名,Tencent Moe Team。

工作流的名字随意,你也可以根据你们自己的习惯自由发挥,比如 Aoi sola、Yui Hatano、Takizawa Rola 。返回搜狐,查看更多

责任编辑:

1.环球科技网遵循行业规范,任何转载的稿件都会明确标注作者和来源;2.环球科技网的原创文章,请转载时务必注明文章作者和"来源:环球科技网",不尊重原创的行为环球科技网或将追究责任;3.作者投稿可能会经环球科技网编辑修改或补充。