Giter VIP home page Giter VIP logo

gulp-precompile-handlebars's Introduction

Build Status

gulp-precompile-handlebars

A gulp plugin to precompile handlebars templates, and output separate compiled templates that use the exports syntax. It is easy to use the plugin gulp-define-module to wrap the compiled templates in a module bundling syntax. Precompiling is required when you want to enable Content Security Policy on your server, as handlebars, compiling in the client, uses eval or new Function(String) which is not allowed. If you precompile, you can just use the runtime version of Handlebars which doesn't have the compilation code.

Usage

Installation

npm install gulp-precompile-handlebars

Gulp configuration

The plugin takes a stream of multiple files and returns the compiled result. It is up to you to rename those files and move them to a specific folder. This example uses the gulp-rename plugin for changing the extension and gulp-define-module to wrap it with the desired module definition.

var gulp = require('gulp');
var rename = require('gulp-rename');
var defineModule = require('gulp-define-module');
var precompileHandlebars = require('gulp-precompile-handlebars');

return gulp.src('src/templates/*.hbs')
  .pipe(precompileHandlebars())
  .pipe(rename({ extname: '.js' }))
  .pipe(defineModule('es6'))
  .pipe(gulp.dest('src/templates'));

Precompile Handlebars consumes an optional configuration parameter and passes it on to the handlebars precompile function precompileHandlebars({noEscape: true}), but you can also use the gulp-front-matter plugin to attach compile settings to your files front matter for some, specific control:

---
noEscape: true
---
<div>{{foo}}</div>

Project

You can now use handlebars-runtime in your project instead of the full version.

// import handlebars runtime
import handleBars from 'handlebars/handlebars.runtime.js';

// grab the compiled template
import compiledTemplate from 'path/to/compiled/template.js';

// execute the template with optional data
var parsed = compiledTemplate({ foo: 'bar' });

gulp-precompile-handlebars's People

Contributors

justusromijn avatar tobsn avatar

Watchers

James Cloos avatar  avatar

Forkers

nllwrq tobsn

gulp-precompile-handlebars's Issues

Readme example missing )

Easy to fix but just though I'd point out. This line:

.pipe(rename({ extname: '.js' })

needs to be:

.pipe(rename({ extname: '.js' }))

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.