kiva / protocol-common

Shared code across the various protocol microservices
Apache License 2.0
10 stars 3 forks source link

Update to 1.x.x Documentation #79

Closed ghost closed 2 years ago

ghost commented 2 years ago

Summary of Changes

Signed-off-by: Jeff Kennedy jeffk@kiva.org

ghost commented 2 years ago

Is it worth adding a section about Jest support?

Yeah, I was thinking about this. I feel like Jest ESM support is confusing and it's own whole thing. It seems to be a little different for each project too. For example, I don't think I can just say to have set the extensionsToTreatAsEsm key to [".ts"] because that caused additional errors in aries-controller, but fixed other errors in aries-guardianship-agency. But I'm down to expand this in whatever way seems most helpful.

natesulat commented 2 years ago

It's more art than science, for sure, and it's at least partly dependent (heh) on the application dependencies, anyways.

Still, there are a few patterns that I've seen emerge which might be useful to add, even if they're not 100% effective. On the other hand, yes, it's a whole other thing, so it might be out of scope for changes to this package.