pecan

0.0.2 • Public • Published

pecan

Compile your templates to a location that may or may not yet exist.

Pecan is a depedency of asparagus, extending your nuts in a healthy, flexible wrapper for easy consumption.

Build Status NPM version

Install

$ npm install pecan

JavaScript

var pecan = require('aspargus');

// A source and destination paths are required

pecan({ jsPath: '/dest/path', tmplPath: '/src/path' }, {
    format: 'camelcase',
    namespace: 'partials',
    basedir: __dirname + '/views/dev'
})
.compile();

Plays nice with Gulp too simply wrap the above in a gulp task, I.e.,

var gulp = require('gulp'),
    pecan = require('pecan');

gulp.task('pecan', function () {

    pecan({ jsPath: '/dest/path', tmplPath: '/src/path' }, {
        format: 'camelcase',
        namespace: 'partials',
        basedir: __dirname + '/views/dev'
    })
    .compile();
});

Browser

Templates are added to the namespace by the function name corresponding to their filename. If you are using Jade, you'll need to include Jade Runtime in the browser.

window.partials = {
    functionName: function () { ..... }
};

Options

[format] {String}
    - The format of each compiled template function name in the namespace, defaults to 'underscore' delimited function names.

[namespace] {String}
    - The namespace object on the `window` object that will store references to the compiled template functions, defaults to 'templates'.

[basedir] {String}
    - allows for absolute include paths, defaults to the value of paths.tmplPath.

Package Sidebar

Install

npm i pecan

Weekly Downloads

0

Version

0.0.2

License

MIT

Last publish

Collaborators

  • josephchapman