feat: Improved adapter and persister registration

README.md

@@ -38,10 +38,18 @@ Check out the [Quick Start](https://netflix.github.io/pollyjs/#/quick-start) doc
 
 ## Usage
 
-Let's take a look at what an example test case would look like using Polly.
+Lets take a look at what an example test case would look like using Polly.
 
 ```js
-import { Polly } from '@pollyjs/core';
+import { Polly, FetchAdapter, XHRAdapter, RESTPersister } from '@pollyjs/core';
+
+/*
+  Register the adapters and persisters we want to use. This way all future
+  polly instances can access them by name.
+*/
+Polly.register(XHRAdapter)
+Polly.register(FetchAdapter)
+Polly.register(RESTPersister)
 
 describe('Netflix Homepage', function() {
   it('should be able to sign in', async function() {
@@ -52,7 +60,10 @@ describe('Netflix Homepage', function() {
       will record any requests that it hasn't yet seen while replaying ones it
       has already recorded.
     */
-    const polly = new Polly('Sign In');
+    const polly = new Polly('Sign In', {
+      adapters: ['xhr', 'fetch'],
+      persister: 'rest'
+    });
     const { server } = polly;
 
     /* Intercept all Google Analytic requests and respond with a 200 */

docs/adapters/custom.md

@@ -67,33 +67,13 @@ adapter class.
 ```js
 // Register and connect to a custom adapter:
 new Polly('Custom Adapter', {
-  adapters: [
-    ['my-custom-adapter', MyCustomAdapterClass]
-  ]
-});
-
-// Register and connect to the default adapters + a custom adapter:
-new Polly('Defaults + Custom Adapter', {
-  adapters: [
-    'fetch',
-    'xhr',
-    ['my-custom-adapter', MyCustomAdapterClass]
-  ]
-});
-
-// Register and connect to a custom fetch adapter:
-new Polly('Custom Fetch Adapter', {
-  adapters: [
-    ['fetch', MyCustomFetchAdapterClass]
-  ]
+  adapters: [MyCustomAdapterClass]
 });
 
 // Register and connect to a custom adapter via .configure():
 const polly = new Polly('Custom Adapter');
 
 polly.configure({
-  adapters: [
-    ['my-custom-adapter', MyCustomAdapterClass]
-  ]
+  adapters: [MyCustomAdapterClass]
 });
 ```

docs/adapters/fetch.md

@@ -11,6 +11,11 @@ The fetch adapter is connected to by default but you can use the
 adapter.
 
 ```js
+import { Polly, FetchAdapter } from '@pollyjs/core';
+
+// Register the fetch adapter so its accessible by all future polly instances
+Polly.register(FetchAdapter);
+
 const polly = new Polly('<Recording Name>', {
   adapters: ['fetch']
 });

docs/adapters/xhr.md

@@ -12,6 +12,11 @@ The XHR adapter is connected to by default but you can use the
 adapter.
 
 ```js
+import { Polly, XHRAdapter } from '@pollyjs/core';
+
+// Register the xhr adapter so its accessible by all future polly instances
+Polly.register(XHRAdapter);
+
 const polly = new Polly('<Recording Name>', {
   adapters: ['xhr']
 });

docs/api.md

@@ -218,12 +218,13 @@ Connect to an adapter.
 
 | Param | Type | Description |
 |  ---  | ---  |     ---     |
-| name | `String` | The name of the adapter to connect to |
+| name | `String|Function` | The adapter name of class to connect to |
 
 __Example__
 
 ```js
 polly.connectTo('xhr');
+polly.connectTo(XHRAdapter);
 ```
 
 ### disconnectFrom
@@ -232,12 +233,13 @@ Disconnect from an adapter.
 
 | Param | Type | Description |
 |  ---  | ---  |     ---     |
-| name | `String` | The name of the adapter to disconnect from |
+| name | `String|Function` | The adapter name of class to disconnect from |
 
 __Example__
 
 ```js
 polly.disconnectFrom('xhr');
+polly.disconnectFrom(XHRAdapter);
 ```
 
 ### disconnect

docs/configuration.md

@@ -128,16 +128,21 @@ polly.configure({
 
 ## adapters
 
-_Type_: `Array`
-_Default_: `['fetch', 'xhr']`
+_Type_: `Array[String|Function]`
+_Default_: `[]`
 
 The adapter(s) polly will hook into.
 
 __Example__
 
 ```js
+import { XHRAdapter, FetchAdapter } from '@pollyjs/core';
+
+// Register the xhr adapter so its accessible by all future polly instances
+Polly.register(XHRAdapter);
+
 polly.configure({
-  adapters: ['xhr']
+  adapters: ['xhr', FetchAdapter]
 });
 ```
 
@@ -165,17 +170,26 @@ polly.configure({
 
 ## persister
 
-_Type_: `String`
-_Default_: `'rest'`
+_Type_: `String|Function`
+_Default_: `null`
 
 The persister to use for recording and replaying requests.
 
 __Example__
 
 ```js
+import { LocalStoragePersister, RESTPersister } from '@pollyjs/core';
+
+// Register the local-storage persister so its accessible by all future polly instances
+Polly.register(LocalStoragePersister);
+
 polly.configure({
   persister: 'local-storage'
 });
+
+polly.configure({
+  persister: RESTPersister
+});
 ```
 
 ## persisterOptions

docs/persisters/custom.md

@@ -29,6 +29,10 @@ yarn add @pollyjs/persister -D
 import Persister from '@pollyjs/persister';
 
 class CustomPersister extends Persister {
+  static get name() {
+    return 'custom';
+  }
+
   findRecording() {}
 
   saveRecording() {}
@@ -61,13 +65,13 @@ persister class.
 ```js
 // Register and connect to a custom persister:
 new Polly('Custom Persister', {
-  persister: ['my-custom-persister', MyCustomPersisterClass]
+  persister: MyCustomPersisterClass
 });
 
 // Register and connect to a custom persister via .configure():
 const polly = new Polly('Custom Persister');
 
 polly.configure({
-  persister: ['my-custom-persister', MyCustomPersisterClass]
+  persister: MyCustomPersisterClass
 });
 ```

docs/persisters/fs.md

@@ -22,8 +22,11 @@ yarn add @pollyjs/persister-fs -D
 import { Polly } from '@pollyjs/core';
 import FSPersister from '@pollyjs/persister-fs';
 
+// Register the fs persister so its accessible by all future polly instances
+Polly.register(FSPersister);
+
 new Polly('<Recording Name>', {
-  persister: ['fs', FSPersister]
+  persister: 'fs'
 });
 ```
 

docs/persisters/local-storage.md

@@ -5,7 +5,12 @@ Read and write recordings to and from the browser's Local Storage.
 ## Usage
 
 ```js
-const polly = new Polly('<Recording Name>', {
+import { Polly, LocalStoragePersister } from '@pollyjs/core';
+
+// Register the local-storage persister so its accessible by all future polly instances
+Polly.register(LocalStoragePersister);
+
+new Polly('<Recording Name>', {
   persister: 'local-storage'
 });
 ```

docs/persisters/rest.md

@@ -11,14 +11,13 @@ as well as a [CLI](cli/overview) to get you up and running.
 ## Usage
 
 ```js
+import { Polly, RESTPersister } from '@pollyjs/core';
+
+// Register the REST persister so its accessible by all future polly instances
+Polly.register(RESTPersister);
+
 new Polly('<Recording Name>', {
-  persister: 'rest',
-  persisterOptions: {
-    rest: {
-      host: '',
-      apiNamespace: '/polly'
-    }
-  }
+  persister: 'rest'
 });
 ```
 

docs/quick-start.md

@@ -50,7 +50,15 @@ Now that you've installed Polly and have setup your server, you're ready to
 fly. Lets take a look at what an example test case would look like using Polly.
 
 ```js
-import { Polly } from '@pollyjs/core';
+import { Polly, FetchAdapter, XHRAdapter, RESTPersister } from '@pollyjs/core';
+
+/*
+  Register the adapters and persisters we want to use. This way all future
+  polly instances can access them by name.
+*/
+Polly.register(XHRAdapter)
+Polly.register(FetchAdapter)
+Polly.register(RESTPersister)
 
 describe('Netflix Homepage', function() {
   it('should be able to sign in', async function() {
@@ -61,7 +69,19 @@ describe('Netflix Homepage', function() {
       will record any requests that it hasn't yet seen while replaying ones it
       has already recorded.
     */
-    const polly = new Polly('Sign In');
+    const polly = new Polly('Sign In', {
+      adapters: ['xhr', 'fetch'],
+      persister: 'rest'
+    });
+    const { server } = polly;
+
+    /* Intercept all Google Analytic requests and respond with a 200 */
+    server
+      .get('/google-analytics/*path')
+      .intercept((req, res) => res.sendStatus(200));
+
+    /* Pass-through all GET requests to /coverage */
+    server.get('/coverage').passthrough();
 
     /* start: pseudo test code */
     await visit('/login');
@@ -169,7 +189,10 @@ import { Polly } from '@pollyjs/core';
 
 describe('Netflix Homepage', function() {
   it('should handle a failed sign in attempt', async function() {
-    const polly = new Polly('Failed Sign In');
+    const polly = new Polly('Failed Sign In', {
+      adapters: ['xhr', 'fetch'],
+      persister: 'rest'
+    });
     const { server } = polly;
 
     /*

packages/@pollyjs/core/README.md

@@ -54,7 +54,15 @@ Check out the [Quick Start](https://netflix.github.io/pollyjs/#/quick-start) doc
 Lets take a look at what an example test case would look like using Polly.
 
 ```js
-import { Polly } from '@pollyjs/core';
+import { Polly, FetchAdapter, XHRAdapter, RESTPersister } from '@pollyjs/core';
+
+/*
+  Register the adapters and persisters we want to use. This way all future
+  polly instances can access them by name.
+*/
+Polly.register(XHRAdapter)
+Polly.register(FetchAdapter)
+Polly.register(RESTPersister)
 
 describe('Netflix Homepage', function() {
   it('should be able to sign in', async function() {
@@ -65,7 +73,10 @@ describe('Netflix Homepage', function() {
       will record any requests that it hasn't yet seen while replaying ones it
       has already recorded.
     */
-    const polly = new Polly('Sign In');
+    const polly = new Polly('Sign In', {
+      adapters: ['xhr', 'fetch'],
+      persister: 'rest'
+    });
     const { server } = polly;
 
     /* Intercept all Google Analytic requests and respond with a 200 */