Skip to content

Latest commit

 

History

History
101 lines (80 loc) · 2.59 KB

README.md

File metadata and controls

101 lines (80 loc) · 2.59 KB
Raw

grunt-har-gen Build Status

Grunt plugin for generating HAR files from a series of URLs

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-har-gen --save-dev

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

grunt.loadNpmTasks('grunt-har-gen');

The "hargen" task

Overview

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

grunt.initConfig({
  hargen: {
    options: {
      urls: {
        'google_com.har': 'http://www.google.com',
      },
      output: './tmp/test'
    },
    your_target: {
      options: {
        urls: {
          'google_com.har': 'http://www.google.com',
          'google_fr.har': 'http://www.google.fr',
          'google_com.har': 'http://www.google.com'
        },
        output: './tmp/test'
      }
    },
  },
})

Options

options.urls

Type: Object Default value: {}

An object that represents a hash of filenames and URLs. The object keys is the filenames. The object values are the URLs.

options.output

Type: String Default value: './tmp'

A string for the path to the folder that the HAR files will be generated.

Usage Examples

Default Options

In this example, the default options are used to generate HAR files in the tmp folder

grunt.initConfig({
  hargen: {
    options: {
      urls: {
        'google_com.har': 'http://www.google.com',
      },
    }
  },
})

Setting the output

In this example, options are used to generate HAR files in the ./performance/reports folder

grunt.initConfig({
  hargen: {
    options: {
      urls: {
        'google_uk.har': 'http://www.gogle.co.uk',
        'google_fr.har': 'http://www.google.fr',
        'google_com.har': 'http://www.google.com'
      },
      output: './performance/reports'
    }
  },
})

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)