pix-shot

pix-shot

A lightweight protractor plugin for screenshots

Installation

Install this module locally with the following command:

npm install pix-shot

Save to dependencies or dev-dependencies:

npm install --save pix-shot
npm install --save-dev pix-shot

Usage

Add this plugin to the protractor config file:

exports.config = {
  plugins: [{
    package: 'pix-shot',
    screenshotOn: 'none',
    reportPath: './report/'
  }]
}

Options

reportPath

• Type: String
• Mandatory: Yes

The directory that will hold all the screenshots, relative from the project root.

screenshotOn

• Type: String
• Mandatory: No
• Options: failed | passed | all | none
• Default: failed

Sets the status on which a screenshot is taken.

formatName

• Type: String
• Mandatory: No
• Options: name, fullName, uuid, timestamp, width, height, browser, browserVersion, platform, platformVersion, device, status
• Default: {browser}_{name}-{status}_{timestamp}

User configurable format string that sets the screenshot filename.

cleanReport

• Type: Boolean
• Mandatory: No
• Default: false

If true the plugin will automatically remove all files and directories under reportPath.

Contribution

See CONTRIBUTING.md.

TODO

• Add build/release tools

License

Licensed under the MIT license.

Copyright (c) 2017 Koola.