Improved docs
This commit is contained in:
parent
ae22073ff0
commit
320a249153
49 changed files with 454 additions and 193 deletions
|
|
@ -1,7 +1,13 @@
|
|||
Plugin PHP Mess Detector
|
||||
------------------------
|
||||
|
||||
Runs PHP Mess Detector against your build. Records some key metrics, and also reports errors and warnings.
|
||||
|
||||
## Configuration
|
||||
Configuration
|
||||
=============
|
||||
|
||||
### Options
|
||||
|
||||
- **allowed_warnings** [int, optional] - The warning limit for a successful build (default: 0). -1 disables warnings. Setting allowed_warnings in conjunction with zero_config will override zero_config.
|
||||
- **suffixes** [array, optional] - An array of file extensions to check (default: 'php')
|
||||
- **ignore** [array, optional] - An array of files/paths to ignore (default: build_settings > ignore)
|
||||
|
|
@ -9,8 +15,8 @@ Runs PHP Mess Detector against your build. Records some key metrics, and also re
|
|||
- **rules** [array, optional] - Array of rulesets that PHPMD should use when checking your build or a string containing at least one slash, will be treated as path to PHPMD ruleset. See http://phpmd.org/rules/index.html for complete details on the rules. (default: ['codesize', 'unusedcode', 'naming']).
|
||||
- **zero_config** [bool, optional] - Suppresses build failure on errors and warnings if set to true. (default: false).
|
||||
|
||||
### Examples
|
||||
|
||||
### Example
|
||||
```yml
|
||||
test:
|
||||
php_mess_detector:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue