Class components with private members breaks docgen

Open
#921 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
react, typescript
Domain
documentation

Research direction

Start by reproducing docgen with a class-based React component that uses private member syntax, then compare the behavior with the fix discussed in issue 346. Confirm the failure no longer occurs and that component information is extracted for documentation.

Written by the indexing model from the issue text.

Description

Running docgen on class-based component with private member syntax results in following error:

TypeError: Argument must be an Identifier or a Literal

This is blocking us from scraping component information for documentation for internal meta components. This was supposedly fixed in https://github.com/reactjs/react-docgen/issues/346, but I am still seeing the error

Dominant language
TypeScript
Stars
3.8k
Forks
316
Avg merge
3h 28m
Merged PRs (30d)
6

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.

More from reactjs/react-docgen

All issues in reactjs/react-docgen

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.