Skip to content

ktty1220/gulp-peridot

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Peridot PHP Test framework runner for gulp

Peridot is highly extensible, highly enjoyable, BDD testing framework for PHP.

Requirements

Install

$ npm install --save-dev gulp-peridot

Usage

add it to your gulpfile.js:

var peridot = require('gulp-peridot');

gulp.task('peridot', function () {
  return gulp.src('specs')  // <= test specs directory
  .pipe(peridot('/vendor/bin/peridot', {
    filter: 'foo.*.spec.php',
    configurationFile: 'bar-config.php'
    coverageText: true,
    coverageHtml: 'cov-dir',
    coverageBlacklist: [ 'libs', 'bar-config.php' ],
    coverageWhitelist: []
  }));
});

API

peridot(peridotpath, options)

peridotpath

Type: String

The path to the desired Peridot executable.

  • If not supplied, the defeault path will be ./vendor/bin/peridot or $(which peridot).

options.silent (default: false)

Type: Boolean

Do not show report.

options.dryRun (default: false)

Type: Boolean

Executes dry run (doesn't actually execute tests, just echo command that would be executed).

options.configurationFile (default: './peridot.php' (if exists) )

Type: String

Define a path to an peridot configuration file (supply full path and filename).

Code Coverage Options:

Need Xdebug and PHP_CodeCoverage.

options.coverageHtml

Type: String

Define a path to HTML code coverage report directory.

options.coverageXml

Type: String

Define a path to XML code coverage report directory.

options.coverageClover

Type: String

Define a path to Clover code coverage report file.

options.coveragePhp

Type: String

Define a path to PHP code coverage report file.

options.coverageCrap4j

Type: String

Define a path to Crap4j code coverage report file.

options.coverageText (default: false)

Type: Boolean

Show code coverage report to stdout.

options.coverageBlacklist (default: [])

Type: Array(String)

Add code coverage blacklist file/directory.

Local/global composer and gulp-peridot directories are automatically added to blacklist.

options.coverageWhitelist (default: [])

Type: Array(String)

Add code coverage whitelist file/directory.

Test Selection Options:

options.filter (default: '*.spec.php')

Type: String

Run tests matching pattern.

Test Execution Options:

options.colors (default: true)

Type: Boolean

Use colors in output.

options.stopOnFailure (default: false)

Type: Boolean

Stop execution upon first error or failure.

options.reporter (default: 'spec')

Type: String

Specify which reporter to use.

Extra

'face' reporter

gulp.task('peridot', function () {
  return gulp.src('specs')
  .pipe(peridot('/vendor/bin/peridot', {
    reporter: 'face'
  }));
});

face reporter

Changelog

0.1.0 (2015-03-26)

License

MIT license

© 2015 ktty1220

About

Peridot PHP Test framework runner for gulp

Resources

License

Stars

Watchers

Forks

Packages

No packages published