nephrite
v2.3.2
Published
[![Build Status](https://secure.travis-ci.org/Nami-Doc/nephrite.png)](http://travis-ci.org/Nami-Doc/nephrite)
Downloads
13
Readme
Nephrite
Pre-compiles jade to Coffee/Coco/LiveScript, allowing you to have the syntax of jade with the best perfs (only interpolation is used). It also avoids you the pain of undefined and null by auto-soaking.
To make you understand this a bit better, let's say that your code :
ul#pages
for page in @pages
li: a(href="page/#{page}")= page
will get compiled to
'<ul id="pages">' + join((function () {
var ref$, results$ = [];
for (key in ref$ = locals.pages) {
val = ref$[key];
results$.push('<li><a href="page/' + page + '">' + page + '</a></li>');
}
return results$;
}()) || '') + '</ul>'
Jade itself can be slow due to several factors (with
, attrs
, escape
) and this project allows you to avoid that!
(the code is highly unstable and total crap) Tho, it's used in html5chan and wowboardhelpers.
Usage
Compile it and use it later.
Attributes are passed as locals
, aliased to @
. You can pass an extra attributes object as @@
# compile it
nephrite = require 'nephrite'
src = nephrite.compile 'a(b="#{@c}")', 'index.jade'
js = Coco.compile src, {bare: true, filename}
# use it
fn obj, extra
Syntax
The syntax is the same as Jade, with a few gotchas :
- Don't prefix your tags with
-
.-
is jade interpolation, to allow for even better perfs on static content :
ul#pages
- for (var i = 0; i <= 10; ++i)
li(page=i)== i
The jade output is
==
. This will be optimized (compiled by jade)Tags are automatically recognized. Currently supported tags are :
if
,unless
,while
,for
,else
. Loops are automatically joined.To avoid complexity in the converter, for attribute interpolation you have to explicitely interpolate them :
a(href=foo) Foo!
will use jadea(href="#{foo}") Foo!
will useThe "silent code interpolation" is
~
(take note that any code interpolation appearing BEFORE content will be moved out of the closure for better perfs.) For example :
~ template = require 'user-template'
~ /*^ this will be moved out of the closure function*/
#users
~ /*this will not*/
~ "this won't be outputted anyway"