README.md

JST

JST is a simple javascript templating system inspired by Sprockets' homonimous templating system, but built for rails projects without Sprockets.

JST works on top of PrototypeJS's template system and HandleBars.

Install

Add this line to your application's Gemfile:

gem 'jst', github: 'seekingalpha/jst'

And then execute:

$ bundle

Usage

Create a folder in your project and add PrototypeJS templates with the ".jst.pt" extension or Handlebars with the ".jst.hb". Let's suppose you have a "hi.jst.pt" file in "app/assets/javascripts/templates":

  <h1>Hi, #{name}</h1>

In order to compile your templates, run:

  JST::Aggregator.new('app/assets/javascripts/templates').save('public/javascripts/templates.js')

If you don't wanna pass the paths every time, you can configure it first (rule of thumb: add it to config/initializers/jst.rb):

  JST.configure do |config|
    config.templates_path = 'app/assets/javascripts/templates'
    config.output         = 'public/javascripts/templates.js'
  end

Then you can just run:

  JST.process!

Now, load templates.js in your view and then you can use the templates like this in your JS files:

  Templates.hi({name: 'Emmanuel'})

This will output <h1>Hi, Emmanuel</h1>, as expected. Notice the method "hi" is created automatically based on the name of the template file.

Enjoy!

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Roadmap

• Use guard to watch template folder and compile automatically when changed.
• Allow handlebars templates.