PHPLint plugin for Gulp
Install phplint
service (globally)
npm i -g phplint
yarn global add phplint
Install gulp-phplint
as a development dependency to your project (for each project)
npm i -S gulp-phplint
yarn add gulp-phplint -D
After you have installed the plugin, reference it in to your gulpfile.js
:
var phplint = require('gulp-phplint');
Default format. Equivalent to using phplint
in command line (no options).
var gulp = require('gulp');
var phplint = require('gulp-phplint');
gulp.task('phplint', function() {
gulp.src('')
.pipe(phplint());
});
Default format using the error
reporter.
gulp.task('phplint', function() {
return gulp.src(['./src/AppBundle/**/*.php'])
.pipe(phplint('', { /*opts*/ }))
.pipe(phplint.reporter('error'));
});
Custom src files and custom reporter.
gulp.task('phplint:custom', function () {
return gulp.src(['./src/AppBundle/**/*.php'])
.pipe(phplint('', { /*opts*/ }))
.pipe(phplint.reporter(function(file){
var report = file.phplintReport || {};
if (report.error) {
console.error(report.message+' on line '+report.line+' of '+report.filename);
}
}));
});
Type: String
Path to php
binary.
If not supplied, the default php path will be used.
Type: Boolean
Default: false
Enable debug mode (enables --debug switch as well).
Type: Boolean
Default: false
Clear console before executing command.
Type: Boolean
Default: false
Simulates script execution. Doesn't actually execute tests, just echoes command that would be executed.
Type: Boolean
Default: true
Conditionally display notification (both console and growl where applicable).
Type: Boolean
Default: true
Displays status lines as follows:
- green for passing files
- red for failing files
- yellow for an execution which has
debug
property enabled (will also display red and green statuses)
Type: Boolean
Default: false
Suppress reporting files which don't have syntax errors (files that passed linting).
gulp-phplint written by Mike Erickson
E-Mail: codedungeon@gmail.com
Twitter: @codedungeon
Website: codedungeon.org
Inspired By: jamarzka/gulp-phplint