Allow hyphenated JSDoc tags #2972
Merged
Conversation
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
jonathanhefner
force-pushed
the
allow-hyphenated-jsdoc-tags
branch
2 times, most recently
from
a080fdf to
8140e00
Compare
|
TypeDoc doesn't support hyphenated tags because TSDoc disallows it:
And no official JSDoc tag uses it - https://jsdoc.app/ In theory, I don't think I have an issue with adding hyphen to the permitted characters list -- this isn't enough though, the lexers in src/lib/converter/comments will also need to be updated. |
JSDoc tags may contain hyphens. For example, `@TJS-type`, which is used by [`typescript-json-schema`](https://www.npmjs.com/package/typescript-json-schema).
jonathanhefner
force-pushed
the
allow-hyphenated-jsdoc-tags
branch
from
8140e00 to
9121d78
Compare
Thanks for the pointer! I've updated the lexers. |
|
Thanks! |
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.
JSDoc tags may contain hyphens. For example,
@TJS-type, which is used bytypescript-json-schema.There are no existing tests for this function, but I can add a test for this change, if desired. (This test is close, but it is testing other functionality, notisTagStringitself.)I stand corrected. This test was recently added, explicitly disallowing hyphenated tags. I'm unclear as to why though. Is there a reason to reject hyphenated tags?