Preserve comments to enable deprecation warnings #59
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
…ill flow through
davemurphysf
requested review from
bretthoerner,
tiina303,
xvello and
tomasfarias
bretthoerner
approved these changes
Nov 30, 2023
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.
Problem: right now, types/interfaces are being marked as deprecated, but then when the .d.ts files are generated, the comments are removed. By preserving the comments, we surface the deprecation warnings when this library is used.
Since this package is intended to be used as a library for plugins, presumably the plugin importing this package will strip the comments via minification. Also, this should only be server-side code, so package size is not a concern.