Process HAML templates using MtHaml, a PHP port of Haml.
This plugin requires Grunt ~0.4.1
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-haml-php --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-haml-php');
This plugin requires composer in order to install PHP dependencies. Please follow the installation instructions before installing this plugin.
In your project's Gruntfile, add a section named haml
to the data object passed into grunt.initConfig()
.
grunt.initConfig({
haml: {
options: {
// Task-specific options go here.
},
your_target: {
// Target-specific file lists and/or options go here.
},
},
})
Type: String
Default value: php
Set the target output generated by MtHaml. Valid options are php
and twig
.
Type: Boolean
Default value: true
If enabled, write any compile errors to the output file. Otherwise do nothing.
Type: Boolean
Default value: true
Controls the enable_dynamic_attrs
option of MtHaml. Disabling this removes the requirement for the MtHaml runtime.
grunt.initConfig({
haml: {
compile: {
files: {
'dest/file1.html': ['src/file1.haml'],
},
},
},
})
This example compiles all haml files in a directory and adds a php extension.
grunt.initConfig({
haml: {
compile: {
files: [{
expand: true,
src: ['src/templates/**/*.haml'],
dest: 'dest/templates',
ext: '.php'
}],
},
},
})
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.