Skip to content

Latest commit

 

History

History
96 lines (68 loc) · 1.81 KB

README.md

File metadata and controls

96 lines (68 loc) · 1.81 KB

gulp-lab

Gulp test runner for Lab.

Gulp-lab supports the same options as Lab.

Install

npm install gulp-lab --save-dev

@hapi/lab

"@hapi/lab" package is supported in version 2.0.
The older version called "lab" is supported in version 1.0.8.

NOTES

Gulp-lab can be used with String, Array and Object options or without.

Gulp-lab can emit an Error when tests fails. Simply use options object with property "emitLabError" on true! By default, "emitLabError" is false.

Example 1 - without options

// gulpfile.js
var gulp = require('gulp');
var lab = require('gulp-lab');

gulp.task('test', function () {
    return gulp.src('test')
      .pipe(lab());
});

gulp.task('default', ['test']);

Example 2 - options by a String

// gulpfile.js
var gulp = require('gulp');
var lab = require('gulp-lab');

gulp.task('test', function () {
    return gulp.src('test')
      .pipe(lab('-v -l -C'));
});

gulp.task('default', ['test']);

Example 3 - options by an Array

// gulpfile.js
var gulp = require('gulp');
var lab = require('gulp-lab');

gulp.task('test', function () {
    return gulp.src('test')
      .pipe(lab(['-v', '-l', '-C']));
});

gulp.task('default', ['test']);

Example 4 - options by an Object in conjunction with JSHint

NOTE: args property can be either a String or an Array and is OPTIONAL!

// gulpfile.js
var gulp = require('gulp');
var jshint = require('gulp-jshint');
var lab = require('gulp-lab');

gulp.task('test', function () {
  return gulp.src('./test/**/*.js')
    .pipe(lab({
      args: '-v -C',
      opts: {
        emitLabError: true
      }
    }))
    .pipe(jshint())
    .pipe(jshint.reporter('default'));
});

gulp.task('default', ['test']);