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

Addon Docs: Fix [Object object] displayName in some JSX components #26566

Merged
merged 1 commit into from
Mar 19, 2024

Conversation

yannbf
Copy link
Member

@yannbf yannbf commented Mar 19, 2024

Closes #20920, Closes #26503

What I did

This PR reworks the logic in the JSX decorator to account for more use cases, fixing the [Object object] displayName issue.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

There are unit tests for this. You can also test it manually if you'd like:

  1. Run a sandbox for template, e.g. yarn task --task sandbox --start-from auto --template react-vite/default-ts
  2. Change its main.ts to use react-typescript-docgen
  3. Look at the autodocs page for the Button component
  4. Change the Button component to use different formats:
  • Nothing, just as is in the boilerplate
  • override Button.displayName
  • forwardRef()
  • memo()

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@yannbf yannbf added bug patch:yes Bugfix & documentation PR that need to be picked to main branch addon: docs ci:normal labels Mar 19, 2024
displayName: (el: any): string => {
if (el.type.displayName) {
return el.type.displayName;
} else if (getDocgenSection(el.type, 'displayName')) {
Copy link
Member Author

@yannbf yannbf Mar 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I moved this up because I am assuming that docgenInfo should take precedence over an element's symbol name.

Before, if you had a forwardRef element AND docgenInfo with a displayName of "Button", it would say <React.ForwardRef> instead of <Button>.

Now it will say <Button>.

Copy link

nx-cloud bot commented Mar 19, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 2961cee. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

Copy link
Contributor

@kasperpeulen kasperpeulen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@yannbf yannbf merged commit 79abc6c into next Mar 19, 2024
54 of 67 checks passed
@yannbf yannbf deleted the yann/fix-docs-jsx-decorator branch March 19, 2024 11:14
storybook-bot pushed a commit that referenced this pull request Mar 19, 2024
Addon Docs: Fix [Object object] displayName in some JSX components

(cherry picked from commit 79abc6c)
storybook-bot pushed a commit that referenced this pull request Mar 19, 2024
Addon Docs: Fix [Object object] displayName in some JSX components

(cherry picked from commit 79abc6c)
storybook-bot pushed a commit that referenced this pull request Mar 19, 2024
Addon Docs: Fix [Object object] displayName in some JSX components

(cherry picked from commit 79abc6c)
storybook-bot pushed a commit that referenced this pull request Mar 19, 2024
Addon Docs: Fix [Object object] displayName in some JSX components

(cherry picked from commit 79abc6c)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Mar 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs bug ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
2 participants