Skip to content

README: update @testing-library/jest-dom's old syntax #590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 25, 2020
Merged

README: update @testing-library/jest-dom's old syntax #590

merged 2 commits into from
Feb 25, 2020

Conversation

ryota-murakami
Copy link
Contributor

What:
Update @testing-library/jest-dom import statement to latest syntax in the README example.

Why:
@testing-library/jest-dom v5.0.0 later, import statement had BreakingChange.

How:
Edit README.md

import '@testing-library/jest-dom/extend-expect' to import '@testing-library/jest-dom'

Checklist:

  • Documentation added to the
    docs site N/A
  • Tests N/A
  • Typescript definitions updated N/A
  • Ready to be merged

Thank you for you made useful library & maintaining actively! 😀

[@testing-library/jest-dom v5.0.0](https://github.com/testing-library/jest-dom/releases/tag/v5.0.0) later, import statement had BreakingChange.
So update to latest that in the README example.

Thank you 😀
@codesandbox-ci
Copy link

codesandbox-ci bot commented Feb 18, 2020

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit a5940dd:

Sandbox Source
blazing-fast-lkgm3 Configuration
loving-kowalevski-d6tqj Configuration

@codecov
Copy link

codecov bot commented Feb 18, 2020

Codecov Report

Merging #590 into master will not change coverage.
The diff coverage is 100%.

Impacted file tree graph

@@          Coverage Diff          @@
##           master   #590   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files           3      3           
  Lines          95    103    +8     
  Branches       15     15           
=====================================
+ Hits           95    103    +8
Impacted Files Coverage Δ
src/pure.js 100% <100%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f6ca145...a5940dd. Read the comment docs.

@eps1lon
Copy link
Member

eps1lon commented Feb 18, 2020

@gnapse Could you review? I don't see this breaking change mentioned in the breaking changes.

@eps1lon eps1lon requested a review from gnapse February 18, 2020 14:34
Copy link
Member

@gnapse gnapse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be clear, in the update to v5 there are breaking changes, but this is not a part of it. You can continue importing from @testing-library/jest-dom/extend-expect even though we started providing the import from the main entry module @testing-library/jest-dom.

However, this change proposal seems good anyway, given that this is the new recommended way to import now.

@eps1lon eps1lon merged commit c8a8694 into testing-library:master Feb 25, 2020
@eps1lon
Copy link
Member

eps1lon commented Feb 25, 2020

@all-contributors please add @ryota-murakami for docs

@allcontributors
Copy link
Contributor

@eps1lon

I've put up a pull request to add @ryota-murakami! 🎉

@eps1lon
Copy link
Member

eps1lon commented Feb 25, 2020

@ryota-murakami Much appreciated, thanks!

@ryota-murakami ryota-murakami deleted the patch-1 branch February 25, 2020 11:04
@kentcdodds
Copy link
Member

🎉 This PR is included in version 9.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants