/grunt-step

Add confirmation steps to your Grunt flow.

Primary LanguageJavaScriptMIT LicenseMIT

grunt-step

Add confirmation steps to your Grunt flow.

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-step --save-dev

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

grunt.loadNpmTasks('grunt-step');

The "step" task

Options

options.option

Type: String Default value: 'ack'

Which option to enable the confirmation steps.

Usage Examples

grunt.registerTask('default', ['jshint', 'step', 'nodeunit', 'step', 'uglify']);

Then running grunt --ack will prompt whether to continue upon each step specified above.

Custom Option

If you want to use another option then ack set the option option:

grunt.initConfig({
  step: {
    options: {
      option: 'wait',
    },
  },
});

Now grunt --wait will trigger the prompts.

Disable Option

If you want to disable the need for an option all together, set option to false:

grunt.initConfig({
  step: {
    options: {
      option: false,
    },
  },
});

Now grunt will always trigger the prompts.

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

License

Copyright (c) 2013 Kyle Robinson Young
Licensed under the MIT license.