grunt-slim-php

grunt-slim-php

Process Slim templates using slimphp, a PHP port of Ruby's Slim.

Getting Started

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-slim-php --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-slim-php');

The "slimphp" task

This plugin requires composer in order to install PHP dependencies. Please follow the installation instructions before installing this plugin.

Overview

In your project's Gruntfile, add a section named slimphp to the data object passed into grunt.initConfig().

grunt.initConfig({
  slimphp: {
    options: {
      // Task-specific options go here.
    },
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
})

Options

options.tabSizeInput

Type: Number Default value: 2

Set the tab size for input files (slim files), which is used by slimphp's parser.

options.tabSizeOutput

Type: Number Default value: 4

Set the tab size for output files (html files) generated by slimphp.

options.writeError

Type: Boolean Default value: true

If enabled, write any compile errors to the output file. Otherwise do nothing.

Usage Examples

Simple file mapping

grunt.initConfig({
  slimphp: {
    compile: {
      files: {
        'dest/file1.html': ['src/file1.slim'],
      },
    },
  },
})

All slim files

This example compiles all slim files in a directory and adds a php extension.

grunt.initConfig({
  slim: {
    compile: {
      files: [{
        expand: true,
        src: ['src/templates/**/*.slim'],
        dest: 'dest/templates',
        ext: '.php'
      }],
    },
  },
})

Contributing

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.

Release History

• 12/23/2015 - v0.0.3 - Use slimphp v0.0.3
• 12/23/2015 - v0.0.2 - Tab size options added.
• 12/22/2015 - v0.0.1 - Initial release.