Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oroce/grunt-jade-plugin
Grunt plugin to precompile Jade templates to JavaScript file (normal or AMD).
https://github.com/oroce/grunt-jade-plugin
Last synced: about 1 month ago
JSON representation
Grunt plugin to precompile Jade templates to JavaScript file (normal or AMD).
- Host: GitHub
- URL: https://github.com/oroce/grunt-jade-plugin
- Owner: oroce
- License: mit
- Created: 2013-01-18T19:28:28.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2013-01-18T21:17:51.000Z (almost 12 years ago)
- Last Synced: 2024-04-14T14:45:45.846Z (9 months ago)
- Language: JavaScript
- Size: 104 KB
- Stars: 0
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-jade-plugin [!['Build status'][travis_image_url]][travis_page_url]
[travis_image_url]: https://secure.travis-ci.org/ivanvotti/grunt-jade-plugin.png?branch=master
[travis_page_url]: https://travis-ci.org/ivanvotti/grunt-jade-plugin
> Precompile Jade templates to JavaScript file (normal or AMD).
## Installation
In your project's [gruntfile][getting_started] directory, run:
```bash
npm install grunt-jade-plugin
```
Then add this line to your project's [gruntfile][getting_started]:
```javascript
grunt.loadNpmTasks('grunt-jade-plugin');
```
## Config Examples
Normal JS file compilation.
``` javascript
jade: {
compile: {
options: {
namespace: 'MyApp.Templates'
},
files: {
'path/to/result.js': 'temlates/*.jade'
}
}
}
```
For AMD compilation add `amd: true` option.
``` javascript
jade: {
amd: {
options: {
amd: true,
runtimeName: 'jade',
},
files: {
'templates.js': 'temlates/*.jade'
}
}
}
```
## Documentation
Inside your `grunt.js` file, add a section named `jade`. This section specifies the files to compile and the options used with [Jade][].
#### Files ```object```
This defines what files this task will process and should contain key:value pairs.
The key (destination) should be an unique filepath (supports [grunt.template][]) and the value (source) should be a filepath or an array of filepaths (supports [minimatch][]).
Note: Values are precompiled to the namespaced array in the order passed.
Examples:
```javascript
files: {
'result.js': 'source/*.jade', // includes files from source dir only
'result.js': 'source/**/*.jade', // includes files from source dir and all its subdirs
'result.js': ['path/to/sources/file.jade', 'path/to/more/other.jade']
}
```
#### Options ```object```
This controls how this task operates and should contain key:value pairs, see options below.
Defaults:
```javascript
options: {
amd: false,
runtimeName: 'jade',
compileDebug: false,
namespace: 'Templates',
processName: function(filename) { return filename; }
}
```
##### namespace ```string```
The namespace in which the precompiled templates will be assigned (default is `'Templates'`). *Use dot notation (e.g. App.Templates) for nested namespaces.*
Example:
``` javascript
options: {
namespace: 'MyApp.Templates'
}
```
Result:
``` javascript
this['MyApp'] = this['MyApp'] || {};
this['MyApp']['Templates'] = this['MyApp']['Templates'] || {};
// Template function
this['MyApp']['Templates']['templates/file1.jade'] = function() {};
```
##### amd ```boolean```
Determine if preprocessed template functions will be wrapped in [Require.js][] define function (default is `false`).
``` javascript
define(['jade'], function(jade) {
// ...
});
```
##### processName ```function```
This option accepts a function which takes one argument (the template filepath) and returns a string which will be used as the key for the precompiled template object. The example below stores all templates on the default Templates namespace in capital letters.
``` javascript
options: {
processName: function(filename) {
return filename.toUpperCase();
}
}
```
## Release History
Check the [HISTORY.md][] file for more information.
## License
Copyright (c) 2012 Ivan Votti
Licensed under the MIT license.
[history.md]: https://github.com/ivanvotti/grunt-jade-plugin/blob/master/HISTORY.md
[grunt]: https://github.com/gruntjs/grunt
[getting_started]: https://github.com/gruntjs/grunt/blob/master/docs/getting_started.md
[grunt.template]: https://github.com/gruntjs/grunt/blob/master/docs/api_template.md
[minimatch]: https://github.com/isaacs/minimatch
[require.js]: http://requirejs.org
[jade]: http://jade-lang.com