search

hosseinmd / prettier-plugin-jsdoc

A Prettier plugin to format JSDoc comments.
MIT License
232 stars 28 forks source link

feat: add option to turn off capitalization #127

Closed vostrnad closed 3 years ago

vostrnad commented 3 years ago

Hello!

This plugin is exactly what I need, except for one little detail: It runs into some false positives when trying to capitalize descriptions. Rather than adding more exceptions, the only one currently being links starting with http(s)://, I propose an option called jsdocCapitalizeDescription that would enable users to turn off capitalization altogether.

jaydenseric commented 3 years ago

Because auto capitalization can be considered destructive, IMO it should be opt-in, not opt-out.

@hosseinmd can we please release this feature? It seems it hasn't been published yet…

vostrnad commented 3 years ago

I made this opt-out so it wouldn't be a breaking change, but I agree that this should definitely be made opt-in in a future breaking release. (Maybe this isn't even a concern as this package is still major version 0.)

And yes, could you create a new release @hosseinmd?

hosseinmd commented 3 years ago

Yes, I think this could be release as a patch version.

hosseinmd commented 3 years ago

https://github.com/hosseinmd/prettier-plugin-jsdoc/blob/master/CHANGELOG.md#0325-2021-11-05

hosseinmd commented 3 years ago

Released in v0.3.25