Skip to content

[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

Merged
merged 5 commits into from
Mar 28, 2020
Merged

[Feature] Add jsdoc-format converter #238

merged 5 commits into from
Mar 28, 2020

Conversation

KingDarBoja
Copy link
Collaborator

@KingDarBoja KingDarBoja commented Oct 13, 2019

PR Checklist

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.

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a 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.

@JoshuaKGoldberg JoshuaKGoldberg added the status: waiting for author The PR author should address requested changes label Oct 19, 2019
@KingDarBoja
Copy link
Collaborator Author

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.

@JoshuaKGoldberg JoshuaKGoldberg added the status: waiting for reviewer Waiting for a maintainer to review label Oct 20, 2019
@KingDarBoja KingDarBoja changed the title Add jsdoc-format converter (WIP) [Feature] Add jsdoc-format converter Oct 21, 2019
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a 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 JoshuaKGoldberg removed the status: waiting for reviewer Waiting for a maintainer to review label Oct 26, 2019
@KingDarBoja
Copy link
Collaborator Author

@JoshuaKGoldberg Can you review this again? I think everything should be okay now :)

@JoshuaKGoldberg JoshuaKGoldberg added status: waiting for reviewer Waiting for a maintainer to review and removed status: waiting for author The PR author should address requested changes labels Feb 11, 2020
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a 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!

@JoshuaKGoldberg JoshuaKGoldberg added status: waiting for author The PR author should address requested changes and removed status: waiting for reviewer Waiting for a maintainer to review labels Feb 15, 2020
@JoshuaKGoldberg JoshuaKGoldberg changed the title (WIP) [Feature] Add jsdoc-format converter [Feature] Add jsdoc-format converter Feb 15, 2020
@JoshuaKGoldberg
Copy link
Member

👋 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!

@KingDarBoja
Copy link
Collaborator Author

@JoshuaKGoldberg I made the changes months ago, just waiting for your review.

@JoshuaKGoldberg
Copy link
Member

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!

@JoshuaKGoldberg JoshuaKGoldberg added status: waiting for reviewer Waiting for a maintainer to review and removed status: waiting for author The PR author should address requested changes labels Mar 25, 2020
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a 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! ❤️

@JoshuaKGoldberg JoshuaKGoldberg merged commit a1e1c4c into typescript-eslint:master Mar 28, 2020
@KingDarBoja KingDarBoja deleted the feature/jsdoc-format-converter branch March 28, 2020 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: waiting for reviewer Waiting for a maintainer to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

🙏jsdoc-format does not yet have an ESLint equivalent.
2 participants