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

Upgrade react-docgen-typescript to 2.x #50

Closed
wants to merge 3 commits into from

Conversation

phildenhoff
Copy link

@phildenhoff phildenhoff commented Nov 18, 2022

Change description

react-docgen-typescript 1.20.5 has a bug styleguidist/react-docgen-typescript#356 that causes us not to be able to generate React snippets for our Typescript components using the Zeplin CLI.

That issue was resolved last year in styleguidist/react-docgen-typescript#360, which is in release 2.0.0.

This PR upgrades the dependency to 2.x to include that fix. Upgrading Typescript was a requirement to upgrade to this version.

As a work-around, I was able to lock the package resolution in our package by setting a resolution in package.json, but I'd prefer not to.

"resolutions": {
  "react-docgen-typescript": "2.0.0"
}

Type of change

  • Bug fix (fixes an issue)
  • New feature (adds functionality)

Related issues

None — I fixed this issue instead of reporting it.

Checklists

Development

  • Lint rules pass locally
  • Application changes have been tested thoroughly
  • Automated tests covering modified code pass

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

Code review

  • Pull request has a descriptive title and context useful to a reviewer. Screenshots or screencasts are attached as necessary
  • "Ready for review" label attached and reviewers assigned
  • Changes have been reviewed by at least one other contributor
  • Pull request linked to task tracker where applicable

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

Successfully merging this pull request may close these issues.

1 participant