From 342d50859cd17a6d36dbc877ddd8ef64cefe1a28 Mon Sep 17 00:00:00 2001 From: tot-ra Date: Thu, 13 Nov 2014 07:53:56 -0800 Subject: [PATCH] Explanation on what arguments are for what mode --- Php-unit-plugin.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/Php-unit-plugin.md b/Php-unit-plugin.md index 05acdea..1613972 100644 --- a/Php-unit-plugin.md +++ b/Php-unit-plugin.md @@ -1,13 +1,18 @@ Runs PHPUnit tests against your build. +Has two modes: -### Configuration Options: - -* **directory** - Optional - The directory (or array of dirs) to run PHPUnit on +### With phpunit.xml configuration file +Its activated if you have phpunit.xml file in your build path, `tests/` subfolder, or you specify it as a parameter: * **config** - Optional - Path to a PHP Unit XML configuration file. * **run_from** - Optional - When running PHPUnit with an XML config, the command is run from this directory -* **path** - Optional - In cases where tests files are in a sub path of the /tests path, allows this path to be set in the config. -* **args** - Optional - Command line args (in string format) to pass to PHP Unit * **coverage** - Optional - Value for the `--coverage-html` command line flag. +* **path** - Optional - In cases where tests files are in a sub path of the /tests path, allows this path to be set in the config. + +### Running tests in directory by listing it. +* **directory** - Optional - The directory (or array of dirs) to run PHPUnit on + +Both modes accept: +* **args** - Optional - Command line args (in string format) to pass to PHP Unit ### Examples Specify config file and test directory: