Fix generated TypeScript type definitions #32
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
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.
Currently during build, to generate TypeScript type definitions, the packager directly calls the TypeScript compiler using the JavaScript source files as root files. The generated type definitions are then manually stripped of excess irrelevant declarations, and merged with a minimally preauthored type definition file. Whilst this process removes inaccessible types, it is still prone to errors, and does not properly translate JSDoc type annotations into actual type declarations.
This change modifies the build process so that type definitions are generated using the ostensibly-typed package, added as a devDependency, which produces a clean type definition file incorporating type definitions for JSDoc type annotations. Additionally, it automatically detects JavaScript classes that extend types/interfaces that TypeScript considers to not be "constructable", and adds an extra interface declaration extending the type/interface instead (fixes #24).