# plum-regression

> Run visual regression test suites against plum stylesheets.

Latest version **1.3.2** (published 2015-08-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install plum-regression
pnpm add plum-regression
yarn add plum-regression
bun add plum-regression
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.2 |
| Published | 2015-08-18 |
| First published | 2015-05-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jason Bellamy |
| Maintainers | jasonbellamy |
| Keywords | plum, regression, test, casperjs, phantomcss |

## Links

- npm: https://www.npmjs.com/package/plum-regression
- Repository: https://github.com/plum-css/plum-regression
- Issues: https://github.com/plum-css/plum-regression/issues
- npm.io page: https://npm.io/package/plum-regression

## Dependencies (3)

- [casper](https://npm.io/package/casper.md) ^0.1.1
- [casperjs](https://npm.io/package/casperjs.md) ^1.1.0-beta3
- [phantomcss](https://npm.io/package/phantomcss.md) ^0.10.0

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads
- [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads

## Recent versions

- 1.3.2 (latest) — 2015-08-18
- 1.3.1 — 2015-05-20
- 1.3.0 — 2015-05-19
- 1.2.1 — 2015-05-13
- 1.2.0 — 2015-05-13
- 1.1.0 — 2015-05-13
- 1.0.0 — 2015-05-12

## README

# plum-regression [![Build Status](https://travis-ci.org/plum-css/plum-regression.png?branch=master)](https://travis-ci.org/plum-css/plum-regression)

> Run visual regression test suites against plum stylesheets using [CasperJS](http://casperjs.org/) & [PhantomCSS](https://github.com/Huddle/PhantomCSS).


## Getting Started

- Install with [NPM](https://www.npmjs.org/) - `npm install --save plum-regression`


## Usage

```javascript
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](https://github.com/plum-css/plum-regression) is built using **ES6**. Run the following task to compile the `src/` into `dist/`.

```bash
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.


## License
Copyright (c) 2015 [Jason Bellamy ](http://jasonbellamy.com)  
Licensed under the MIT license.

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