chop-grunt-php-builder

Grunt plugin to statically build PHP files

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 chop-grunt-php-builder --save-dev

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

grunt.loadNpmTasks('chop-grunt-php-builder');

The "chop_grunt_php_builder" task

Overview

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

grunt.initConfig({
  php_builder: {
    options: {
      // Task-specific options go here.
    }
  },
})

Options

options.path

Type: String Default value: ', '

Path for the builder script

options.output

Type: String

Directory to output to

options.input

Type: Array

An Array of strings of the filenames to compile

options.base_path

Type: String Default value: process.cwd()

Base file path for input files

Usage Examples

Default Options

In this example, the default options are used to do something with whatever. So if the testing file has the content Testing and the 123 file had the content 1 2 3, the generated result would be Testing, 1 2 3.

grunt.initConfig({
  chop_grunt_php_builder: {
    options: {},
    files: {
      'dest/default_options': ['src/testing', 'src/123'],
    },
  },
})

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

0.1.0 Initial Release