Support @deprecated jsdoc tag #20154
Conversation
|
@yuisato1025 is this good to merge? |
|
@JReinhold @tmeasday can you please review this? It's already been merged but I'd love to get more eyes on it |
There was a problem hiding this comment.
I can't figure out how to test this out.
We have a bunch of these @deprecated notations in the Description block, but they don't show up in the ArgsTable.
I've tried to trace this, and I can see the deprecated tags getting added all the way through to the React renderer's extractArgTypes. But when I log them in the ArgsJsDoc component in ArgsTable, they aren't there.
It looks like we're ignoring extractArgTypes for TS files in the react-vite framework (even though we are running it, because my logs are there), but it's a bit hard to tell, so that might not be the issue at all.
| function extractDeprecated(tag: doctrine.Tag): ExtractedJsDocDeprecated { | ||
| if (tag.title != null) { | ||
| return { | ||
| name: tag.description, |
There was a problem hiding this comment.
I would think this is a "description" rather than a "name"? That's at least how we use it in our TS prop types, and what I can gather from JSDoc specs:
/**
* @deprecated Manually specifying description type is deprecated. See https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#description-block-parametersnotes-and-parametersinfo
*/
type?: DescriptionType;| @@ -81,6 +88,11 @@ export const ArgJsDoc: FC<ArgJsDocArgs> = ({ tags }) => { | |||
| <tr key={x.name}> | |||
| <td> | |||
| <code>{x.name}</code> | |||
| {hasDisplayableDeprecated && ( | |||
| <div> | |||
| <span>Deprecated</span> {tags.deprecated} | |||
There was a problem hiding this comment.
given the existing implementation, shouldn't this access tags.deprecated.name and not tags.deprecated? That's what I gather from console logging a bunch of places at least.
| export interface JsDocParamDeprecated { | ||
| deprecated?: string; | ||
| } |
There was a problem hiding this comment.
similar concern as above.
|
@yuisato1025 Can you assist with resolving the issues @JReinhold has raised? |
Issue: #12759
What I did
How to test
If your answer is yes to any of these, please make sure to include it in your PR.