grunt-jade

Compile jade templates with grunt.

npm install grunt-jade
53 downloads in the last day
536 downloads in the last week
2 123 downloads in the last month

grunt-jade build status

Compile jade templates with grunt.

Notices

This plugin requires Grunt ~0.4.0

If you are looking for the version of this that works in Grunt ~0.3.0, use version 0.3.9

Getting Started

Install this grunt plugin next to your project's grunt.js gruntfile with: npm install grunt-jade

Then add this line to your project's grunt.js gruntfile:

grunt.loadNpmTasks('grunt-jade');

Documentation

To your grunt.js gruntfile, add:

jade: {
  no_options: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path'
  }
}

For AMD compilation, add: (dependencies is what you want the runtime to be named)

jade: {
  amd: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path',
    wrapper: {
      amd: true,
      dependencies: 'jade'
    }
  }
}

For node-style (Modules/1.0) compilation, add: (dependencies is what you want the runtime to be named)

jade: {
  node: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path',
    wrapper: {
      node: true,
      dependencies: 'runtime'
    }
  }
}

For debug compilation, add:

jade: {
  debug: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path',
    options: {
      compileDebug: true
    }
  }
}

For HTML compilation (instead of JS), add:

jade: {
  html: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path',
    options: {
      client: false
    }
  }
}

For unwrapped functions, add:

jade: {
  unwrapped: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path/',
    wrapper: {
      wrap: false
    }
  }
}

To keep directory structure, use basePath:

jade: {
  base_path: {
    files: {
      'dest/path/': ['path/to/src/*.jade'],
    },
    options: {
      basePath: 'path/to/'
    }
  }
}

For no runtime file, add:

jade: {
  no_runtime: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path/',
    options: {
      runtime: false,
    }
  }
}

For locals, add:

jade: {
  locals: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path/',
    options: {
      client: false,
      locals: {
        title: 'Welcome to my website!'
      }
    }
  }
}

Or alternatively, use a function:

jade: {
  locals: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path/',
    options: {
      client: false,
      locals: function() {
          return {compiledAt: new Date()};
      }
    }
  }
}

This is useful when you are also using the watch task, since the function will be called on each reload.

For custom extension, add:

jade: {
  custom_extension: {
    src: ['path/to/src/*.jade'],
    dest: 'dest/path/',
    options: {
      extension: '.xml',
    }
  }
}

Defaults

options: {
  client: true,
  runtime: true,
  compileDebug: false,
  locals: {},
  extension: null,
  basePath: null
}

wrapper: {
  wrap: true,
  amd: false,
  dependencies: ''
}

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Release History

(Nothing yet)

License

Copyright (c) 2013 Blaine Bublitz Licensed under the MIT license.

npm loves you