This repository has been archived by the owner on Oct 11, 2023. It is now read-only.
Take a different approach to exporting modules #199
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
This is the first PR of some to follow to shift our approach to how we export modules with the aim to improve the developer ergonomics contributing to this project. In a nutshell, we are moving from imports like:
To
Why?
Until now, we exported all the public modules through an
index.ts
module. While that works, it makes mocking inconvenient because a mocking of@gestaltjs/core
through Vitest mocks all the modules that are exported through it.How?
@gestaltjs/core
to output the files suffixed as.public.ts
undersrc/node
exports
section of core'spackage.json
.Testing?
A passing CI should make us feel confidence this change hasn't broken anything. Alternatively, you can run
pnpm run build
in thecore
directory.Anything Else? (optional)
Once this PR is merged, I'll continue with the other modules. I'll take the opportunity to revisit the APIs and document modules that lack documentation.