docs: clarify need to await `expect.toMatchFileSnapshot` about vitest HOT 5 OPEN

We record the promise, so it's not required.

from vitest.

In that case the docs could be updated since they say "you need to use await": https://vitest.dev/api/expect.html#tomatchfilesnapshot

And if it's not required then perhaps it could just be synchronous to avoid the confusion?

from vitest.

It does return a Promise, so I don't know what else to tell you. It cannot be sync because to read a file in the browser we need to make an async request. In node.js it could technically be sync, but then the API would differ which is undesirable.

from vitest.

We could probably just clarify the docs about the difference between awaiting and not awaiting it

from vitest.

If it's not awaited, then the next line will be executed even if the snapshot fail which might not be expected behaviour but it at least correctly fails the test.

from vitest.