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

[Bug]: JSDocs tags are dropped #21753

Closed
okonet opened this issue Mar 23, 2023 · 5 comments · Fixed by #21794
Closed

[Bug]: JSDocs tags are dropped #21753

okonet opened this issue Mar 23, 2023 · 5 comments · Fixed by #21794

Comments

@okonet
Copy link
Contributor

okonet commented Mar 23, 2023

Describe the bug

It's not possible to see / access any of the JSDocs tags on argTypes / props table.

Debugging this also shows that jsDocTags: undefined in the arg types.

To Reproduce

Use this type

export interface Props {
  /**
   * @deprecated this is the reason
   */
  deprecatedProp?: boolean;
}

on a component to test.

System

Environment Info:

  System:
    OS: macOS 13.2
    CPU: (10) arm64 Apple M1 Pro
  Binaries:
    Node: 16.17.0 - /opt/homebrew/opt/node@16/bin/node
    Yarn: 1.22.19 - ~/Projects/alpha-design-system/node_modules/.bin/yarn
    npm: 8.15.0 - /opt/homebrew/opt/node@16/bin/npm
  Browsers:
    Chrome: 111.0.5563.110
    Safari: 16.3

Additional context

No response

@shilman
Copy link
Member

shilman commented Mar 28, 2023

This was supposedly addressed in #20154. @ndelangen @JReinhold since you merged and reviewed can you please chime in here?

@okonet
Copy link
Contributor Author

okonet commented Mar 28, 2023

Is it supposed to be part of 7.0 RC?

@shilman
Copy link
Member

shilman commented Mar 28, 2023

Yes, but based on the comments on the PR, I don't have any confidence that it was actually tested or does what it was supposed to do.

@ndelangen
Copy link
Member

@JReinhold do you want to investigate together?

@shilman
Copy link
Member

shilman commented Mar 29, 2023

Shiver me timbers!! I just released https://github.com/storybookjs/storybook/releases/tag/v7.0.0-rc.9 containing PR #21794 that references this issue. Upgrade today to the @next NPM tag to try it out!

npx sb@next upgrade --prerelease

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

Successfully merging a pull request may close this issue.

3 participants