# gulp-phpspec

> PHP PHPSpec plugin for Gulp

Latest version **0.5.5** (published 2017-01-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-phpspec
pnpm add gulp-phpspec
yarn add gulp-phpspec
bun add gulp-phpspec
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.5 |
| Published | 2017-01-21 |
| First published | 2014-02-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+6 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Mike Erickson |
| Maintainers | codedungeon |
| Keywords | gulpplugin, phpspec |

## Links

- npm: https://www.npmjs.com/package/gulp-phpspec
- Repository: https://github.com/mikeerickson/gulp-phpspec
- Issues: https://github.com/mikeerickson/gulp-phpspec/issues
- npm.io page: https://npm.io/package/gulp-phpspec

## Dependencies (4)

- [chalk](https://npm.io/package/chalk.md) 1.1.3
- [lodash](https://npm.io/package/lodash.md) ^3.8.0
- [gulp-util](https://npm.io/package/gulp-util.md) 3.0.8
- [map-stream](https://npm.io/package/map-stream.md) 0.0.6

## Recent versions

- 0.5.5 (latest) — 2017-01-21
- 0.5.4 — 2016-02-13
- 0.5.3 — 2015-05-22
- 0.5.2 — 2015-05-22
- 0.5.1 — 2015-05-12
- 0.5.0 — 2015-05-12
- 0.4.2 — 2015-05-08
- 0.4.1 — 2015-05-08
- 0.4.0 — 2015-05-08
- 0.3.1 — 2014-10-16
- 0.3.0 — 2014-09-13
- 0.2.6 — 2014-08-29
- 0.2.5 — 2014-07-02
- 0.2.4 — 2014-07-02
- 0.2.3 — 2014-07-02
- … 3 more at https://npm.io/package/gulp-phpspec/versions

## README

# gulp-phpspec
> PHPSpec plugin for gulp 3

## Usage

First, install `gulp-phpspec` as a development dependency:

```shell
npm install --save-dev gulp-phpspec
```

Then, add it to your `gulpfile.js`:

```javascript
var phpspec = require('gulp-phpspec');

// option 1: default format
gulp.task('phpspec', function() {
	gulp.src('phpsec.yml').pipe(phpspec());
});

// option 2: with defined bin and options
gulp.task('phpspec', function() {
	var options = {debug: false};
	gulp.src('phpspec.yml').pipe(phpspec('./vendor/bin/phpspec run',options));
});

// option 3: supply callback to integrate something like notification (using gulp-notify)

var gulp = require('gulp'),
 notify  = require('gulp-notify'),
 phpspec = require('gulp-phpspec'),
 _       = require('lodash');

  gulp.task('phpspec', function() {
    gulp.src('phpspec.yml')
      .pipe(phpspec('', {notify: true}))
      .on('error', notify.onError(testNotification('fail', 'phpspec')))
      .pipe(notify(testNotification('pass', 'phpspec')));
  });

function testNotification(status, pluginName, override) {
	var options = {
		title:   ( status == 'pass' ) ? 'Tests Passed' : 'Tests Failed',
		message: ( status == 'pass' ) ? '\n\nAll tests have passed!\n\n' : '\n\nOne or more tests failed...\n\n',
		icon:    __dirname + '/node_modules/gulp-' + pluginName +'/assets/test-' + status + '.png'
	};
	options = _.merge(options, override);
  return options;
}

```

### Sample Gulpfile

If you want a quick and dirty gulpfile, here is one I created for testing this plugin

[Gist: https://gist.github.com/mikeerickson/9163621](https://gist.github.com/mikeerickson/9163621)


## API

### (phpspecpath,options,cb)

#### phpspecpath

Type: `String`

The path to the desired PHPSpec binary
- If not supplied, the defeault path will be ./vendor/bin/phpspec

#### options.debug
Type: `Boolean (Default: false)`

Emit error details and shows command used in console

#### options.clear
Type: `Boolean (Default: false)`

Clear console before executing command


#### options.notify
Type: `Boolean (Default: false)`

Call user supplied callback to handle notification (use gulp-notify)

#### options.verbose
Type: `String (Default null)`

Adjust the default verbosity of messages
v|vv|vvv Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

#### options.noInteraction
Type: `Boolean (Default: false)`
*Note: changed from noInteract -* __0.3.0__

Do not ask any interactive question (disables code generation).

#### options.noAnsi
Type: `Boolean (Default: false)`

Disable ANSI output (ommiting parameter or setting to false will display ansi colors output)

#### options.quiet
Type: `Boolean (Default: false)`

Do not output any message.

#### options.formatter
Type: `String`

Display PHPSpec custom formatters (ie pretty)


## Credits

gulp-phpspec written by Mike Erickson

E-Mail: [codedungeon@gmail.com](mailto:codedungeon@gmail.com)

Twitter: [@codedungeon](http://twitter.com/codedungeon)

Webiste: [codedungeon.org](http://codedungeon.org)

---
_Source: https://npm.io/package/gulp-phpspec · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._