Add guidance on testing to the Getting Started docs
#2916
Conversation
|
size-limit report 📦
|
broccolinisoup
temporarily deployed
to
github-pages
GitHub Actions
Inactive
docs/content/getting-started.md
Outdated
|
|
||
| ## Testing | ||
|
|
||
| Testing your application with Primer React is no different than testing your application with any other React library. Depending on your test environment and the testing libraries you use, you may need polyfills. For example if you are using `jest`, it runs via Node runtime and using [JSDOM](https://github.com/jsdom/jsdom) as a DOM implementation, so you will need to mock some browser APIs. We have [helpers](https://github.com/primer/react/blob/main/src/utils/test-helpers.tsx) that you can utilize to mock some of these APIs. |
There was a problem hiding this comment.
Would it be helpful to also add a note/code snippet on how to include this file of test helpers in Jest or would that be better placed somewhere else in the project?
There was a problem hiding this comment.
I think it is a great point but I don't think we export the file? I imagined they could copy the mocks they needed from the test-helpers but it would be ideal to import the file. Maybe I am missing something here though.
There was a problem hiding this comment.
I feel like copying and pasting those mocks is a reasonable approach if we want to avoid increasing the API surface area of Primer React.
There was a problem hiding this comment.
One vote for exporting test-helpers, I think copy pasting is a secret trick that we tell people after they ask us why it broke 😅
Update from @joshblack, We already export them, we just didn't document it till now :)
There was a problem hiding this comment.
Oh sorry yes I just realised we export the file!
Would below be accurate to document?
import "@primer/react/lib-esm/utils/test-helpers"; (For ESM)
import "@primer/react/lib/utils/test-helpers"; (For CommonJS)
There was a problem hiding this comment.
I think so! 👍 Example of usage over in memex: https://gh.io/AAjpnug
There was a problem hiding this comment.
Thank you! Just pushed a commit
broccolinisoup
temporarily deployed
to
github-pages
GitHub Actions
Inactive
broccolinisoup
temporarily deployed
to
github-pages
GitHub Actions
Inactive
Closes https://github.com/github/primer/issues/1823
Closes #2836
Screenshots
No visual changes
Merge checklist
Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.