grunt-mustache-combine
Combine Mustache templates into one file.
Getting Started
This plugin will combine all your Mustache templates into one file (object
) and use the path of the file as the key. It won't pre-parse the file, because Mustache will do that on the first render.
Install
$ npm install --save-dev grunt-mustache-combine
Usage
grunt; // npm install --save-dev load-grunt-tasks grunt; grunt;
Examples
Custom config and rules
grunt;
Options
options.format
Type: String
Default: 'es6'
Other possible values: 'commonjs', 'amd', 'es5'
The format to output.
options.extension
Type: String
Default: '.mustache'
The extension to remove from the key.
options.removeFromKey
Type: String
Default: ''
Part of the file path to remove from the key.
options.useLowerCaseKey
Type: Boolean
Default: true
Generate lower case keys. Set to false
to ignore casing.
options.formatKey
Type: Function
Default: null
Function to generate a custom key. It overrules the removeFromKey
and useLowerCaseKey
options and receives the file path as a parameter.
grunt;
Output example and usage
// Contents of the generated templates file (default ES6 format) "my/template": "<h1>hello {{name}}</h1>"; // In your module.js;; const tpl = templates'my/template'; Mustache;
License
MIT © VI Company