MCPcopy Index your code
hub / github.com/reactjs/react-docgen

github.com/reactjs/react-docgen @3.0.6 sqlite

repository ↗ · DeepWiki ↗ · release 3.0.6 ↗
497 symbols 1,795 edges 278 files 18 documented · 4%
README

react-docgen

react-docgen is a highly customizable library that extracts information from React components and returns this information in a structured machine readable format from which documentations can be generated.

@react-docgen/cli is a cli wrapper around the library allowing using react-docgen on the command line.

Typescript

See this issue about the status of TypeScript.

Documentation

For version 5.x please checkout the README.md on the 5.x branch

For version 6.x and newer please visit react-docgen.dev

License

This project is licensed under the MIT License.

Extension points exported contracts — how you extend this code

ResolverClass (Interface)
(no doc) [6 implementers]
packages/react-docgen/src/resolver/index.ts
CLIOptions (Interface)
(no doc)
packages/react-docgen-cli/src/commands/parse/command.ts
Props (Interface)
(no doc)
packages/website/src/components/users/User.tsx
Documentation (Interface)
(no doc)
packages/react-docgen/src/Documentation.ts
Props (Interface)
(no doc)
packages/website/src/components/users/UserList.tsx
MethodParameter (Interface)
(no doc)
packages/react-docgen/src/Documentation.ts
PlaygroundProps (Interface)
(no doc)
packages/website/src/components/playground/Playground.tsx
MethodReturn (Interface)
(no doc)
packages/react-docgen/src/Documentation.ts

Core symbols most depended-on inside this repo

get
called by 1045
packages/react-docgen/src/Documentation.ts
statement
called by 272
packages/react-docgen/tests/utils.ts
expressionLast
called by 174
packages/react-docgen/tests/utils.ts
expression
called by 131
packages/react-docgen/tests/utils.ts
resolveToValue
called by 91
packages/react-docgen/src/utils/resolveToValue.ts
statementLast
called by 83
packages/react-docgen/tests/utils.ts
stmtLast
called by 68
packages/react-docgen/tests/utils.ts
getTSType
called by 62
packages/react-docgen/src/utils/getTSType.ts

Shape

Function 280
Method 73
Class 72
Interface 67
Enum 5

Languages

TypeScript100%

Modules by API surface

packages/react-docgen/src/Documentation.ts25 symbols
packages/react-docgen/src/utils/getTSType.ts17 symbols
packages/react-docgen/tests/utils.ts13 symbols
packages/react-docgen/src/utils/ts-types/index.ts12 symbols
packages/react-docgen/src/utils/getPropType.ts12 symbols
packages/react-docgen/src/utils/parseJsDoc.ts10 symbols
packages/react-docgen/tests/integration/__fixtures__/component_2.js9 symbols
packages/react-docgen/src/utils/getMethodDocumentation.ts9 symbols
packages/react-docgen/src/resolver/FindAnnotatedDefinitionsResolver.ts9 symbols
packages/react-docgen/src/handlers/componentMethodsHandler.ts9 symbols
packages/website/src/components/playground/Playground.tsx8 symbols
packages/react-docgen/src/resolver/FindExportedDefinitionsResolver.ts8 symbols

Dependencies from manifests, versioned

@babel/core7.28.0 · 1×
@babel/traverse7.28.0 · 1×
@babel/types7.28.2 · 1×
@changesets/changelog-github0.6.0 · 1×
@changesets/cli2.30.0 · 1×
@codemirror/lang-javascript6.2.5 · 1×
@codemirror/lang-json6.0.2 · 1×
@codemirror/view6.40.0 · 1×
@eslint/eslintrc3.3.5 · 1×
@eslint/js10.0.1 · 1×
@headlessui/react2.2.9 · 1×
@tailwindcss/postcss4.2.1 · 1×

For agents

$ claude mcp add react-docgen \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact