Fat-free client-side templates with Slim and CoffeeScript
Fat-free client-side templates with Slim and CoffeeScript
Take the fat out of your client-side templates with Skim. Skim is the Slim templating engine
with embedded CoffeeScript. It compiles to JavaScript templates (.jst), which can then be served by Rails or any other
Sprockets-based asset pipeline.
gem install skim, or add skim to your Gemfile.
Create template files with the extension
.jst.skim. For example, test.jst.skim:
p Hello #{@world}!In your JavaScript or CoffeeScript, render the result, passing a context object:
$("body").html(JST["test"]({world: "World"}));The CLI allows Skim to be used in Gulp and Grunt workflows, extending the reach of Skim from the Ruby world into the JS/ES/CoffeeScript communities.
Features:
module.exports, a global function variable, or a global object (keyed by filename, as Sprockets does with its JST object).Usage: skim [options]
…Skim is an early proof-of-concept. Some Slim features are still missing:
:pretty option). This is low priority, as pretty-printing is even less important client-side than server-side.Skim supports the following Slim language features:
doctype)/!) and conditional comments (/[...])= and ==)-)#{} and #{{}})# and .)Several Coffee/JavaScript considerations are specific to Skim:
null and undefined results with an empty
string.=> function definition to create callbacks, to preserve the binding of
this analogously to how self behaves in a Ruby block.The context object you pass to the compiled template function becomes the value of this inside your template. You can
use CoffeeScript's @ sigil to easily access properties and call helper methods on the context object.
Like Slim, Skim escapes dynamic output by default, and it supports the same == and #{{}} syntaxes for bypassing
escaping. In addition, the special safe method on the context object tells Skim that the string can be output without
being escaped. You can use this in conjunction with escape context method to selectively sanitize parts of the string.
For example, given the template:
= @linkTo(@project)you could render it with the following context:
JST["my_template"]
project: { id: 4, name: "Crate & Barrel" }
linkTo: (project) ->
url = "/projects/#{project.id}"
name = @escape project.name
@safe "#{name}"to produce:
Crate & BarrelBy default, all you need to do to start using Skim is add it to your Gemfile. Skim will embed a small amount of
supporting code in each generated template asset. You can remove this duplication by manually including Skim's asset,
and setting Skim's :use_asset option to true.
In Rails, this can be done by adding the following to application.js:
//= require skimAnd the following in an initializer:
Skim::Engine.default_options[:use_asset] = trueSkim templates also support dependency injection for the Skim asset, instead of using a global Skim variable. Example in Node.js:
var Skim = require('./skim_asset_module.js')
var template = require('./template_module.js');
console.log(template({Skim: Skim, first_name: 'Dave', last_name: 'Smith'}));Copyright (c) 2012 John Firebaugh, (c) 2015 AppJudo Inc.
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.
No open issues yet, or sync has not completed.