reactjs / reactjs/react-docgen

ast-types should be a Peer dependency probably

Open
#390 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
3.8k
Forks
316
Avg merge
5h 7m
Merged PRs (30d)
4

Description

It doesn't seem possible for third party resolvers or handlers, use different versions of ast-types with react-docgen since it's all operating on the same ast. If someone uses the latest 0.13.0 with react-docgen it breaks, presumable b/c of a change in how visit or parsing works between 0.12.x and 0.13.0.

To address we should probably make ast-types a peer dep or rexport ast-types for consuming third party resolvers/handlers

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by tracing how the ast-types dependency is used by react-docgen and how third-party resolvers or handlers consume the shared AST; compare the peer-dependency and re-export options. Done means third-party integrations can use a compatible ast-types version without the reported breakage.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.