Plum-test NPM | npm.io

plum-test

Build and run visual regression tests against plum stylesheets.

Getting Started

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

Usage

Node

var plumTest = require('plum-test');

var options = {
  src: 'path/to/plum/directory',
  dest: 'path/to/save/results/to',
  stylesheets: ['path/to/compiled/stylesheets'],
};

plumTest(options, function(err, res) {
  if (err) {
    return err;
  }
  return res;
});

CLI

plum-test
  --src='path/to/plum/directory'
  --dest='path/to/save/results/to'
  --stylesheets='path/to/compiled/stylesheet, path/to/another/compiled/stylesheet'

To run only a specific test(s) you can pass a comma , seperated list of paths to the the --tests.

plum-test
  --src='path/to/plum/directory'
  --dest='path/to/save/results/to'
  --stylesheets='path/to/compiled/stylesheet, path/to/another/compiled/stylesheet'
  --tests='path/to/plum/directory/modules/module-one' # only test the module-one module.

API

test( options )

Name	Type	Argument	Description
options.src	`string`	`<required>`	the src path to your plum stylesheets.
options.dest	`string`	`<required>`	the path to save the test results to.
options.stylesheets	`array\|string`	`<required>`	the paths to your compiled css stylesheets.
options.tests	`array\|string`	`<optional>`	the paths to the tests to be run.