-
Notifications
You must be signed in to change notification settings - Fork 101
[Feature] Add jsdoc-format converter #238
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Feature] Add jsdoc-format converter #238
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Going off the TSLint rule description, the following are the TSLint rule behaviors we'll want to map over:
- each line contains an asterisk and asterisks must be aligned
- each asterisk must be followed by either a space or a newline (except for the first and the last)
- the only characters before the asterisk on each line must be whitespace characters
- one line comments must start with /** and end with */
- multiline comments don’t allow text after /** in the first line (with option "check-multiline-start")
If finding the right mappings over is still giving you pain in a week I can try to help out. A little swamped right now 😢 and I don't think this is a super high priority rule to map over.
Don't worry mate 👍 I will wait for it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mmhh, this might end up being straightforward in implementation.
@JoshuaKGoldberg Can you review this again? I think everything should be okay now :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great! I'm a bit relieved it ended up being not a ton of conditional logic 😅 thanks for persisting @KingDarBoja!
Just one suggested change, and it'll be good to go!
👋 ping @KingDarBoja, are you still interested in working on this? I can take it the rest of the way if you don't have time! |
@JoshuaKGoldberg I made the changes months ago, just waiting for your review. |
Oh apologies! I did not realize 😦. Are all your PRs similarly waiting for me? If I'm ever slow to review (>1-2 weeks), please do ping me - you deserve rapid reviews! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Anyway, so sorry this relatively smaller change took so long to get in - it looks great.
Please do be aggressive with me in getting your issues & PRs looked at! ❤️
PR Checklist
status: accepting prs
Overview
It is supposed to bring the
jsdoc-format
converter but I am not sure at all of the rules output array based on the plugin documentation.