fix: export types for chai extensions #789
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
If a chai extension has types it cannot be resolved unless those types are in a definitely typed style `@types/chai-something` module. This seems to be because we don't export them from the `utils/chai.js` file so they get removed during compilation, then when we try to use the extensions their types have not been loaded so chai's base types are not extended and we have missing methods everywhere. Here we export the chai extensions, ensuring their types will be loaded then delete the exported property as we don't really want to export the extensions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If a chai extension has types they cannot be resolved by modules that depend
on aegir unless those types are in a definitely-typed-style
@types/chai-foomodule.
This seems to be because we don't export them from the
utils/chai.jsfile so they are not referenced from anywhere, then when we try to use
chai with the extensions from another module their types have not been
loaded so chai's base types are not extended and we have missing methods
everywhere. Unless of course, they are in a
@types/...module in which casetypescript's default module resolution algorithm will find them, though more
by accident than by design.
Here we export the chai extensions, ensuring their types will be loaded
by the generated
.d.tsfile, then delete the exported property as we don'treally want to export the extensions.