gulp-ejs-templates/README.md

Precompile EJS templates to a JS file.

gulp-ejs-template
====
> Precompile EJS templates to a JS file.

[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]

## Only support v2.x https://github.com/mde/ejs.

## Install

Install with [npm](https://npmjs.org/package/gulp-ejs-template)

```
npm install --save-dev gulp-ejs-template
```

## Usage

```js
var gulpEjs = require('gulp-ejs-template');

gulp.task('ejsTemplate', function () {
  return gulp.src('test/fixtures/*.html')
  .pipe(gulpEjs({
    moduleName: 'templates'
  }))
  .pipe(gulp.dest('test'));
});
```

## Demo

`test/fixtures/header.html`:
```html
<p><%= locals.title || 'gulp' %> module</p>
<%- include('user.html', locals.user) %>
```
`test/fixtures/user-list.html`:
```html
<ul>
  <% locals.users.forEach(function(user) { -%>
    <li>
      <%= user.name %>
    </li>
  <% }) -%>
</ul>
```
`test/fixtures/user.html`:
```html
<h1><%= locals.name %></h1>
```

precompile to `test/templates.js`:
```js
;(function(root, factory) {
  'use strict';

  if (typeof module === 'object' && module.exports) module.exports = factory();
  else if (typeof define === 'function' && define.amd) define([], factory);
  else root.templates = factory();
}(typeof window === 'object' ? window : this, function() {
  'use strict';
  var templates = {};

  templates['header']  = templates['header.html'] = function(it) {
    var locals = it, __output = "";
    var include = function(tplName, data) { return render(tplName, data); }
    ;__output += "<p>";;__output += escape(locals.title || 'gulp');__output += " module</p>\n";;__output = [__output, include('user.html', locals.user)].join("");__output += "\n";
    return __output.trim();
  };

  templates['user-list']  = templates['user-list.html'] = function(it) {
    var locals = it, __output = "";
    ;__output += "<ul>\n  ";; locals.users.forEach(function(user) { ;__output += "    <li>\n      ";;__output += escape(user.name);__output += "\n    </li>\n  ";; }) ;__output += "</ul>\n";
    return __output.trim();
  };

  templates['user']  = templates['user.html'] = function(it) {
    var locals = it, __output = "";
    ;__output += "<h1>";;__output += escape(locals.name);__output += "</h1>\n";
    return __output.trim();
  };

  var ejs = {
    locals: {},
    get: getTpl,
    render: render
  };
  return ejs;

  function render(tplName, data) {
    var it  = copy({}, ejs.locals);
    return getTpl(tplName)(copy(it, data));
  }

  function getTpl(tplName) {
    return templates[tplName];
  }

  function escape(markup) {
    if (!markup) return '';
    return String(markup)
      .replace(/&/g, '&amp;')
      .replace(/</g, '&lt;')
      .replace(/>/g, '&gt;')
      .replace(/'/g, '&#39;')
      .replace(/"/g, '&quot;');
  }

  function copy(to, from) {
    from = from || {};
    for (var key in from) to[key] = from[key];
    return to;
  }
}));

```


## API

```js
var gulpEjs = require('gulp-ejs-template');

gulp.task('ejsTemplate', function () {
  return gulp.src('test/fixtures/*.html')
    .pipe(gulpEjs({/*options*/}))
    .pipe(gulp.dest('test'));
});
```

### options.moduleName

*Optional*, Type: `String`, Default: `'templates'`.

Name of the templates module.

### options.delimiter

*Optional*, Type: `String`, Default: `%`.

ejs's delimiter.

### templates funciton

```js
var ejs = require('templates.js');
```

### ejs.locals = {}

```js
ejs.locals = {
  local: 'en',
  __: function(i18nStr) {/* i18n function */}
}
```

### ejs.get(tplName)

```js
var tplFunction = ejs.get('header');
```

### ejs.render(tplName, data)

```js
var tpl = ejs.render('header', {
  title: 'gulp-ejs-template',
  user: {
    name: 'zensh'
  }
});
```

## License

MIT © [Teambition](http://teambition.com)

[npm-url]: https://npmjs.org/package/gulp-ejs-template
[npm-image]: http://img.shields.io/npm/v/gulp-ejs-template.svg

[travis-url]: https://travis-ci.org/teambition/gulp-ejs-template
[travis-image]: http://img.shields.io/travis/teambition/gulp-ejs-template.svg