Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sergiopvilar/grunt-requirejs-templates
A plugin to insert the content of template files like underscore, handlebars to string variables into the javascript code
https://github.com/sergiopvilar/grunt-requirejs-templates
Last synced: about 1 month ago
JSON representation
A plugin to insert the content of template files like underscore, handlebars to string variables into the javascript code
- Host: GitHub
- URL: https://github.com/sergiopvilar/grunt-requirejs-templates
- Owner: sergiopvilar
- License: mit
- Created: 2013-12-07T19:10:27.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2016-02-21T06:37:27.000Z (almost 9 years ago)
- Last Synced: 2024-11-07T00:48:17.619Z (2 months ago)
- Language: JavaScript
- Size: 235 KB
- Stars: 1
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
grunt-requirejs-templates
=========================
> A plugin to insert the content of template files like underscore, handlebars to variables into the javascript code
## Getting Started
This plugin requires Grunt `~0.4.2`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
npm install grunt-requirejs-templates --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-requirejs-templates');
```
## What it does
Supposing that you have your template files in a separated folder and loads them with Require.js like this:
```js
define([
'text!templates/myTemplate.html'
], function (Template) {
var html = _.template(Template)({name: "Sergio"});
});
```
The grunt-requirejs gets the content of the template file and put it into a string to prevent your application to make a XMLHttpRequest to load it:
```js
define([
], function () {
var Template = '
This is my template file, <%=name%>!
';
var html = _.template(Template)({name: "Sergio"});
});
```
### Supported template engines
Today grunt-requirejs-templates supports this template engines:
* [Handlebars](http://handlebarsjs.com/)
* [Underscore](http://underscorejs.org/#template)
* [EJS](http://embeddedjs.com/)
* [Dust](http://akdubya.github.io/dustjs/)
Help us to write tests and support another template engines!
## The "requirejs_templates" task
### Overview
In your project's Gruntfile, add a section named `requirejs_templates` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
requirejs_templates: {
dist: {
options: {
// your options here
},
}
}
});
```
### Options
#### options.appDir
Type: `String`
Default value: `'.'`
Path to your application
#### options.scripts
Type: `String`
Default value: `'scripts'`
Path to your javascript files
#### options.templates
Type: `String`
Default value: `'templates'`
#### options.output
Type: `String`
Default value: `null`
Path to your create the script files after processing, the default value will output to the source folder.
### Usage Examples
```js
define({
requirejs_templates: {
dist: {
options: {
appDir: "app",
scripts: "scripts", // This will read the app/scripts folder
templates: "templates",
output "dist" // This will create the dist/scripts folder
},
}
}
});
```
## 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](http://gruntjs.com/).
## Release History
_(Nothing yet)_
=======