Repository files navigation

Take the fat out of your client-side templates with Skim. Skim is theSlim templating enginewith embedded CoffeeScript. It compiles to JavaScript templates (.jst), which can then be served by Rails or any otherSprockets-based asset pipeline.

gem install skim, or addskim to yourGemfile.

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:

• Options to output Skim asset and templates separately.
• Options to assign template function tomodule.exports, a global function variable, or a global object (keyed by filename, as Sprockets does with itsJST object).

Usage:skim [options]

-s, --stdin                      Read input from standard input instead of an input file-e, --export                     Assign to module.exports for CommonJS require-n, --node-global                Use Node.js global object for global assignments    --jst                        Assign to global JST object keyed by truncated filename    --assign variableName        Assign to a global variable    --assign-object objectName   Assign to a global object keyed by truncated filename    --asset-only                 Output only the Skim preamble asset    --omit-asset                 Omit Skim preamble asset from output    --trace                      Show a full traceback on error-o, --option name=code           Set skim option-r, --require library            Load library or plugin-h, --help                       Show this help message-v, --version                    Print version number

Skim is an early proof-of-concept. Some Slim features are still missing:

• Skim does not currently support embedded engines. Being a client-side templating languages, it will only be able to support embedded engines with a client-side implementation.
• Skim does not currently support HTML pretty-printing (Slim's:pretty option). This is low priority, as pretty-printing is even less important client-side than server-side.
• Skim does not currently support backslash line continuations.

Skim supports the following Slim language features:

• doctype declarations (doctype)
• HTML Comments (/!) and conditional comments (/[...])
• static content (same line and nested)
• dynamic content, escaped and not (= and==)
• control logic (-)
• string interpolation, escaped and not (#{} and#{{}})
• id and class attribute shortcuts (# and.)
• attribute and attribute value wrappers
• logic-less (sections) mode

Several Coffee/JavaScript considerations are specific to Skim:

• When interpolating the results of evaluating code, Skim will replacenull andundefined results with an emptystring.
• You will typically want to use the fat arrow=> function definition to create callbacks, to preserve the binding ofthis analogously to howself behaves in a Ruby block.

The context object you pass to the compiled template function becomes the value of this inside your template. You canuse 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 bypassingescaping. In addition, the specialsafe method on the context object tells Skim that the string can be output withoutbeing escaped. You can use this in conjunction withescape 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=@escapeproject.name@safe"<a href='#{url}'>#{name}</a>"

to produce:

<ahref='/projects/4'>Crate &amp; Barrel</a>

By default, all you need to do to start using Skim is add it to your Gemfile. Skim will embed a small amount ofsupporting 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 toapplication.js:

//= require skim

And the following in an initializer:

Skim::Engine.default_options[:use_asset]=true

Skim templates also support dependency injection for the Skim asset, instead of using a global Skim variable. Example in Node.js:

varSkim=require('./skim_asset_module.js')vartemplate=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 obtaininga copy of this software and associated documentation files (the"Software"), to deal in the Software without restriction, includingwithout limitation the rights to use, copy, modify, merge, publish,distribute, sublicense, and/or sell copies of the Software, and topermit persons to whom the Software is furnished to do so, subject tothe following conditions:

The above copyright notice and this permission notice shall beincluded 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 OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE ANDNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BELIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTIONOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTIONWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

• John Firebaugh, for creating Skim
• Andrew Stone, for Slim
• Magnus Holm, for Temple
• Daniel Mendler, for maintenance of Slim and Temple