grunt-yslow-test

Runs the yslow phantom script from a grunt task

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-yslow-test --save-dev

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

grunt.loadNpmTasks('grunt-yslow-test');

The "yslow_test" task

Overview

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

grunt.initConfig({
  yslow_test: {
    options: {
      info: "grade",
      format: "junit",
      urls: ['http://google.com'],
      reports: ['test/reports/yslow.xml']
    },
    your_target: {
      files: []
    }
  }
})

Options

options.urls

An array of URLs to visit

options.reports

An array of files to write output reports into. These match the URLs on array index. If no reports are found, a file will not be written

The options mirror those available in the yslow.js plugin. Please see http://yslow.org/phantomjs/ for parameters.

Please note, as this script uses URLs and not local files, Grunt's File API does not work. However, it is still mandatory, so leave it blank

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({
  yslow_test: {
    options: {
      info: "grade",
      format: "junit",
      urls: ['http://google.com'],
      reports: ['test/reports/yslow.xml']
    },
    your_target: {
      files: []
    }
  }
})

Release History

0.1.0: First release