gulp-haml
Version:
Gulp plugin for haml
122 lines (88 loc) • 2.94 kB
Markdown
#Gulp-Haml
[](https://travis-ci.org/stevelacy/gulp-haml)
[](http://badge.fury.io/js/gulp-haml)
## Information
<table>
<tr>
<td>Package</td><td>gulp-haml</td>
</tr>
<tr>
<td>Description</td>
<td>Haml plugin for Gulp</td>
</tr>
<tr>
<td>Node Version</td>
<td>>= 0.9</td>
</tr>
<tr>
<td>Gulp Version</td>
<td>3.x</td>
</tr>
</table>
## Usage
#### Install
npm install gulp-haml --save
## Examples
```javascript
// Gulpfile.js
// Require the needed packages
var gulp = require('gulp');
var haml = require('gulp-haml');
// Get one .haml file and render
gulp.task('one', function () {
gulp.src('./haml/file.haml')
.pipe(haml())
.pipe(gulp.dest('./html'));
});
// Get all .haml files in one folder and render
gulp.task('one', function () {
gulp.src('./haml/blue/*.haml')
.pipe(haml())
.pipe(gulp.dest('./haml/blue'));
});
// Get and render all .haml files recursively
gulp.task('haml', function () {
gulp.src('./haml/**/*.haml')
.pipe(haml())
.pipe(gulp.dest('./haml'));
});
// Options
// Change file extension
gulp.task('haml', function () {
gulp.src('./haml/**/*.haml')
.pipe(haml({ext: '.php'}))
.pipe(gulp.dest('./php'));
});
// Default gulp task to run
gulp.task('default', function(){
gulp.run('haml', 'one');
});
```
You can view more examples in the [example folder.](https://github.com/stevelacy/gulp-haml/tree/master/examples)
## Options
`Object, String`
Options are passed straight through to the [haml](https://npmjs.org/package/haml) module with the exclusion of `ext`
### Options.ext
`ext: String`
Example:
.pipe(haml({ext: '.php'}))
.pipe(haml({ext: '.txt'}))
## LICENSE
(MIT License)
Copyright (c) 2014 Steve Lacy <me@slacy.me> slacy.me - Fractal <contact@wearefractal.com> wearefractal.com
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.