Skip to content
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

Add option to allow formatting one-line JSDoc annotations as multi-line #93

Closed
mnquintana opened this issue Feb 25, 2021 · 0 comments
Closed
Labels

Comments

@mnquintana
Copy link

It would be really helpful to have an option to configure prettier-plugin-jsdoc to allow one-line JSDoc annotations as multiline, e.g.:

Expected

/**
 * Adapted from https://testing-library.com/docs/react-testing-library/setup/
 */

Actual

/** Adapted from https://testing-library.com/docs/react-testing-library/setup/ */

My use case is that although the current behavior is a lot more compact, it's harder to visually scan and recognize as a JSDoc comment (as opposed to just a regular ol' JS block comment) compared to the multi-line version. I might be in the minority on this though, so I'm totally fine with this proposal being an opt-in option rather than the new default.

Thanks so much for all your hard work on this! Having a prettier plugin for JSDoc has literally saved me hours of manual formatting work 🙌🏽

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants