Documentation d'aide WeFlow / 自定义插件(高级)

自定义插件(高级)

首先,我们应该明确一点,作为一个通用的程序,是不应该在核心里面有过多的私有定制需求的,如想在 gulp dev 后列出根目录下所有的 html 功能,想在 gulp ftp 上传成功后直接弹出浏览器窗口,斯认为,侵入性过强,不应作为一个通用工作流的集成的功能,所以,我们提供了 插件 功能。

tmt-workflow 不仅提供了多个常用任务,还开放了各个常用任务的回调接口,您只需按 node 的方式编写插件,即可自行根据具体需求设计自己想要的功能,使得用户不需要通读 tmt-workflow 源码,就可以扩展自己想要的任务,既降低了学习成本,也降低了工作流的耦合度。

下面,我们以一个简单的示例说明如何使用 自定义插件 功能。

1. 配置 .tmtworkflowrc

   //插件功能
   //路径相对于 tasks/plugins 目录
  "plugins": {
    "build_devAfter": ["TmTIndex"],  //build_dev 任务执行后自动执行
    "build_distAfter": [],           //build_dist 任务执行后自动执行
    "ftpAfter": ["ftp"]              //ftp 任务执行后自动执行
  },

如上,每个字段属性对应各个任务,以数组形式指定插件,依次执行数组指定的插件,如我们给我们的插件命名为 TmTIndex

2. 在 _tasks/plugins/ 目录下新建 TmTIndex.js

var rd = require('rd');
var fs = require('fs');
var path = require('path');

//插件必需按 node 模块规范编写
module.exports = function (config) {
    // do some stuff ...
}

如上,插件只需要按 node 模块规范编写,就可以实现你要的功能。

可以看到,扩展插件只需要两步,具体想实现什么样的功能,可根据具体的需求进行定制。

我们内部已通过插件功能扩展了多个定制需求,哪里不明白随时 Issues 。