reactjs/react-docgen

View on GitHub

A CLI and library to extract information from React component files for documentation generation purposes.

Stars: 3.8k
Forks: 316
Open beginner issues: 0
Indexed issues: 100
Avg merge: 5h 7m
Merged PRs (30d): 4

Dominant language: TypeScript
License: MIT
Last GitHub push: Sep 19, 2026
Latest indexed: Sep 19, 2026
Contributing guide: Contributing guide
Code of conduct: Code of conduct
Beginner labels: help wanted

Beginner friendly Everything

Open All

100 open issues indexed

Feature: Option to remove `| undefined` from optional prop types Open

Difficulty 3/5 1-2 days Newbie friendliness 58/100

reactjs/react-docgen#1134 · Opened Sep 4, 2026
Support Babel 8 in babelParser (loadPartialConfigSync) Open

Difficulty 2/5 1-3 hours Newbie friendliness 78/100

reactjs/react-docgen#1102 · Opened Jul 14, 2026
Typescript Status Open

Difficulty 5/5 Over a week Newbie friendliness 20/100

reactjs/react-docgen#1005 · 4 reactions · Opened Jul 5, 2025
The description of extended Props is not output correctly Open

Difficulty 3/5 1-2 days Newbie friendliness 48/100

reactjs/react-docgen#997 · Opened May 14, 2025
Functions showing as "unknown" when encased in parentheses Open

Difficulty 3/5 1-2 days Newbie friendliness 42/100

reactjs/react-docgen#994 · 1 comment · Opened May 1, 2025
Can't reuse Babel plugins from Storybook Open

Difficulty 4/5 3-5 days Newbie friendliness 25/100

reactjs/react-docgen#982 · 2 comments · Opened Mar 30, 2025
Escapable commas in CLI options? Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

reactjs/react-docgen#962 · 1 comment · Opened Jan 2, 2025
Crash with Flow component syntax Open

flow

Difficulty 4/5 3-5 days Newbie friendliness 35/100

reactjs/react-docgen#944 · 3 comments · 1 reaction · Opened Sep 20, 2024
Documentation missing for most features Open

Difficulty 5/5 Over a week Newbie friendliness 20/100

reactjs/react-docgen#933 · 1 comment · 4 reactions · Opened Jun 19, 2024
Monorepo support is missing Open

Difficulty 4/5 3-5 days Newbie friendliness 38/100

reactjs/react-docgen#930 · 1 comment · 1 reaction · Opened May 30, 2024
Types from `*.d.ts` files are not parsed in node_modules Open

typescript

Difficulty 2/5 1-3 hours Newbie friendliness 48/100

reactjs/react-docgen#929 · 1 comment · 2 reactions · Opened May 30, 2024
Interface extends are supported but not the type ampersand syntax Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

reactjs/react-docgen#928 · 1 reaction · Opened May 30, 2024
No support for components that directly return `null` Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

reactjs/react-docgen#926 · Opened May 30, 2024
Missing support for `Pick<>` and `Omit<>` Open

typescript

Difficulty 4/5 3-5 days Newbie friendliness 35/100

reactjs/react-docgen#925 · 3 comments · 10 reactions · Opened May 29, 2024
Class components with private members breaks docgen Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

reactjs/react-docgen#921 · Opened May 10, 2024
Mo support for typescript intersection and parenthesized types Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

reactjs/react-docgen#914 · 1 reaction · Opened Apr 25, 2024
Failed to parse Open

Difficulty 3/5 1-2 days Newbie friendliness 30/100

reactjs/react-docgen#910 · 1 comment · Opened Apr 12, 2024
TypeScript: Missing Union Elements of Indexed Access Type Open

typescript

Difficulty 3/5 1-2 days Newbie friendliness 45/100

reactjs/react-docgen#906 · 4 reactions · Opened Mar 25, 2024
Using `Readonly<T>` utility type results in losing pieces of `T`'s information Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

reactjs/react-docgen#905 · 6 reactions · Opened Mar 21, 2024
@defaultValue is not parsed from interface Open

Difficulty 3/5 1-2 days Newbie friendliness 48/100

reactjs/react-docgen#901 · 1 comment · 1 reaction · Opened Mar 1, 2024
Typescript: Component declaration reference is not recognized by parser Open

typescript

Difficulty 3/5 1-2 days Newbie friendliness 48/100

reactjs/react-docgen#898 · 1 reaction · Opened Feb 6, 2024
Typescript: Component props not parsed with 'call signature' type Open

typescript

Difficulty 3/5 1-2 days Newbie friendliness 45/100

reactjs/react-docgen#897 · Opened Feb 6, 2024
When postcss modules are present, in some scenarios react-docgen tries to parse css files Open

Difficulty 3/5 1-2 days Newbie friendliness 45/100

reactjs/react-docgen#892 · 2 comments · 6 reactions · Opened Jan 21, 2024
With Typescript Omit Union types get lost Open

new feature typescript

Difficulty 4/5 3-5 days Newbie friendliness 35/100

