From 5bb908c20549e6df890293ac3e23739880cfe241 Mon Sep 17 00:00:00 2001 From: Owen Voke Date: Fri, 2 Oct 2020 12:01:32 +0100 Subject: [PATCH] phan: add page (#4376) --- pages/common/phan.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 pages/common/phan.md diff --git a/pages/common/phan.md b/pages/common/phan.md new file mode 100644 index 0000000000..b219863fea --- /dev/null +++ b/pages/common/phan.md @@ -0,0 +1,32 @@ +# phan + +> A static analysis tool for PHP. +> More information: . + +- Generate a `.phan/config.php` in the current directory: + +`phan --init` + +- Generate a Phan configuration file using a specific level (1 being strictest to 5 being the least strict): + +`phan --init --init-level {{level}}` + +- Analyse the current directory: + +`phan` + +- Analyse one or more directories: + +`phan --directory {{path/to/directory}} --directory {{path/to/another_directory}}` + +- Specify a config file (defaults to `.phan/config.php`): + +`phan --config-file {{path/to/config.php}}` + +- Specify the output mode: + +`phan --output-mode {{text|verbose|json|csv|codeclimate|checkstyle|pylint|html}}` + +- Specify the number of parallel processes: + +`phan --processes {{number_of_processes}}`