feat(cli): update help text

pact-foundation · Sep 5, 2018 · 740dc4b · 740dc4b
1 parent a8074ee
commit 740dc4b
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -40,16 +40,34 @@ Usage:
   pact-provider-verifier PACT_URL ... -h, --provider-base-url=PROVIDER_BASE_URL
 
 Options:
-  -h, --provider-base-url=PROVIDER_BASE_URL                          # Provider host URL
-  -c, [--provider-states-setup-url=PROVIDER_STATES_SETUP_URL]        # Base URL to setup the provider states at
-  -a, [--provider-app-version=PROVIDER_APP_VERSION]                  # Provider application version, required when publishing verification results
-  -r, [--publish-verification-results=PUBLISH_VERIFICATION_RESULTS]  # Publish verification results to the broker
-  -n, [--broker-username=BROKER_USERNAME]                            # Pact Broker basic auth username
-  -p, [--broker-password=BROKER_PASSWORD]                            # Pact Broker basic auth password
-      [--custom-provider-header=CUSTOM_PROVIDER_HEADER]              # Header to add to provider state set up and pact verification requests. eg 'Authorization: Basic cGFjdDpwYWN0'. May be specified multiple times.
-  -v, [--verbose=VERBOSE]                                            # Verbose output
-  -f, [--format=FORMATTER]                                           # RSpec formatter. Defaults to custom Pact formatter. json and RspecJunitFormatter may also be used.
-  -u, [--pact-urls=PACT_URLS]                                        # DEPRECATED. Please provide as space separated arguments.
+  -h, --provider-base-url=PROVIDER_BASE_URL
+        # Provider host URL
+  -c, [--provider-states-setup-url=PROVIDER_STATES_SETUP_URL]
+        # Base URL to setup the provider states at
+      [--pact-broker-base-url=PACT_BROKER_BASE_URL]
+        # Base URL of the Pact Broker from which to retrieve the pacts.
+  -n, [--broker-username=BROKER_USERNAME]
+        # Pact Broker basic auth username
+  -p, [--broker-password=BROKER_PASSWORD]
+        # Pact Broker basic auth password
+      [--provider=PROVIDER]
+      [--consumer-version-tag=TAG]
+        # Retrieve the latest pacts with this consumer version tag.
+        Used in conjuction with --provider. May be specified multiple times.
+  -a, [--provider-app-version=PROVIDER_APP_VERSION]
+        # Provider application version, required when publishing verification results
+  -r, [--publish-verification-results=PUBLISH_VERIFICATION_RESULTS]
+        # Publish verification results to the broker
+      [--custom-provider-header=CUSTOM_PROVIDER_HEADER]
+        # Header to add to provider state set up and pact verification requests.
+        eg 'Authorization: Basic cGFjdDpwYWN0'. May be specified multiple times.
+  -v, [--verbose=VERBOSE]
+        # Verbose output
+  -f, [--format=FORMATTER]
+        # RSpec formatter. Defaults to custom Pact formatter. Other options are
+        json and RspecJunitFormatter (which outputs xml).
+  -o, [--out=FILE]
+        # Write output to a file instead of $stdout.
 
 Verify pact(s) against a provider. Supports local and networked (http-based) files.
 ```

diff --git a/lib/pact/provider_verifier/cli/verify.rb b/lib/pact/provider_verifier/cli/verify.rb
@@ -17,7 +17,7 @@ class InvalidArgumentsError < ::Thor::Error; end
         method_option :broker_username, aliases: "-n", desc: "Pact Broker basic auth username", :required => false
         method_option :broker_password, aliases: "-p", desc: "Pact Broker basic auth password", :required => false
         method_option :provider, required: false
-        method_option :consumer_version_tag, type: :array, desc: "Retrieve the latest pacts with this consumer version tag. Used in conjuction with --provider.", :required => false
+        method_option :consumer_version_tag, type: :array, banner: "TAG", desc: "Retrieve the latest pacts with this consumer version tag. Used in conjuction with --provider. May be specified multiple times.", :required => false
         method_option :provider_app_version, aliases: "-a", desc: "Provider application version, required when publishing verification results", :required => false
         method_option :publish_verification_results, aliases: "-r", desc: "Publish verification results to the broker", required: false
         method_option :custom_provider_header, type: :array, banner: 'CUSTOM_PROVIDER_HEADER', desc: "Header to add to provider state set up and pact verification requests. eg 'Authorization: Basic cGFjdDpwYWN0'. May be specified multiple times.", :required => false