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

Why not realize "//" which can also be a description? Open

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

reactjs/react-docgen#420 · 1 comment · 2 reactions · Opened Jan 14, 2020
No suitable component definition found. Open

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

reactjs/react-docgen#419 · 2 comments · Opened Jan 10, 2020
Third party typescript components not getting parsed Open

improvement

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

reactjs/react-docgen#416 · 2 comments · 28 reactions · Opened Jan 5, 2020
Confused react type names on Flow and Typescript Open

breaking bug

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

reactjs/react-docgen#395 · 3 comments · Opened Oct 24, 2019
Multiple Export Definitions Error Open

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

reactjs/react-docgen#393 · 2 comments · Opened Oct 14, 2019
ast-types should be a Peer dependency probably Open

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

reactjs/react-docgen#390 · 2 comments · Opened Sep 9, 2019
Support for CSS Modules Open

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

reactjs/react-docgen#388 · 1 comment · Opened Aug 22, 2019
Typescript support for defining component Interface through React interface Open

bug typescript

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

reactjs/react-docgen#387 · 8 comments · 157 reactions · Opened Aug 16, 2019
CLI: Having a dedicated flag to show up local environment information Open

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

reactjs/react-docgen#386 · 1 comment · Opened Aug 1, 2019
Extract comments from `defaultProps` Open

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

reactjs/react-docgen#382 · 1 reaction · Opened Jul 20, 2019
The enum value of oneOf doesn't recognize description. Open

help wanted improvement

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

reactjs/react-docgen#381 · Opened Jul 18, 2019
Support extracting of type information from tagged templates Open

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

reactjs/react-docgen#375 · 2 comments · Opened Jun 22, 2019
Move Babel Dependencies to Peer Dependencies Open

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

reactjs/react-docgen#374 · Opened Jun 13, 2019
Can not parse function component Open

needs-more-info

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

reactjs/react-docgen#370 · 4 comments · Opened Jun 4, 2019
RefTypes inside Interface does not expand correctly in Typescript Open

typescript

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

reactjs/react-docgen#366 · 4 comments · Opened May 21, 2019
Component that returns an array is not recognised Open

component-detection

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

reactjs/react-docgen#365 · 1 comment · Opened May 21, 2019
Webpack problem with fs module Open

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

reactjs/react-docgen#363 · 2 comments · Opened May 20, 2019
[Typescript] Default props from defaults when destructuring Open

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

reactjs/react-docgen#358 · 4 comments · 2 reactions · Opened May 8, 2019
No suitable component definition found for container component Open

component-detection improvement

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

reactjs/react-docgen#336 · 9 comments · 5 reactions · Opened Mar 15, 2019
Using the export keyword between a decorator and a class is not allowed Open

upstream

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

reactjs/react-docgen#333 · 3 comments · Opened Feb 25, 2019
Generate docs for hooks Open

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

reactjs/react-docgen#332 · 12 comments · 18 reactions · Opened Feb 24, 2019
SyntaxError: Invalid regular expression flag Open

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

reactjs/react-docgen#329 · 1 comment · 2 reactions · Opened Feb 20, 2019
It doesn't support styled components typed with Flow Open

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

reactjs/react-docgen#314 · 1 comment · 4 reactions · Opened Dec 13, 2018
How do I extend docgen to parse non-exported styled-components? Open

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

reactjs/react-docgen#308 · 1 comment · 4 reactions · Opened Oct 31, 2018
Cannot parse Flow $Shape Open

flow help wanted improvement

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

reactjs/react-docgen#306 · 1 comment · Opened Oct 25, 2018
Allow flow inference of cast variable definitions. Open

flow

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

reactjs/react-docgen#297 · Opened Sep 10, 2018
Inconsistent output due to os EOL Open

bug

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

reactjs/react-docgen#289 · 2 comments · 2 reactions · Opened Aug 20, 2018
No suitable component definition found for higher-order component Open

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

reactjs/react-docgen#288 · 5 comments · 11 reactions · Opened Aug 3, 2018
Type annotation with flow syntax and defaulting of args is breaking React Class validator Open

needs-more-info

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

reactjs/react-docgen#284 · 5 comments · Opened Jul 25, 2018
wrong `composes` for propType objects that are wrapped Open

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

reactjs/react-docgen#283 · 5 reactions · Opened Jul 16, 2018
Error: No suitable component definition found using "export default ({}) => ..." Open

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

reactjs/react-docgen#264 · 1 comment · 1 reaction · Opened Apr 12, 2018
Missing support for Flow Unions Open

bug

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

reactjs/react-docgen#259 · 5 comments · 6 reactions · Opened Feb 28, 2018
styled-components and Glamorous support Open

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

reactjs/react-docgen#256 · 6 comments · 8 reactions · Opened Feb 23, 2018
Complex composition using `PropTypes.shape` Open

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

reactjs/react-docgen#255 · 6 reactions · Opened Feb 22, 2018
Better documentation on resolvers Open

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

reactjs/react-docgen#244 · 2 comments · 5 reactions · Opened Jan 24, 2018
DocGen not recognizing decomposed function parameters Open

improvement

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

reactjs/react-docgen#238 · 2 comments · 3 reactions · Opened Dec 17, 2017
HOC as a function won't get generated docs Open

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

reactjs/react-docgen#205 · 9 comments · 1 reaction · Opened Aug 14, 2017
react-docgen generates platform specific structure Open

needs-discussion

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

reactjs/react-docgen#199 · 5 comments · Opened Jul 29, 2017
Doesn't find HOCs that just wrap & re-export component Open

needs-discussion

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

reactjs/react-docgen#177 · 10 comments · 1 reaction · Opened Apr 16, 2017
Support Object.assign in propTypes definition Open

improvement

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

reactjs/react-docgen#151 · 9 comments · 6 reactions · Opened Jan 25, 2017
Support for documenting component props in the component docBlock Open

custom-handler idea needs-discussion

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

reactjs/react-docgen#98 · 6 comments · 6 reactions · Opened Jul 21, 2016
react-docgen is not compatible with react-like libraries Open

improvement needs-discussion

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

reactjs/react-docgen#96 · 3 comments · Opened Jul 6, 2016
Dependency detection Open

custom-handler question

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

reactjs/react-docgen#82 · 3 comments · Opened Jun 7, 2016
feature request. Allow to analyze reexported components Open

help wanted idea

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

reactjs/react-docgen#73 · 4 comments · 4 reactions · Opened Apr 13, 2016
Stateless function components without React.createElement or JSX? Open

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

reactjs/react-docgen#70 · 4 comments · 7 reactions · Opened Apr 7, 2016
Document prop type values as nicely as flow type values in the README Open

improvement

Difficulty 1/5 Under an hour Newbie friendliness 25/100

reactjs/react-docgen#55 · 1 reaction · Opened Jan 29, 2016
Expressions in propTypes not parsed correctly Open

breaking needs-discussion

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

reactjs/react-docgen#36 · 4 comments · Opened Oct 29, 2015
Infer displayName from function/class/variable name Open

custom-handler improvement

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

reactjs/react-docgen#30 · 15 comments · 1 reaction · Opened Oct 14, 2015
Better support for custom types Open

improvement

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

reactjs/react-docgen#24 · 10 comments · 1 reaction · Opened Sep 18, 2015
propTypeHandler: Improve support for detecting composition from code Open

improvement

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

reactjs/react-docgen#9 · 1 comment · Opened Mar 18, 2015

reactjs/react-docgen

Get new issues in your inbox