feat: render an "Added in" pill for the @added_in tag#77
Merged
Conversation
Recognize the custom @added_in block tag in TypeDoc by appending it to the default block tags, and render its value as a pill at the top of a member's comment instead of a raw tag row.
This file contains hidden or 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
2 participants
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.
Adds support for a custom
@added_in <version>JSDoc block tag and renders it as a pill (Added in: x.y.z) at the top of a member's comment.@added_inis appended to TypeDoc's defaultblockTagsso it's recognized without a warning and without dropping the built-in tags.Commentextracts the tag, renders it using the existing Infimabadgeclasses, and excludes it from the raw block-tag list so it isn't shown twice. Pill-only comments still render correctly.The tag itself is populated in source by a separate annotation script (per-repo), so this only needs the plugin to recognize and display it.