node package manager
Painless code sharing. npm Orgs help your team discover, share, and reuse code. Create a free org »

gulp-ejs

gulp-ejs NPM version Build Status Dependency Status

Greenkeeper badge

ejs plugin for gulp

Usage

First, install gulp-ejs as a development dependency:

npm install --save-dev gulp-ejs

Then, add it to your gulpfile.js:

var ejs = require("gulp-ejs")
 
gulp.src("./templates/*.ejs")
    .pipe(ejs({
        msg: "Hello Gulp!"
    }))
    .pipe(gulp.dest("./dist"))

If you want to use gulp-ejs in a watch/livereload task, you may want to avoid gulp exiting on error when, for instance, a partial file is ENOENT. Here's an example on how to make it work:

var ejs = require('gulp-ejs')
var gutil = require('gulp-util')
 
gulp.src('./templates/*.ejs')
    .pipe(ejs({
        msg: 'Hello Gulp!'
    }).on('error', gutil.log))
    .pipe(gulp.dest('./dist'))

This will make gulp log the error and continue normal execution.

If you want to specify the extension of output files, set the ext option:

var ejs = require('gulp-ejs')
 
gulp.src('./templates/*.ejs')
    .pipe(ejs({
        msg: 'Hello Gulp!',
        ext: '.html'
    })
    .pipe(gulp.dest('./dist'))

Acessing the ejs object

The ejs object is also exported and you can use it to configure ejs:

var gulpEjs = require('gulp-ejs')
 
gulpEjs.ejs.fileLoader = function () { /* custom file loader */ }

API

ejs(data, options, settings)

data

Type: hash Default: {}

A hash object where each key corresponds to a variable in your template.

Note: As of v1.2.0, file.data is supported as a way of passing data into ejs. See this. If both file.data and data are passed, they are merged (data works as default for ejs options and file.data overrides it.)

options

Type: hash Default: {}

A hash object for ejs options.

For more info on ejs options, check the project's documentation.

settings

Type: hash Default: {}

A hash object to configure the plugin.

settings.ext

Type: String Default: undefined

Defines the file extension that will be appended to the filename. If no extension is provided, the same extension of the input file will be used.

Note: As of v2.0.0 the output file extension is no longer .html by default, you need to specify it, otherwise it will have the same extension of the input file.

License

MIT License