grunt-speedgun

Automate running Speedgun with Grunt

Getting Started

This plugin requires Grunt ~0.4.5 and PhantomJS 2.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-speedgun --save-dev

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

grunt.loadNpmTasks('grunt-speedgun');

The "speedgun" task

Overview

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

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

Options

options.url

Type: String Default value: 'http://localhost'

Required. The URL of the server to benchmark with speedgun.

options.port

Type: Integer Default value: null

Optional. The port required to reach the server.

options.limit

Type: Integer Default value: 10

Optional. The Limit of the number of rows of the report to display to console.

options.verbose

Type: Boolean Default value: false

Optional. Display more information. Helpful for debugging.

Usage Examples

grunt.initConfig({
  speedgun: {
    localhost: {
        options: {
            port: 4000
        }
    }
  }
});

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)