1.2.0 • Published 8 years ago

plum-fixture v1.2.0

Weekly downloads
2
License
MIT
Repository
github
Last release
8 years ago

plum-fixture Build Status

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

Getting Started

  • Install with NPM - npm install --save plum-fixture

Usage

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 )

NameTypeArgumentDescription
options.stylesheetsarray<required>paths to the compiled stylesheets to inject into the fixtures.
options.filesarray<required>files and/or directories of stylesheets to parse kss meta-data from.
options.templatestring<optional>path of the template to use for fixtures.
options.destinationstring<optional>path where the compiled fixtures should be saved.

callback( error, response )

NameTypeArgumentDescription
errorerror<required>any errors that may have occured.
responsestring<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
Licensed under the MIT license.

1.2.0

8 years ago

1.1.4

9 years ago

1.1.3

9 years ago

1.1.2

9 years ago

1.1.1

9 years ago

1.1.0

9 years ago

1.0.0

9 years ago