Vui-helpers NPM

#VUI Helpers

This project contains GULP helper scripts for building VUI components.

##Usage

Install as a development dependency:

npm install --save-dev vui-helpers

Then add it to your gulpfile.js:

var vuiHelpers = require('vui-helpers');

##API

###clean

Deletes directories or files.

gulp.task( 'clean', function() {
  return vuiHelpers.clean( [ 'dir1', 'dir2' ] );
} );

The only parameter is an array of directories/files to delete.

###makeCss

Performs a lint of the CSS files to validate syntax and CSS best practices, does a LESS compilation of any LESS files, and finally auto-prefixes the CSS to add vendor-specific prefixes based on our currently supported browsers.

var vuiHelpers = require('vui-helpers');
gulp.task( 'css', function() {
  return vuiHelpers.makeCss( 'source/*', 'dist' );
} );

The first parameter is a glob which defines your CSS input files, followed by an output directory.

###makeLess

Copies LESS files from source to target.

var vuiHelpers = require('vui-helpers');
gulp.task( 'less', function() {
  return vui.makeLess( 'src/**/*.less', 'dist/' );
} );

The first parameter is a glob which defines the LESS input files, followed by an output location.

###test

Helper for testing with Karma.

gulp.task( 'test', function () {
  return vui.test( {
    files: [
      'my-component.js',
      'my-component.css',
      'test/unit/**/*Spec.js'
    ],
    preprocessors: {
      'my-component.js': ['coverage']
    }
  } );
} );

The test helper configures the Karma test runner to use PhantomJS, coverage reporters, and Jasmine. It also includes custom Jasmine matchers that may be used in your specs. A config object must be provided to the test helper to specify the files/patterns for the test. Other Karma config properties may be provided, for instance to include files for coverage via the preprocessor property.