# grunt-screencap

> Take automatic screenshots with grunt (OSX only).

Latest version **0.1.0** (published 2015-09-19) · 0 weekly downloads

## Install

```sh
npm install grunt-screencap
pnpm add grunt-screencap
yarn add grunt-screencap
bun add grunt-screencap
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-09-19 |
| First published | 2015-09-19 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.8.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jesse Luoto |
| Maintainers | jehna |
| Keywords | gruntplugin |

## Links

- npm: https://www.npmjs.com/package/grunt-screencap
- Repository: https://github.com/jehna/grunt-screencap
- Issues: https://github.com/jehna/grunt-screencap/issues
- npm.io page: https://npm.io/package/grunt-screencap

## Dependencies (1)

- [desktop-screenshot](https://npm.io/package/desktop-screenshot.md) 0.0.6

## Recent versions

- 0.1.0 (latest) — 2015-09-19

## README

# grunt-screencap

> Take automatic screenshots with grunt (OSX only).

## Getting Started
This plugin requires Grunt `~0.4.4`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-screencap --save-dev
```

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

```js
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()`.

```js
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:

```js
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](http://gruntjs.com/).

## Release History
_(Nothing yet)_

---
_Source: https://npm.io/package/grunt-screencap · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
