grunt-screencap

grunt-screencap

Take automatic screenshots with grunt (OSX only).

Getting Started

This plugin requires Grunt ~0.4.4

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

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

grunt.loadNpmTasks('grunt-screencap');

The "screencap" task

Overview

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

grunt.initConfig({
    screencap: {
        options: {
            output: 'screenshots/screenshot.png',
        }
    },
    watch: {
        default: {
            files: ['**/*.js'],
            tasks: ['screencap'],
        }
    }
});

Options

options.output

Type: String Requred value

The name of the output file to create. The plugin adds a suffix of the current timestamp to the filename.

Usage Examples

Default Options

This example takes the screenshot and saves it to the screenshots/ folder:

grunt.initConfig({
    screencap: {
        options: {
            output: 'screenshots/screenshot.png'
        }
    }
});

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)