Package Exports

plum-regression

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (plum-regression) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

plum-regression

Run visual regression test suites against plum stylesheets using CasperJS & PhantomCSS.

Getting Started

Install with NPM - npm install --save plum-regression

Usage

var regression = require('plum-regression');

var options = {
  stylesheets: 'path/to/stylesheets',
  tests: [ 'modules/', 'units/', 'pages/' ],
  fixtures: 'path/to/fixtures',
  results: 'path/to/save/results/to',
  failures: 'path/to/save/failures/to'
};

regression(options, function(err, response) {
  if (err) {
    return err;
  }
  return response;
});

API

regression( options )

Name	Type	Argument	Description
options.stylesheets	`string`	`<required>`	the path to your plum stylesheets.
options.tests	`array`	`<required>`	files and/or directories containing the tests to run.
options.fixtures	`string`	`<required>`	the path containing the test fixtures to use.
options.results	`string`	`<required>`	the path to save the test results to.
options.failures	`string`	`<required>`	the path to save the test failures to.

callback( error, response )

Name	Type	Argument	Description
error	`error`	`<required>`	any errors that may have occured.
response	`string`	`<required>`	success message.

Developing

plum-regression is built using ES6. Run the following task to compile the src/ into dist/.

npm run build

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.

plum-regression

Package Exports

Readme

plum-regression

Getting Started

Usage

API

regression( options )

callback( error, response )

Developing

Contributing

License