Grunt plugin for running PHP Code Sniffer.
MIT License
Grunt plugin for running PHP Code Sniffer.
This plugin is developed for Grunt 0.4.0
and is not tested for backward compatibility with Grunt 0.3.x
.
##Getting Started
Install this grunt plugin with the following command:
npm install grunt-phpcs --save-dev
Install PHP Code Sniffer (preferably with composer)
Add this to your project's Gruntfile.js
gruntfile:
grunt.loadNpmTasks('grunt-phpcs');
##PHP Code Sniffer task
Run this task with the grunt phpcs
command.
Task targets, files and options may be specified according to the grunt Configuring tasks guide.
###Usage Example
phpcs: {
application: {
src: ['application/classes/*.php', 'application/lib/**/*.php']
},
options: {
bin: 'vendor/bin/phpcs',
standard: 'Zend'
}
}
Do whatever you want with the output.
function log(err, stdout, stderr, cb) {
console.log(stdout);
cb();
}
grunt.initConfig({
phpcs: {
application: {
src: ['application/classes/*.php', 'application/lib/**/*.php']
},
options: {
callback: log
}
}
});
###Options
####bin
Type: String
Default: 'phpcs'
####maxBuffer
Type: Number
Default: 200*1024
Set the buffer size.
####verbose
Type: Boolean
Default: false
Output more verbose information.
####showSniffCodes
Type: Boolean
Default: false
Show sniff codes in all reports.
####severity
Type: Integer
Default: false
The minimum severity required to display an error or warning.
####warningSeverity
Type: Integer
Default: false
The minimum severity required to display a warning.
####errorSeverity
Type: Integer
Default: false
The minimum severity required to display an error.
####standard
Type: String
Default: false
Define the standard to use.
####report
Type: String
Default: false
Report types and options
####reportFile
Type: String
Default: false
Log report to the file.
####tabWidth
Type: Integer
Default: false
Automatically convert tabs to the specified number of spaces when sniffing.