grunt-phpcs

grunt-phpcs

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.

This task is a multi task so any targets, files and options should be specified according to the multi task documentation.

###Usage Example

phpcs: {
	application: {
		dir: 'application/classes'
	},
	options: {
		bin: 'vendor/bin/phpcs',
		standard: 'Zend'
	}
}

###Target Properties ####dir Type: String

The file or directory where phpcs should search for files.

###Options ####bin Type: String Default: 'phpcs'

####debug Type: Boolean Default: false

Display debbuging information during execution. This option can also be set by running the task with --debug.

####extensions Type: String Default: false

A comma separated list of file extensions to check. This option can also be set by running the task with --extensions=<extensions>.

####ignore Type: String Default: false

A comma separated list of patterns to ignore files and directories. This option can also be set by running the task with --ignore=<ignore>.

####severity Type: Integer Default: false

The minimum severity required to display an error or warning. This option can also be set by running the task with --severity=<severity>.

####standard Type: String Default: false Define the standard to use. This option can also be set by running the task with --standard=<standard>.

####verbose Type: Boolean Default: false

Output more verbose information. This option can also be set by running the task with --verbose.

####reportFile Type: string Default: false

Log report to the file. This option can also be set by running the task with --report-file.