grunt-sculpin
v0.2.0
Published
Grunt plugin for running Sculpin.
Downloads
121
Maintainers
Readme
grunt-sculpin
Grunt plugin for running Sculpin.
Getting Started
This plugin requires Grunt ~0.4.4
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-sculpin --save-dev
Once you installed the plugin you can enable it inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-sculpin');
Tasks
grunt-sculpin
contains the following tasks:
The "sculpin-generate" task
The sculpin-generate
task executes Sculpin's generate
command.
Overview
In your project's Gruntfile, add a section named sculpin-generate
to the data object passed into grunt.initConfig()
.
'sculpin-generate': {
options: {
// Task-specific options go here.
},
your_target: {
args: {
// Arguments
}
}
}
Options
options.bin
Type: String
Default value: sculpin
Path to Sculpin binary that you want to use.
Usage Examples
Default Options
grunt-sculpin
uses by default sculpin
as binary to execute commands.
'sculpin-generate': {
options: {},
build: {}
}
Custom Options
If you want to use a custom binary, you can change the bin
option.
'sculpin-generate': {
options: {
bin: 'php bin/sculpin'
},
build: {
args: {
env: 'prod'
}
}
}
The "sculpin-watch" task
The sculpin-watch
task executes Sculpin's generate --watch
command.
Overview
In your project's Gruntfile, add a section named sculpin-watch
to the data object passed into grunt.initConfig()
.
'sculpin-watch': {
options: {
// Task-specific options go here.
},
your_target: {
args: {
// Arguments
}
}
}
Options
Supports the same options as sulpin-generate
Usage Examples
Default Options
grunt-sculpin
uses by default sculpin
as binary to execute commands.
'sculpin-watch': {
options: {},
build: {}
}
The "sculpin-serve" task
The sculpin-serve
task executes Sculpin's server
command.
Overview
In your project's Gruntfile, add a section named sculpin-serve
to the data object passed into grunt.initConfig()
.
'sculpin-serve': {
options: {
// Task-specific options go here.
},
your_target: {
args: {
// Arguments
}
}
}
Options
Supports the same options as sulpin-generate
Usage Examples
Default Options
grunt-sculpin
uses by default sculpin
as binary to execute commands.
'sculpin-serve': {
options: {},
build: {}
}
Author
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
Version 0.2 (11 April 2014)
- Show output of Sculpin in Grunt output
Version 0.1 (30 March 2014)
- Initial release