gulpのpipeで独自のファンクションを実行する

gulppipeの中で独自に定義したファンクションを実行し、srcで指定した各ファイルの内容を変更したい場合、through2というモジュールを使用すれば実現できます。

highlight.jsをローカルで実行してハイライトされたファイルを出力で紹介したような処理を、pipeの処理の中に組み込むための実装例を紹介します。

through2

through2を使用すれば、pipeの処理の中で、独自のファンクションを組み込むすることができます。

$ npm install --save-dev through2

以下のようにタスクを定義します。

var through = require('through2');
var path = require('path');

gulp.task('highlight', function(){
  return gulp.src('対象のファイル')
    .pipe(through.obj(function (file, enc, cb) {
      //このファンクションで独自にファイルの内容を変更できます

      //拡張子を取得(ハイライトする言語タイプは拡張子に合わせる)
      var type = path.extname(file.path).replace('.', '');

      //file.contents = ファイルの内容
      //new Buffer()をしないとエラーになる
      file.contents = new Buffer(hljs.highlight(type, file.contents.toString()).value);

      cb(null, file);
    }))
    .pipe(gulp.dest('出力先'));
});

ファンクションを別ファイルに定義

ファンクションをタスクの中に記述すると1つのタスクがとても長くなってしまい、可読性が悪くなってくるので、ファンクションは別ファイルで管理したくなることがあると思います。以下のようにすれば、メインのgulpファイルと、ファンクションのファイルを分けて定義することができます。

func.js
//ファンクションを定義します
exports.highlight = function(file){ //必要な情報を引数で渡すようにします
  var type = path.extname(file.path).replace('.', '');
  return hljs.highlight(type, file.contents.toString()).value; //編集したファイルの内容を帰します
};
gulpfile.js
var through = require('through2');
var func = require('func.js'); //定義したファイルを参照します

gulp.task('highlight', function(){
  return gulp.src('対象のファイル')
    .pipe(through.obj(function (file, enc, cb) {
      //別ファイルに定義したファンクションを呼び出します
      file.contents = new Buffer(func.highlight(file));
      cb(null, file);
    }))
    .pipe(gulp.dest('出力先'));
});

streamなどの細かい仕組みはまだよくわかっていませんが、pipeの処理の中で独自のファンクションを実行できるので、through2を使えばプラグインが用意されていなくても、いろいろとできることが増えると思います。


関連記事

  • watchifyとgulpで自動コンパイルと差分更新をおこなう

    今回は開発環境をさらに便利にするために、ファイルが変更されたら自動でビルドを実行し、ブラウザをリロードする処理を実装します。ファイルを変更すると自動でビルドが行われ、ブラウザが再読込されますが、ビルド...


  • Nunjucksの基本的な使い方 -extends,block,include-

    htmlのおすすめテンプレートエンジンNunjucksはとても便利なのです。extendsという機能を使えば、ヘッダやフッタの共通部分を作成しておき(ベースとなるファイル)、各ページではページごとに変...


  • npmのpackage.jsonを最新のバージョンに更新する

    package.jsonのパッケージを最新のバージョンに更新する方法を紹介します。最新のバージョンに更新するためには、package.jsonに記載されているパッケージのバージョンの記載を最新にする必...


  • less|cssに変数を使い実装を効率化する方法

    lessには変数を使うだけでなく、変数の色をX%明るくしたり、暗くしたり、透過したり、といった便利な関数も用意されています。また、要素を入れ子にして設定したり、関数を自作できるなど、とても便利な機能が...


  • gulpの便利なタスク gulpfile.jsの記述例

    gulpの便利なおすすめプラグインで紹介したプラグインなどを利用したgulpの便利なタスクの実装例を紹介します。less,js,htmlのコンパイルや軽量化、watchとlivereload、エラー時...


  • Nunjucksで独自のファンクションを実行する

    gulp-dataと組み合わせると、引数のような形で各ファイルにデータ(変数など)を渡すことができます。同じ容量で、変数ではなくファンクション自体をgulp-dataで設定すると、自分で定義したファン...


  • gulpでディレクトリ構造を維持したままdestにコピーする

    gulpで以下のようなフォルダ構成で、page.html、page2.htmlをそれぞれのフォルダ配下のフォルダにコピーする場合、普通にdestを指定するだけではうまくいかないことがあります。コピーす...


  • gulpの便利なおすすめプラグイン

    gulpを導入するとWEB開発をとても効率よく簡単に行うことができるようになります。私がよく利用している便利なプラグインを紹介します。


  • gulp-nunjucks-renderでNunjucksをgulpでコンパイルする方法

    Nunjucksをgulpでコンパイルする方法を紹介します。今回はgulp-nunjucks-renderを使用します。まずは、コマンドラインでgulp-nunjucks-renderをインストールし...


  • highlight.jsをローカルで実行してハイライトされたファイルを出力

    ホームページやブログでプログラムのコードを掲載する際に、以下のようにコードをシンタックスハイライト(色付け)をすることがあると思います。highlight.jsという便利なライブラリを使っていましたが...