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

JSDoc plugin features #128

Open
cspotcode opened this issue Jun 18, 2021 · 1 comment
Open

JSDoc plugin features #128

cspotcode opened this issue Jun 18, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@cspotcode
Copy link

With --plugin jsdoc is there a way to:

  • remove the JSDoc annotations? For example /** @param {Foo} bar */ should be entirely removed since it does not contain any descriptions
  • convert inline type assertions? For example /** @type {Foo} */(bar) converts to ((bar) as Foo)

Is this the right place to ask? I can open 2x separate tickets if that would be better.

@edsrzf
Copy link
Collaborator

edsrzf commented Jun 19, 2021

Thanks for the suggestions! This is definitely the right place to ask. Two separate issues might be better since, even though these are both JSDoc-related, they're pretty distinct requests that would likely be implemented separately.

Removing JSDoc annotations seems like it could be doable, although it may be hard to get the whitespace perfect. This is something that I've wished for myself, too, but haven't gotten around to implementing.

Converting inline type assertions also seems like it could be doable. I didn't consider it when I wrote the plugin as the code I've converted hasn't used these. It might be helpful if we can find a source of good examples, as I'm not quite sure how these are typically used in the wild.

@Rudeg Rudeg added the enhancement New feature or request label Sep 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants