fix: export types from build instead of src #21
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.
@sberthier
Proposed change
Changed the way types are exported:
index.d.ts
now points tobuild
directory instead ofsrc
in order to resolve to other.d.ts
files in sub-directories instead of resolving to source.ts
files.Reason for change
I encountered a situation where a TS error in the source code of
f-promise-async
caused an error to be thrown at compile time whenf-promise-async
was included as a dependency.According to microsoft/TypeScript#41883 (comment), inbound references should resolve to
.d.ts
files and not source.ts
files.The tsconfig
skipLibCheck
option can only affect the checking of.d.ts
files. There are no options to avoid checking.ts
files. Therefore, it is recommended to export types via.d.ts
files, so that projects depending on this package can useskipLibCheck
to choose if they want to perform the check, rather than being forced to do it.