# plum-fixture

> Parses your PLUM stylesheets for KSS meta-data and builds HTML fixtures.

Latest version **1.2.0** (published 2015-12-18) · MIT license · 0 weekly downloads

## Install

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

## 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.2.0 |
| Published | 2015-12-18 |
| First published | 2015-05-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jason Bellamy |
| Maintainers | jasonbellamy |
| Keywords | plum, fixture, generator, kss |

## Links

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

## Dependencies (4)

- [kss](https://npm.io/package/kss.md) ^2.0.2
- [bluebird](https://npm.io/package/bluebird.md) ^2.9.24
- [fs-extra](https://npm.io/package/fs-extra.md) ^0.23.1
- [mustache](https://npm.io/package/mustache.md) ^2.0.0

## Recent versions

- 1.2.0 (latest) — 2015-12-18
- 1.1.4 — 2015-08-17
- 1.1.3 — 2015-08-13
- 1.1.2 — 2015-08-12
- 1.1.1 — 2015-08-11
- 1.1.0 — 2015-05-20
- 1.0.0 — 2015-05-12

## README

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

> Parses your PLUM stylesheets for KSS meta-data and builds HTML fixtures.


## Getting Started

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


## Usage

```javascript
var fixture = require( 'plum-fixture' );

var options = {
  stylesheets: ['paths/to/compiled/stylesheets'],
  files: [ 'modules/', 'units/', 'pages/' ],
  destination: 'path/to/save/fixtures/to'
};

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

  return response;
});
```


## API

### fixture( options )

Name                | Type     | Argument     | Description
--------------------|----------|--------------|------------
options.stylesheets | `array`  | `<required>` | paths to the compiled stylesheets to inject into the fixtures.
options.files       | `array`  | `<required>` | files and/or directories of stylesheets to parse kss meta-data from.
options.template    | `string` | `<optional>` | path of the template to use for fixtures.
options.destination | `string` | `<optional>` | path where the compiled fixtures should be saved.

#### callback( error, response )

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


## 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-fixture · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._