0.1.0 • Published 7 years ago

grunt-psi-html-report v0.1.0

Weekly downloads
2
License
-
Repository
github
Last release
7 years ago

grunt-psi-html-report

Creates html report of Google's PageSpeed Insights scores for multiple urls.

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-psi-html-report --save-dev

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

grunt.loadNpmTasks('grunt-psi-html-report');

The "psi_html_report" task

Overview

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

grunt.initConfig({
  psi_html_report: {
    default_options: {
        options: {
          urls:["https://www.google.com","https://www.youtube.com"]
        }, 
      }
  },
});

Options

options.urls

Type: Array Default value: ["https://www.google.com"]

An array of urls on which PageSpeed Insights psi command is to be run.

Usage Examples

Default Options

In this example, there are two urls in array. Results can be seen in screenshot below.

grunt.initConfig({
  psi_html_report: {
    default_options: {
        options: {
          urls:["https://www.youtube.com","https://www.twitter.com"]
        }, 
      }
  },
});

HTML Report

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)