sindresorhus / broccoli-jade

Compile Jade templates

Deprecated

The project was renamed to Pug. Use broccoli-pug instead.

---

broccoli-jade

Compile Jade templates

Issues with the output should be reported on the Jade issue tracker.

Install

$ npm install --save-dev broccoli-jade

Usage

var jade = require('broccoli-jade');
tree = jade(tree, options);

A note about include paths

Include paths are resolved relative to the root of the tree, not to the Jade file itself. There are however workarounds to this, for example by using broccoli-static-compiler - here's an example.

API

jade(tree, [options])

options

See the Jade options.

In addition you can pass in options.data that will be used as locals for your HTML compilation.

License

MIT © Sindre Sorhus

broccoli-jade's Issues

Include paths are relative to Brocfile, not to jade file

I have a project layout like this:

Brocfile.js
app/
    index.jade
    views/
        my-file-to-include.jade
build/

When running broccoli from the root of my project, an broccoli-jade throws an error that the include path views/my-file-to-include.jade in index.jade can't be resolved. If I instead write it as app/views/my-file-to-include.jade, it's resolved. I would consider this behavior a bug, since I expect import paths to be resolved relative to the jade file, not to the Brocfile.

support for extend

Does this plugin supports auto recompilation of jade files that uses extend directive? I have following simple set of templates and Brocfile.js

app/_layout.jade

doctype html
html
  head
    meta(http-equiv='Content-Type', content='text/html; charset=utf-8')
    meta(name="viewport", content="width=device-width, initial-scale=1, maximum-scale=1")

  body
    h1 Broccoli-jade
    block content

app/index.jade

extends _layout
block content
  p This allows you to use index.static.jade instead of index.html for brunch! ...

Brocfile.js

var pickFiles = require('broccoli-static-compiler')
var processJade = require('broccoli-jade')

appFiles = pickFiles('app', {
  srcDir: '/',
  destDir: ''
})
module.exports = processJade(appFiles, {filename: 'app/_layout'})

It recompiles _layout.jade into _layout.html. However, the dependent template (index.jade) is left as it is unless broccoli is restarted.

Load included files from Broccoli input tree

Currently, this plug-in does not appear to notice included files changing to realize a rebuild is necessary. This suggests that it is not currently loading those included files from the broccoli input tree, but rather is looking past broccoli, directly to the file system. I'm not sure if this diagnosis is correct, but it does seem to explain that the problematic (and I'm pretty confident, erroneous) behavior.

I think this is also related to another open item, but I'm not 100% sure. Fix wanted.