如何编写一个gulp插件

摘要:
很久以前,我们在文章《详细谈论Gulp》中详细解释了如何使用Gulp来完成前端自动化,并以压缩JavaScript为例。简单回顾一下,除了使用Gulp,我们还使用了第三方Gulp插件“Gulp uglify”来压缩JavaScript文件。事实上,如果您只想编写Gulp插件,可以使用through2或throughgulp**through2**'usestrict'varthrough2=require编写它;单元导出=修改;函数modify(){returnthrough2.obj;}函数versionFun{returndata.replace;}**through gulf**'usestrict'varthrough=require;单元导出=修改;Functionmodify(){varstream=through(function(file,encoding,callback){//如果文件为空且未执行任何操作,则下一个pipif(file.isNull()){console.log('fileisull!

很久以前,我们在"细说gulp"随笔中,以压缩JavaScript为例,详细地讲解了如何利用gulp来完成前端自动化。

再来短暂回顾下,当时除了借助gulp之外,我们还利用了第三方gulp插件”gulp-uglify”,来达到压缩JavaScript文件的目的。

代码如下:

如何编写一个gulp插件第1张

今儿,我们的重点就是,自己也来实现一个gulp插件。

正文

其实,如果只是单纯地想要编写一个gulp插件不难,可以借助through2或者through-gulp来编写(through-gulp是基于through2开发的)。

例如,我们想要接下来即将编写的插件(暂取名为modify),实现这样的功能:将指定html文件中的{{…}},全部替换成’Monkey 2 Dorie’。

如下:

如何编写一个gulp插件第2张

下面我们将利用through2以及through-gulp一一道来。

**through2**

'use strict'
var through2 = require('through2');
module.exports = modify;
function modify(){
    return through2.obj(function(file, encoding, cb){
        //如果文件为空,不做任何操作,转入下一个操作,即下一个pipe
        if(file.isNull()){
            console.log('isNull');
            this.push(file);
            return cb();
        }
        //插件不支持对stream直接操作,抛出异常
        if(file.isStream()){
            console.log('isStream');
            this.emit('error');
            return cb();
        }
        //内容转换,处理好后,再转成Buffer形式
        var content = versionFun(file.contents.toString());
        file.contents = new Buffer(content);
        //下面这两句基本是标配,可参考through2的API
        this.push(file);
        cb();
    });
}
function versionFun(data){
    return data.replace(/{{something}}/, ' Monkey 2 Dorie ');
}

**through-gulp**

'use strict'
var through = require('through-gulp');
module.exports = modify;
function modify(){
    var stream = through(function(file, encoding, callback){
        //如果文件为空,不做任何操作,转入下一个操作,即下一个pipe
        if(file.isNull()){
            console.log('file is null!');
            this.push(file);
            return callback();    
        }
        //插件不支持对stream直接操作,抛出异常
        if(file.isStream()){
            console.log('file is stream!');
            this.emit('error');
            return callback();    
        }
        //内容转换,处理好后,再转成Buffer形式
        var content = versionFun(file.contents.toString('utf-8'));
        file.contents = new Buffer(content, 'utf-8');
        this.push(file);
        callback();
    }, function(callback){
        console.log('处理完毕!');
        callback();
    });
    return stream;
}
function versionFun(data){
    return data.replace(/{{something}}/, ' Monkey 2 Dorie ');
}

详情代码见github.

拓展阅读

[1]、through-gulp

[2]、gulp规范

[3]、gulp高级技巧

免责声明:文章转载自《如何编写一个gulp插件》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇Hi3516DV300芯片报错“ undefined reference to ×”批量关闭远程计算机下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

前端跨域

跨域是指一个域下的文档或脚本试图去请求另一个域下的资源。也就是说如果协议,域名,或者端口有一个不同就是跨域。 那么为什么要用跨域? 其实是因为浏览器出于安全考虑,我们都知道浏览器有同源策略。如果没有同源策略的情况下,A网站可以被任意来源的Ajax访问到内容,如果当前A网站还处于登录态,那么对方就可以通过Ajax获得A网站的任何消息。当然跨域可以用来房子CS...

jQuery基础【1】

jQuery 是一个“写的更少,但做的更多”的轻量级 JavaScript 库。jQuery 极大地简化了 JavaScript 编程。jQuery 很容易学习。jQuery 库位于一个 JavaScript 文件中,其中包含了所有的 jQuery 函数。jQuery 是一个 JavaScript 函数库。jQuery 库包含以下特性:   •HTML 元...

AFNetWorking 的简单使用

转:http://blog.csdn.net/marujunyy/article/details/18424711 由于ASIHTTPRequest 不再更新了,不能使用block感觉不太好用;最后选择了AFNetWorking,并做了进一步的封装。 需要导入的framework:CFNetwork、Security、SystemConfiguratio...

前端常见跨域解决方案(全)

什么是跨域? 跨域是指一个域下的文档或脚本试图去请求另一个域下的资源,这里跨域是广义的。 跨域的根本原因就是浏览器,所以在后台是不存去前端一样上的跨域的,后台调后台是不会跨域的,但是必须网络是通的 广义的跨域: 1.) 资源跳转: A链接、重定向、表单提交 2.) 资源嵌入: <link>、<script>、<img>...

Ajax跨域请求

一、同源策略 同源策略(Same origin policy)是一种约定,它是浏览器最核心也最基本的安全功能, 如果缺少了同源策略,则浏览器的正常功能可能都会受到影响。 可以说Web是构建在同源策略基础之上的,浏览器只是针对同源策略的一种实现。 同源策略,它是由Netscape提出的一个著名的安全策略。现在所有支持JavaScript 的浏览器都会使用这个...

经典的CSS代码(转)

Web开发技术每年都在革新,浏览器已逐渐支持CSS3特性,并且网站设计师和前端开发者普遍采用这种新技术进行设计与开发。但仍然有一些开发者迷恋着一些CSS2代码。 分享20段非常专业的CSS2/CSS3代码供大家使用,你可以把它们保存在IDE里、或者存储在CSS文档里,这些代码片段绝对会给你带来意外的惊喜。 1. CSS Resets 网络上关于CSS重置的...