Assert access on a Firestore document path about firestore-jest-mock HOT 7 OPEN

@sbatson5 Document and Collection path fixes are on #102.

from firestore-jest-mock.

I'm working on a branch that will make the path property of firestore-jest-mock's document and collection references match more closely Firestore's analagous path properties. Ours are close (except in the case of collectionGroup queries), but not quite ready to assert document paths correctly. It may be prudent to wait on exporting this function until our paths are more consistent, so as to avoid breaking things in the future.

from firestore-jest-mock.

I'm working on a branch ...

Update on that branch. It's very nearly ready. For the sake of my own dependent projects, I'm waiting on firestore-jest-mock's TypeScript definitions before I get that work merged in.

from firestore-jest-mock.

We've been using this matcher in our own production code for some time, and have found it extremely handy. I don't know how to export Jest matchers from a package, but it must be possible with minimal work on users' end, considering jest-extended is a thing.

from firestore-jest-mock.

Sorry it's taken me so long to read through this but I like the concept a lot. And it doesn't make our API more complicated.

I'm not finding an easy way for us to have this automatically added to jest, but it looks like we can follow what they do on this library:
https://github.com/tanem/jest-prettyhtml-matchers#basic-usage

The end-user can just call expect.extend(toHaveFirestorePath) if they want to use the helper. That doesn't feel like a big ask, given the value it adds. So we would just export this as a helper from our package. What do you think?

from firestore-jest-mock.

Absolutely! It would be simple to write up a function to export. Perhaps we would even export a function that would build toHaveFirestorePath and whatever matchers we want to add in the future. expect.extend takes an object of functions keyed by the name that Jest should expose on the expect helper, so having some function that returns { toHaveFirestorePath } would be perfect.

from firestore-jest-mock.

Looking at that today!

from firestore-jest-mock.