fix(verifier): allow to use progress formatter during verification (#189

)

* fix(verifier): Allow to use progress formatter during verification
* chore(verifier): Re-enable RspecJunitFormatter as an option for formatter
* docs(verifier): Document format option

README.md

@@ -266,6 +266,7 @@ pact.verifyPacts({
 | `customProviderHeaders`     | false     | array   | Header(s) to add to provider state set up and pact verification                                            |  | `requests`. eg 'Authorization: Basic cGFjdDpwYWN0'. |
 | `providerVersion`           | false     | string  | Provider version, required to publish verification result to Broker. Optional otherwise.                   |
 | `timeout`                   | false     | number  | The duration in ms we should wait to confirm verification process was successful. Defaults to 30000.       |
+| `format`                    | false     | string  | What format the verification results are printed in. Options are `json`, `xml`, `progress` and `RspecJunitFormatter` (which is a synonym for `xml`) |
 
 ### Pact Broker Publishing
 

src/verifier.spec.ts

@@ -181,6 +181,13 @@ describe('Verifier Spec', () => {
           format: 'json',
         } as any),
       ).to.not.throw(Error);
+      expect(() =>
+        verifierFactory({
+          providerBaseUrl: 'http://localhost',
+          pactUrls: ['http://idontexist'],
+          format: 'progress',
+        } as any),
+      ).to.not.throw(Error);
     });
 
     it('should throw an error with anything but a string', () => {

src/verifier.ts

@@ -141,9 +141,10 @@ export class Verifier {
 
     if (options.format) {
       checkTypes.assert.string(options.format);
-      checkTypes.assert.match(options.format, /^(xml|json)$/i);
-      options.format =
-        options.format.toLowerCase() === 'xml' ? 'RspecJunitFormatter' : 'json';
+      checkTypes.assert.match(options.format, /^(xml|json|progress)$/i);
+      if (options.format.toLowerCase() === 'xml') {
+        options.format = 'RspecJunitFormatter';
+      }
     }
 
     if (options.out) {
@@ -216,6 +217,6 @@ export interface VerifierOptions {
   timeout?: number;
   tags?: string[];
   monkeypatch?: string;
-  format?: 'json' | 'RspecJunitFormatter';
+  format?: 'json' | 'xml' | 'progress' | 'RspecJunitFormatter';
   out?: string;
 }