# reactjs/react-docgen

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

Repository: https://github.com/reactjs/react-docgen
Canonical: https://ross.abutalabs.com/products/react-docgen
Homepage: https://react-docgen.dev
Language: TypeScript
License: MIT
License Family: permissive
Topics: react, documentation, json, docgen, reactjs
Last push: 2026-08-26T12:41:33+00:00

## Health v2 (maintenance only)
Score: 90/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 99, release rhythm 74, longevity 100
- inputs: {"age_days": 4205, "days_push": 7, "days_rel": 173, "gap_med": 23, "n_releases_24m": 16}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 3820, forks 314 (observed 2026-08-28T04:08:21.099042+00:00)

## What it is
react-docgen is a highly customizable library and CLI that parses React component source files (via Babel) and extracts structured, machine-readable JSON documentation about components, including props, methods, and docblocks. It supports React.createClass, ES2015 classes, and function components, with PropTypes, TypeScript, and Flow type information.

## Use cases
- extract props documentation from React components
- generate JSON metadata for a component style guide
- document React component APIs automatically
- parse PropTypes and TypeScript types from component files
- build custom React documentation tooling
- run docgen from the command line over a components directory

## When to choose
- you need low-level, customizable extraction of React component metadata
- you are building a documentation generator or style guide tool
- you want a CLI to batch-analyze component files into JSON
- you need support for PropTypes, TypeScript, and Flow types

## When to avoid
- you want a full-fledged style guide with a rendered UI out of the box
- your project is not React-based
- you need documentation for non-component code like utilities or hooks only

## Facets
- artifact type: library
- maturity: active
- function: documentation, parser, cli, developer-tools
- domain: frontend, documentation, developer-tools
- platform: cli, cross-platform
- tags: react, docgen, props-extraction, babel, -output, typescript, flow, nodejs

## Member repositories
- reactjs/react-docgen (main) score 90

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:08:21.099042+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T18:26:28.272636+00:00, confidence not recorded.
  - readme: https://github.com/reactjs/react-docgen (fetched 2026-08-28T04:08:21.099042+00:00, sha 7b28d9f71791)
  - homepage: https://react-docgen.dev (fetched 2026-08-29T09:21:34.417238+00:00, sha 35b069cafd67)
  - site_page: https://react-docgen.dev/docs/getting-started/nodejs (fetched 2026-08-29T09:21:34.426665+00:00, sha a4f9b4c9fa77)
  - site_page: https://react-docgen.dev/about (fetched 2026-08-29T09:21:34.428701+00:00, sha 27c1992dfbe3)
  - site_page: https://react-docgen.dev/docs/getting-started/cli (fetched 2026-08-29T09:21:34.430466+00:00, sha e68335c0f52e)
  - site_page: https://react-docgen.dev/docs/extending/architecture (fetched 2026-08-29T09:21:34.432256+00:00, sha d34a4b7db899)
  - site_page: https://react-docgen.dev/docs/extending/resolver (fetched 2026-08-29T09:21:34.433842+00:00, sha 833a3bd26d63)
  - site_page: https://react-docgen.dev/docs/extending/handler (fetched 2026-08-29T09:21:34.435356+00:00, sha 76a01a85164c)
  - site_page: https://react-docgen.dev/docs/extending/importer (fetched 2026-08-29T09:21:34.436862+00:00, sha 92ac4f917006)
  - site_page: https://react-docgen.dev/docs/reference/config (fetched 2026-08-29T09:21:34.438359+00:00, sha cfe237e718f9)
- Data as of 2026-08-30T08:39:29.467469+00:00.