Improve hydration error message when unexpected `TemplateResult` was rendered to part

popeindustries / lit

Fast server-rendering and client-hydration of lit-html templates and web components

MIT License

33 stars 4 forks source link

Fixes https://github.com/popeindustries/lit/issues/35

Maybe this is a very bad and naive suggestion on how this should be implemented, but I wondered if what is suggested in this PR is good enough 🤓

We are anyhow in need in our app to be able to better locate which (child) node that resulted in the hydration error.

What this PR includes

[x] Adding a function consoleUnexpectedTemplateResultError(...) that prints the html element that caused hydration to fail, when it was due to an unexpected template result rendered to part.
[x] A patch release of package lit-html

PR changes explained

I debugged where the error was thrown and where the error was caught. It was not an obvious variable in either places that contained the information about which HTML element that caused it. The current implementation was the best place I could find it 🤓 Maybe it is a bad suggestion.

Before & After

Should not change functionality, since it is just a console.error(...) message that is changes.

popeindustries / lit