Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/imweb/grunt-imweb-tpl-complie
Just a Template Complier
https://github.com/imweb/grunt-imweb-tpl-complie
Last synced: 28 days ago
JSON representation
Just a Template Complier
- Host: GitHub
- URL: https://github.com/imweb/grunt-imweb-tpl-complie
- Owner: imweb
- Created: 2014-01-10T05:17:18.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2014-09-04T09:44:46.000Z (over 10 years ago)
- Last Synced: 2024-11-19T11:03:24.980Z (about 1 month ago)
- Language: JavaScript
- Size: 387 KB
- Stars: 1
- Watchers: 12
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/QQEDU/grunt-imweb-tpl-complie)
#grunt-imweb-tpl-complie
> Just a Template Compiler
## Getting Started
This plugin requires Grunt `~0.4.0`
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-imweb-tpl-complie --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-imweb-tpl-complie');
```
## The "tplComplie" task
### Overview
In your project's Gruntfile, add a section named `tplComplie` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
tplComplie: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
})
```
### Options
#### options.namespace
Type: `String`
Default value: `'JST'`
The namespace in which the precompiled templates will be assigned.
#### options.processName
Type: `Function`
Default value: `null`
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.
#### options.processContent
Type: `Function`
Default value: `null`
This option accepts a function which takes one argument (the file content) and returns a string which will be used as template string.
### Usage Examples
#### Default Options
```js
grunt.initConfig({
tplComplie: {
options: {},
files: {
'dest/template.js': ['src/testing.html', 'src/123.html'],
},
},
})
```
#### Custom Options
```js
grunt.initConfig({
tplComplie: {
options: {
namespace: 'custom',
processName: function (filename) {
return filename.split(/src\//)[1];
},
processContent: function (source) {
return 'test - ' + source;
}
},
files: {
'dest/template.js': ['src/testing.html', 'src/123.html'],
},
},
})
```
## License
(The MIT License)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.