/node-jst

simple, hacky sprocket-like template precompiler

Primary LanguageJavaScriptMIT LicenseMIT

JavaScriptTemplate (pre-compiler)

Something like Jammit but only for your Backbone templates.

This is a small library for Node.js I wrote during holidays so, it's a work in progress, most likey won't work as expected.

JST will compile a directory full of

templates into a single templates.js to use on the frontend

Configuration:

var jst = require('jst');
jst.compiler = 'handlebars'; // or 'underscore' (default) or 'hogan'

Example One-time Compile:

jst.compile(__dirname + '/templates', __dirname + '/public/javascripts/', function() {
  return console.log('recompiled ' + '/javascripts/admin/templates.js'.red);
});

Example directory watcher (useful in a development environment):

jst.watcher(__dirname + '/templates', __dirname + '/public/javascripts/', function() {
  return console.log('recompiled ' + '/javascripts/admin/templates.js'.red);
});

You can access to the template functions using the global namespace JST:

var teplate = JST.foo({
  template: 'context'
}, template_options);

$('#foo').htm(template);

Custom Namespace

The global namespace can be costumized using the jst.namespace var:

var jst = require('jst');

jst.namespace = 'MyCustomNameSpace'

TODO

  1. Write tests
  2. Write more tests
  3. rework the file watcher using inotify/fswatcher
  4. use it daily

Contribute

Fork the project.
Make your feature addition or bug fix.
Send me a pull request. Bonus points for topic branches.
Bump the version number, if you really have to, in a separate commit.

License

jst is provided as-is under the MIT License.

Copyright (c) 2011 Lorenzo Giuliani lorenzo@frenzart.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.