brainbytes / gulp-hamlc

Gulp plugin for Haml

#Gulp-Hamlc

A modified version to gulp-haml to work with haml-coffee.

Issues with the output should be reported on haml-coffee

Information

Package	gulp-hamlc
Description	Haml plugin for Gulp-coffee
Node Version	>= 0.9
Gulp Version	3.x

Usage

Install

npm install gulp-hamlc --save

Examples

// Gulpfile.js
// Require the needed packages
var gulp = require('gulp');
var haml = require('gulp-hamlc');


// 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.

Options

Object, String

Options are passed straight through to the haml module with the exclusion of ext and compile

Options.compile

compile: bool Example:

.pipe(haml{compile: true}))

Options.ext

ext: String

Example:

.pipe(haml({ext: '.php'}))
.pipe(haml({ext: '.txt'}))

LICENSE

(MIT License)

Copyright (c) 2014 Steve Lacy [email protected] slacy.me - Fractal [email protected] 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.