From b949f304825981d12cc6c50cf0b2c79fd7103d5b Mon Sep 17 00:00:00 2001 From: Daniel Bachhuber Date: Sat, 2 Aug 2014 11:16:44 -0400 Subject: [PATCH] Update the docs some --- php/commands/scaffold.php | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/php/commands/scaffold.php b/php/commands/scaffold.php index 198d7c78..675cd0b0 100644 --- a/php/commands/scaffold.php +++ b/php/commands/scaffold.php @@ -302,18 +302,28 @@ class Scaffold_Command extends WP_CLI_Command { } /** - * Generate files needed for running PHPUnit tests. + * Generate files needed for writing Behat tests for your command. * * ## DESCRIPTION * * These are the files that are generated: * * * `.travis.yml` is the configuration file for Travis CI + * * `bin/install-package-tests.sh` will configure environment to run tests. Script expects WP_CLI_BIN_DIR and WP_CLI_CONFIG_PATH environment variables. + * * `features/load-wp-cli.feature` is a basic test to confirm WP-CLI can load. + * * `features/bootstrap`, `features/steps`, `features/extra` are Behat configuration files. + * * `utils/generate-package-require-from-composer.php` generates a test config.yml file from your package's composer.json + * + * ## ENVIRONMENT + * + * The `features/bootstrap/FeatureContext.php` file expects the WP_CLI_BIN_DIR and WP_CLI_CONFIG_PATH environment variables. + * + * WP-CLI Behat framework uses Behat ~2.5. * * ## OPTIONS * * - * : The package directory to generate tests for + * : The package directory to generate tests for. * * ## EXAMPLE *