feat(logDOM): add logDOM export #336
Conversation
|
Actually, it looks like |
Codecov Report
@@ Coverage Diff @@
## master #336 +/- ##
=====================================
Coverage 100% 100%
=====================================
Files 21 21
Lines 311 315 +4
Branches 66 66
=====================================
+ Hits 311 315 +4
Continue to review full report at Codecov.
|
kentcdodds
force-pushed
the
pr/refactor-pretty-dom
branch
from
43b3cc1 to
4597576
Compare
| if (htmlElement.documentElement) { | ||
| htmlElement = htmlElement.documentElement | ||
| function prettyDOM( | ||
| dom = getDocument().body, |
There was a problem hiding this comment.
If someone's not running in an environment where the document is globally available, then they have to provide a DOM node to log, otherwise we'll just default to document.body which I think is a good default. I imagine lots of people will just call logDOM() and that'll be helpful to them!
kentcdodds
force-pushed
the
pr/refactor-pretty-dom
branch
2 times, most recently
from
ba3ef0f to
56a5a16
Compare
|
Dang it. I just realized that we did export So here's what I'm thinking. Let's call this a breaking change (because it technically is) and we'll release this one with the RTL change here: testing-library/react-testing-library#430 Thoughts? |
kentcdodds
force-pushed
the
pr/refactor-pretty-dom
branch
from
56a5a16 to
430d449
Compare
| @@ -20,7 +20,7 @@ export type AllByAttribute = ( | |||
|
|
|||
| export const queryByAttribute: QueryByAttribute | |||
| export const queryAllByAttribute: AllByAttribute | |||
| export const debugDOM: (htmlElement: HTMLElement) => string | |||
| export const logDOM: (htmlElement: HTMLElement) => void | |||
There was a problem hiding this comment.
This is the breaking change.
Impact is minimal because people probably aren't relying on this for their actual tests and it's more of a workflow method (which I doubt many people use).
That said, some libraries built on top of DTL may use this method, and the upgrade strategy for them is to switch from debugDOM to prettyDOM.
kentcdodds
changed the title
kentcdodds
force-pushed
the
pr/refactor-pretty-dom
branch
from
430d449 to
27c9ddd
Compare
kentcdodds
force-pushed
the
pr/refactor-pretty-dom
branch
from
27c9ddd to
1d2d56b
Compare
There was an issue with a major release, so this manual-releases.md change is to release a new major version. Reference: #336 BREAKING CHANGE: If you were using `debugDOM` before, use `prettyDOM` instead.
|
🎉 This PR is included in version 6.0.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
What: add
logDOMexportWhy: I was working on #314, but I misunderstood it and changed gears. But I liked the refactor I was working on it.
How: Moved some logic around and now pretty-dom is responsible for determining default values for limit and options. I think it's a bit cleaner this way.
This is a breaking change because it basically moves
debugDOMlogic toprettyDOM.debugDOMwas pretty useless after this change, so it's been removed.It also adds an export for a new
logDOMwhich does what it says.Checklist:
docs site N/A