Consolidate.js

express.jsと一緒に使うモジュール。express.jsで使うことができる様々なテンプレートエンジンを、統一（consolidate）された呼び出し方（ファンクション）で利用できるようにしたモジュール。

イメージとしては、デザインパターンのAdapterパターンのようなものだと認識している。ejsやpug等の異なるテンプレートエンジンに対して、共通的なメソッド名で呼び出せるようにアダプタ（Consolidate.js）を利用するというようなイメージである。

「consolidate」には、「統合する、まとめる、合併する」という意味があるらしい。

使ってみたソースコードはGitHubにあります。

API

基本

cons.*(path[, locals], callback)という形式でテンプレートエンジンを使った結果を取得できる（*はテンプレートエンジンの名称）。
引数pathはテンプレートファイル, 引数localsはテンプレートファイルに渡すオブジェクト、引数callbackはfunction (err, html)のような形式にする。errはテンプレートエンジンの実行時にエラーが発生したときのエラー、htmlはテンプレートエンジンでの変換結果となる。

上記のGitHubにあるソースコードのindex.jsから抜粋する。
テンプレートエンジンの変換結果を確認するにはexpress.jsは不要。

テンプレートエンジンejsを利用するにはnpm install ejsでインストールしておく必要がある。
consolidateがあれば全部インストールされると思ったので少し戸惑った。考えてみれば当然で、全てのテンプレートエンジンがconsolidateと一緒にインストールされたら非常に大きいモジュールとなってしまう。

const cons = require('consolidate');

cons.ejs('views/ejs.html', { user: 'Chris Paul' }, function(err, html) {
  if (err) {
    throw err;
  }

  console.log('ejs');
  console.log(html);
});

views/ejs.htmlはejsの記法に従って以下のようにした。変数userに最初の関数で渡した値（つまり、「Chris Paul」）がセットされて、出力される。

<div>
  <h1>template engine: ejs</h1>
</div>
<div>
  <p>
    User: <%= user %>
  </p>
</div>

異なるテンプレートエンジン（今回はjazz）も同じ構文で利用できた。
基本的にejsと違うのはcons.*の部分だけである。

cons.jazz('views/jazz.html', { user: 'Joe Ingles' }, function(err, html) {
  if (err) {
    throw err;
  }

  console.log('jazz');
  console.log(html);
});

views/jazz.htmlはjazzの記法に従って以下のようにした。

<div>
    <h1>template engine: jazz</h1>
  </div>
  <div>
    <p>
    {if user}
      Hello, {user}
    {end}   
    </p>
</div>

動的にテンプレートエンジンを変更する

ちょっと応用したパターンとして、変数を利用してテンプレートエンジンを動的に変更することができる。

let engine = 'ejs';
cons[engine]('views/ejs.html', { user: 'Devin Booker' }, function(err, html) {
  if (err) {
    throw err;
  }

  console.log('ejs');
  console.log(html);
});

Promiseを使う

callback関数はPromiseを使って、同期的に利用することができる。
テンプレートエンジンによる変換は時間がかかるはずなので、利用する機会もあるだろう。

cons.jazz('views/jazz.html', { user: 'Donovan Mitchell' })
  .then(function (html) {
    console.log('jazz');
    console.log(html);
  })
  .catch(function (err) {
    throw err;
  });

express.jsと合わせて使う

GitHubにサンプルコードを用意した。

server.jsをnode serverで実行することで試すことができる。

キャッシュを使う

一部のテンプレートエンジンはキャッシュを利用することができる。Consolidate.jsでも、キャッシュの機能を持つテンプレートエンジンにキャッシュを利用させられる。

キャッシュを使うには、{cache: true}というオブジェクトを渡す。 cons.*(path[, locals], callback)の引数localsに{cache: true}を含めることでキャッシュ機能を有効化できる。

cons.ejs('views/ejs.html', { user: 'Chris Paul', cache: true }, function(err, html) {
  if (err) {
    throw err;
  }

  console.log('ejs');
  console.log(html);
});

express.jsを使っている場合にはapp.locals.cache = trueまたは環境変数NODE_ENVにproductionを指定することでキャッシュを有効化できる。

注意点

いくつかのテンプレートエンジンでは注意が必要らしい。
詳しくはREADMEのNotesに記載されている。

利用できるテンプレートエンジン

Consolidate.jsで利用できるテンプレートエンジンは、READMEに書いてある。

cons.*で呼び出すときの*と実際のパッケージ名が異なることがあるため、呼び出し時やインストール時には注意する。
例： cons.liquidで呼び出すが、実際のパッケージ名はtinyliquidである。

前corsモジュール

次Lodash