feat: new jsdoc comments formatter #797
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
|
@drwpow sorry for pushing, but we need to merge this pr, or we'll only have to use the fork version of your package ( |
drwpow
approved these changes
Dec 14, 2021
|
I won’t push a new release today, as I want to do a little local testing. But this will go out in a minor release this week |
|
No problem, thanks for reaction and merging, hope work with this package in future as well! |
|
@all-contributors please add @sadfsdfdsa for code |
|
I've put up a pull request to add @sadfsdfdsa! 🎉 |
|
Released in |
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.
Feat more powerful comments formatter with jsdoc tags supports.
TYPE: FEATURE
AFFECTS: ONLY COMMENTS
Now supports:
titleas simple description comment (as description in actual version)formatfrom yaml with prefix (example:Format: date-time), think it's better to have it)@deprecatedas in previous version@description somethingas JSDOC tag (actual version: without tag, but now title use that format and description switched to tag)@default somethingas JSDOC tag@example somethingas JSDOC tagGenerated example with full possibilities of new version:
Also added json (ping me if need to go to yaml) with all new jsdoc config example.
Of course, I broke tests that are designed for the old description format, thinks it's better to change expects with new generated. Snapshots different only in comments body.