Add testing example to README

[theSteveMitchell]

#50 was helpful for me to understand an unexpected issue with testing. Hopefully it'll be helpful to others who have similar issues.

In my case, we are using axois-mock-adapter for mocking api requests. I think this is an extremely common package and pattern. We upgraded apisauce from 1.21.2 to 1.21.4, and all of the mocks stopped working.

@skellock's comment helped us to identify the issue, and when we looked through the code we found that 1.21.3 clones the axios instance which was not happening in 1.21.2. I wasn't able to find anything in release notes about that, and we didn't expect this to change in a minor/patch release

[jamonholmgren]

Looks good to me!

[kevinvangelder]

This is good, but I'm thinking it might be a little better to combine the two code blocks into one example and using a diff to show the incorrect versus correct implementation. You can use a codeblock marked diff like so:

import apisauce from 'apisauce'
import MockAdapter from 'axios-mock-adapter'
test('mock adapter', async () => {
  const api = apisauce.create("https://api.github.com")
-  const mock = new MockAdapter(axios)
+  const mock = new MockAdapter(api.axiosInstance)
  mock.onGet("/repos/skellock/apisauce/commits").reply(200, {
    commits: [{ id: 1, sha: "aef849923444" }],
  });
  const response = await api..get('/repos/skellock/apisauce/commits')
  expect(response.data[0].sha).toEqual"aef849923444")
})

Overall I think it would read clearer and has the benefit of clearly indicating the incorrect implementation in red and the correct one in green.

[jamonholmgren]

Good idea, @kevinvangelder

[theSteveMitchell]

Yea, good suggestion @kevinvangelder. I've pushed that update. I wish we could do syntax highlighting with diff, but it is easier to follow with the diff 👍

[jamonholmgren]

Thanks for the contribution @theSteveMitchell !! Really appreciate it!

[infinitered-circleci]

🎉 This PR is included in version 3.0.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