deblan/php-censor
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Improved docs

Browse source
This commit is contained in:
Dmitry Khomutov 2016-07-19 15:12:28 +06:00
commit 320a249153
49 changed files with 454 additions and 193 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/en/plugins/php_code_sniffer.md
View file

@ -1,7 +1,13 @@
Plugin PHP Code Sniffer
-----------------------
Runs PHP Code Sniffer against your build.
## Configuration
Configuration
=============
### Options
* **allowed_warnings** [int, optional] - The warning limit for a successful build.
* **allowed_errors** [int, optional] - The error limit for a successful build.
* **suffixes** [array, optional] - An array of file extensions to check.
@ -11,7 +17,8 @@ Runs PHP Code Sniffer against your build.
* **path** [string, optional] - Path in which to run PHP Code Sniffer.
* **ignore** [array, optional] - A list of files / paths to ignore, defaults to the build_settings ignore list.
### Example
### Examples
Simple example where PHPCS will run on app directory, but ignore the views folder, and use PSR-1 and PSR-2 rules for validation:
```yml
test: