doc: phan
This commit is contained in:
parent
7693eda59e
commit
ec68c9dc14
|
@ -50,6 +50,7 @@ Plugins
|
|||
|
||||
* [Lint](plugins/lint.md) - `lint`
|
||||
* [PDepend](plugins/pdepend.md) - `pdepend`
|
||||
* [Phan](plugins/phan.md) - `pdepend`
|
||||
* [PHP Code Sniffer](plugins/php_code_sniffer.md) - `php_code_sniffer`
|
||||
* [PHP Copy/Paste Detector](plugins/php_cpd.md) - `php_cpd`
|
||||
* [PHP Coding Standards Fixer](plugins/php_cs_fixes.md) - `php_cs_fixer`
|
||||
|
|
24
docs/en/plugins/phan.md
Normal file
24
docs/en/plugins/phan.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
Plugin Phan
|
||||
===========
|
||||
|
||||
Runs [Phan](https://github.com/phan/phan) against your build.
|
||||
|
||||
Configuration
|
||||
-------------
|
||||
|
||||
### Options
|
||||
|
||||
* **directory** [optional, string] - Directory within which you want Phan to run (default: `%BUILD_PATH%`).
|
||||
* **ignore** [optional] - A list of files / paths to ignore (default: build_settings > ignore).
|
||||
* **allowed_warnings** [optional, int] - The error limit for a successful build (default: 0). -1 disables warnings.
|
||||
|
||||
### Examples
|
||||
|
||||
```yml
|
||||
test:
|
||||
phan:
|
||||
directory: "app"
|
||||
allowed_warnings: 10
|
||||
ignore:
|
||||
- "app/my/path"
|
||||
```
|
Loading…
Reference in a new issue