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

15
docs/en/plugins/php_cs_fixes.md
View file

@ -1,13 +1,20 @@
Plugin PHP Coding Standards Fixer
---------------------------------
Runs PHP Coding Standards Fixer against your build.
## Configuration
Configuration
=============
### Options
* **verbose** [bool, optional] - Whether to run in verbose mode (default: false)
* **diff** [bool, optional] - Whether to run with the `--diff` flag enabled (default: false)
* **level** [string, optional] - `psr0`, `psr1`, `psr2`, or `symphony` (default: all)
* **workingdir** [string, optional] - The directory in which PHP CS Fixer should work (default: build root)
### Example
### Examples
```yml
test:
php_cs_fixer:
@ -17,5 +24,7 @@ test:
workingdir: "my/dir/path"
```
## Warning
Warning
=======
There is currently a bug with this plugin that will cause an error if you leave the level to default to `all`. That level does not exist and will cause the build to fail. Instead specify the level explicitly until this is fixed.