From ec68c9dc144b21317a9fa061014cfc9f9a21725e Mon Sep 17 00:00:00 2001 From: caouecs Date: Tue, 1 May 2018 11:05:51 +0200 Subject: [PATCH 1/2] doc: phan --- docs/en/README.md | 1 + docs/en/plugins/phan.md | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 docs/en/plugins/phan.md diff --git a/docs/en/README.md b/docs/en/README.md index 789f6757..0d88ed85 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -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` diff --git a/docs/en/plugins/phan.md b/docs/en/plugins/phan.md new file mode 100644 index 00000000..c9f19977 --- /dev/null +++ b/docs/en/plugins/phan.md @@ -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" +``` From 77f3b46eb3563804cbe24563b2e648564f39b95b Mon Sep 17 00:00:00 2001 From: caouecs Date: Tue, 1 May 2018 11:27:51 +0200 Subject: [PATCH 2/2] fix: phan --- docs/en/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/en/README.md b/docs/en/README.md index 0d88ed85..963bb57f 100644 --- a/docs/en/README.md +++ b/docs/en/README.md @@ -50,7 +50,7 @@ Plugins * [Lint](plugins/lint.md) - `lint` * [PDepend](plugins/pdepend.md) - `pdepend` -* [Phan](plugins/phan.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`