Add ability to generate type declaration files as part of build #58
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.
Summary
This PR modifies the build script to include generating ambient type declaration files. The files are generated in the "legacy API"
lib/
folder so that the existing paths used to reference the CommonJS modules will continue to work with the Typescript compiler. For example, the Typescript compiler will not complain about the following:Changes
build-typedefs
npm script. This writes.d.ts
files to thelib/
directory.build
npm script to to runbuild-typedefs
..gitignore
so that the type declaration files (lib/*.d.ts
) are ignored.Example
Result:
How to try it out
I published a version with these changes to make it easier to test: