Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Support @deprecated jsdoc tag

See original GitHub issue

Is your feature request related to a problem? Please describe In my component’s props TS interface, I can use JSDoc comments to set the description, and can even use the @default tag to describe the default value 💯 However, nothing happens when I use the @deprecated tag.

Describe the solution you’d like Some ideas:

It would be nice if the parent <tr> got required and deprecated classesNames e.g. <tr className="required"> & <tr className="deprecated"> so that I can easily apply custom styling to these rows.
For deprecated props, it would be nice if the prop name appeared grayed out, and the word Deprecated appeared in bold below it, followed by any description. e.g.

PropName Deprecated since version 2.0

Describe alternatives you’ve considered For now I will simply omit deprecated props manually per story via the meta default export’s parameters. parameters.docs.page.excludeProps = ['my_depricated_prop_name']

Are you able to assist to bring the feature to reality? Perhaps in the future but not at this time.

Additional context https://jsdoc.app/tags-deprecated.html