reactjs/react-docgen#882 · 1 comment · 2 reactions · Opened Dec 19, 2023
TS forwardRef support Open

new feature typescript

Difficulty 4/5 3-5 days Newbie friendliness 35/100

reactjs/react-docgen#878 · 1 comment · 11 reactions · Opened Nov 30, 2023
Better TS enum support Open

new feature typescript

Difficulty 4/5 3-5 days Newbie friendliness 35/100

reactjs/react-docgen#877 · 3 comments · 5 reactions · Opened Nov 30, 2023
useCallback + useImperativeHandle methods Open

bug

Difficulty 3/5 1-2 days Newbie friendliness 45/100

reactjs/react-docgen#856 · Opened Oct 6, 2023
react-docgen cannot extract comments with hermes-parser Open

flow typescript

Difficulty 4/5 3-5 days Newbie friendliness 32/100

reactjs/react-docgen#835 · 3 comments · 3 reactions · Opened Aug 25, 2023
Can be generated from a difinition file? Open

Difficulty 5/5 Over a week Newbie friendliness 15/100

reactjs/react-docgen#814 · 3 comments · Opened Jul 4, 2023
Support for compound components Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

reactjs/react-docgen#775 · 2 comments · 4 reactions · Opened Apr 3, 2023
Nested type descriptions Open

lib new feature

Difficulty 4/5 3-5 days Newbie friendliness 35/100

reactjs/react-docgen#683 · 4 comments · 2 reactions · Opened Nov 18, 2022
How to generate correct prop types when the prop-types package is not explicitly imported? Open

new feature

Difficulty 3/5 1-2 days Newbie friendliness 35/100

reactjs/react-docgen#595 · 1 comment · Opened May 18, 2022
Can I "get" the intended HTML element to be rendered? Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

reactjs/react-docgen#566 · Opened Feb 26, 2022
[Feature Request] Support document tags Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

reactjs/react-docgen#551 · 1 comment · 1 reaction · Opened Dec 3, 2021
Typescript generic class component props not parsed Open

flow new feature

Difficulty 3/5 1-2 days Newbie friendliness 45/100

reactjs/react-docgen#550 · 3 reactions · Opened Dec 1, 2021
Dependency Dashboard Open

Difficulty 4/5 3-5 days Newbie friendliness 15/100

reactjs/react-docgen#526 · Opened Oct 30, 2021
original parserOptions not getting passed to traversed files. Intentional? Open

Difficulty 3/5 1-2 days Newbie friendliness 38/100

reactjs/react-docgen#521 · Opened Sep 15, 2021
Order of intersection types leads to non-deterministic results Open

question

Difficulty 3/5 1-2 days Newbie friendliness 35/100

reactjs/react-docgen#520 · Opened Sep 2, 2021
export types or interfaces from another files Open

Difficulty 5/5 Over a week Newbie friendliness 25/100

reactjs/react-docgen#504 · Opened May 10, 2021
Support React.Config Open

flow new feature

Difficulty 4/5 3-5 days Newbie friendliness 35/100

reactjs/react-docgen#499 · 2 comments · Opened Apr 15, 2021
AssertionError [ERR_ASSERTION]: did not recognize object of type "File" Open

Difficulty 4/5 3-5 days Newbie friendliness 25/100

reactjs/react-docgen#497 · 5 comments · 3 reactions · Opened Mar 22, 2021
[TS] parse returns props without type field. Open

typescript

Difficulty 3/5 1-2 days Newbie friendliness 35/100

reactjs/react-docgen#470 · 5 comments · Opened Oct 8, 2020
Document TSDoc support Open

typescript

Difficulty 4/5 3-5 days Newbie friendliness 35/100

reactjs/react-docgen#467 · 4 reactions · Opened Sep 13, 2020
Documentation for JSDoc support Open

Difficulty 2/5 1-3 hours Newbie friendliness 38/100

reactjs/react-docgen#458 · 1 comment · 7 reactions · Opened Jun 17, 2020
Handling prop defined in the argument list of stateless components Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

reactjs/react-docgen#457 · 2 reactions · Opened Jun 15, 2020
TS Path aliases seem to break type output Open

typescript

Difficulty 3/5 1-2 days Newbie friendliness 35/100

reactjs/react-docgen#456 · Opened Jun 7, 2020
Handle Complex Unions and Intersections Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

reactjs/react-docgen#453 · 8 reactions · Opened Apr 25, 2020
Flow's @platform attribute treated as part of the description Open

Difficulty 3/5 1-2 days Newbie friendliness 35/100

reactjs/react-docgen#447 · Opened Mar 22, 2020
React/TypeScript - Connecting components to Zeplin components failed. Open

typescript

Difficulty 4/5 3-5 days Newbie friendliness 25/100

reactjs/react-docgen#441 · 4 comments · 3 reactions · Opened Mar 7, 2020
React docgen issue with react styleguidist Open

Difficulty 4/5 3-5 days Newbie friendliness 35/100

reactjs/react-docgen#439 · Opened Feb 28, 2020

reactjs/react-docgen

Get new issues in your inbox