我在写《gulp中文文档》的时候，有一些地方确实也不是非常明白，【本文受版权保护】本文作者：唐霜，转载请注明出处。特别是pipe的部分，其实pipe是no【版权所有，侵权必究】【版权所有】唐霜 www.tangshuang.netde的stream部分的内容，但是我没有著作权归作者所有，禁止商业用途转载。本文版权归作者所有，未经授权不得转载。深入去理解，所以用起来还有些吃力。这篇文本文版权归作者所有，未经授权不得转载。原创内容，盗版必究。章主要是写一个插件，可以在gulp的pi本文作者：唐霜，转载请注明出处。本文版权归作者所有，未经授权不得转载。pe中使用。

这个插件的功能是替换文档中的特定内容，使【访问 www.tangshuang.net 获取更多精彩内容】【原创内容，转载请注明出处】用方法如下：

var gulp = require('gulp');
var paserSnippet = require('./paserSnippet');
gulp.task('paser',function(){
  var params = {
    name: 'my-name',
    age: '10'
  };
  
  gulp.src('./snippets/**/*').pipe(paserSnippet(params)).pipe(gulp.dest('./doc/'));
});

然后运行paser这个task：

gulp paser

这样就会以snippets目录下的文档作【访问 www.tangshuang.net 获取更多精彩内容】本文作者：唐霜，转载请注明出处。为模板，但是对模板中的特定字符串进行替换【原创内容，转载请注明出处】【访问 www.tangshuang.net 获取更多精彩内容】，把{{name}}替换为'my-name'，把{{age}}替换为10，并把替换完的生成文档到doc目录下。

那么paserSnippet怎么实现呢？著作权归作者所有，禁止商业用途转载。【原创不易，请尊重版权】我们这样写一个paserSnippet.本文作者：唐霜，转载请注明出处。本文版权归作者所有，未经授权不得转载。js模块：

import through from 'through2';
import logger from 'process.logger';
module.exports = function paserSnippet(pairs) {
    return through.obj(function(file, endcoding, callback) {
        if(file.isNull()) {
            this.push(file);
            return callback();
        }
        if(file.isStream()) {
            logger.error('gulp error: streaming not supported');
            return callback();
        }
        var content = file.contents.toString();
        if(pairs && typeof pairs === 'object') {
            for(let key in pairs) {
                let value = pairs[key];
                content = content.replace('{{' + key + '}}', value)
            }
        }
        file.contents = new Buffer(content);
        this.push(file);
        callback();
    });
}

其中非常关键的，是through2的使用。through2可以获取pipe【本文首发于唐霜的博客】【访问 www.tangshuang.net 获取更多精彩内容】中的stream或buffer，而这里我【本文受版权保护】【原创不易，请尊重版权】们主要是通过改写buffer从而实现替换【原创不易，请尊重版权】原创内容，盗版必究。文档内容。

return through.obj(function(file, endcoding, callback) {})

.pipe这个方法会去执行传入的参数（函转载请注明出处：www.tangshuang.net【未经授权禁止转载】数），得到一个新的内容（stream/b【原创不易，请尊重版权】著作权归作者所有，禁止商业用途转载。uffer）并且把它往下一个pipe传。【原创内容，转载请注明出处】【版权所有，侵权必究】而这个新的stream/buffer就靠through.obj得到。through2比较厉害的地方就是【本文受版权保护】【原创内容，转载请注明出处】，它可以抓取到当前pipe中的内容，并且原创内容，盗版必究。原创内容，盗版必究。在调用obj的时候，可以用参数传入到回调原创内容，盗版必究。【本文受版权保护】函数中去，所以在回调函数中的file就是我们可以进行操作的流。

file.contents就是流的内容，【原创内容，转载请注明出处】原创内容，盗版必究。注意，这个时候的内容还仅仅是在内存中，并著作权归作者所有，禁止商业用途转载。转载请注明出处：www.tangshuang.net没有变成实体。因此，我们可以改变它的内容【版权所有】唐霜 www.tangshuang.net【版权所有】唐霜 www.tangshuang.net。上面的代码中file.contents = new Buffer(content);就是我们通过我们的方法，重新修改了内容。【版权所有，侵权必究】原创内容，盗版必究。但是注意，这个时候它还在内存中，还在pi【转载请注明来源】转载请注明出处：www.tangshuang.netpe的流中，所以下一个pipe进行处理时【本文首发于唐霜的博客】转载请注明出处：www.tangshuang.net，一开始接收到的，就是我们新给定的内容。

通过上面的方法，我们就实现了通过替换模板【未经授权禁止转载】转载请注明出处：www.tangshuang.net内容创建新文档的gulp插件。

2016-11-22 6126 gulp, pipe