grunt-if
Conditionally run tasks
Getting Started
This plugin requires Grunt ~0.4.5
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-
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "if" task
Overview
In your project's Gruntfile, add a section named if
to the data object passed into grunt.initConfig()
.
grunt;
Options
options.test
Type: Function | Array of Functions
Default value: []
A function or an array of functions that must all evaluate (or resolve) to a truthy value. If a function returns a Q style promise, the test passes if the resolved value is truthy. The test will fail if the promise is rejected or the resolved value is falsey.
options.executable
Type: String | Array of Strings
Default value: []
If set, tests will be performed to determine whether the specified command line executable(s) exist.
options.config
Type: String | Object | Array of Strings or Objects
Default value: []
If a string, the test will be true if the config value of the given string is truthy. If an object, the test will do do a comparison to the provided value using the specified operand.
Usage Examples
Test Function - returns value
In this example, ifTrue
tasks are executed if the test method returns true.
grunt;
Test Function - returns promise
In this example, ifTrue
tasks are executed if the test method resolves to true after the delay.
grunt;
Test Executable
In this example, ifTrue
tasks are executed if the fontforge executable is available.
grunt;
Test Config Value
In this example, ifTrue
tasks are executed if the config value is truthy.
grunt;
In this example, ifTrue
tasks are executed if the config value matches.
grunt;
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
(Nothing yet)