Skip to content

doc: phan #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
corpsee merged 2 commits into from
May 1, 2018
+25 −0
Merged

doc: phan #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec68c9d
doc: phan
caouecs May 1, 2018
77f3b46
fix: phan
caouecs May 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/en/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ Plugins

* [Lint](plugins/lint.md) - `lint`
* [PDepend](plugins/pdepend.md) - `pdepend`
* [Phan](plugins/phan.md) - `phan`
* [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`
Expand Down
24 changes: 24 additions & 0 deletions docs/en/plugins/phan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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"
```