chore: migrate pretty-format to ESM

[SimenB]

Summary

Changed export from a "default" (CJS) export to a named function called format.

We can remove the patch when making a new release (as at that point the version range won't match @testing-library/dom and it'll pull in a compatible version)

Test plan

Green CI

[thymikee]

Why not have format as both named and default ESM export? This way we would break the world, at least for those that don't use require("pretty-format") directly.

[SimenB]

can do a default export, sure. Just as breaking for CJS peeps, but no biggie.

Do you want both named and default, or just default?

[SimenB]

Note that today people do

import prettyFormat from 'pretty-format';

const plugins = prettyFormat.plugins;

That I wanna break regardless. It's so weird that doing this uncovered a bug in tsc 😛 (microsoft/TypeScript#29206)

[thymikee]

I'd go with both default and named.

today people do
import prettyFormat from 'pretty-format';
const plugins = prettyFormat.plugins;

I don't mind breaking this use case, it's wrong usage of ESM and should be fixed anyway.

[SimenB]

Cool! 👍 I'll make the change before landing. No timeline on 27, so I'll just leave this as is for now (unless I get bored (again))

[SimenB]

I'm purposefully not using default import here, since real ESM only works with named exports (in node impl) as it's still CJS under the hood

[thymikee]

I'd go with just format in examples, without aliasing to prettyFormat. No need for extra mental overhead here

[SimenB]

it's the difference between "copy the example and run it" vs "copy example, but get weird errors". I think it's worth it to keep as is?

[SimenB]

@thymikee thoughts on it now?

[thymikee]

can we use import type here?

[SimenB]

we import plugins below, so no

[thymikee]

👍

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.