reactjs/react-docgen
React Docgen
react-docgen is a static analysis library and automated documentation tool designed to extract structured metadata from React component definitions. It functions as an AST-based code parser that transforms source code into machine-readable formats, enabling the programmatic generation of technical documentation and developer portals.
The tool identifies component names, descriptions, and methods by analyzing source code without executing it. It specifically extracts detailed property information, including type definitions, default values, and human-readable descriptions derived from docblock comments. It also tracks component composition by identifying when property types are extended from other modules.
The library provides capabilities for project-wide file scanning using glob patterns and supports the export of extracted metadata to external files. It includes a plugin-driven resolver architecture and custom extraction logic, allowing users to define how components are discovered and parsed via annotations and specialized handlers.
Features
- Automated React Documentation - Extracts structured metadata from React components to automatically generate technical documentation and developer portals.
- Component API Metadata Extraction - Parses component definitions to produce structured data containing names, props, and methods.
- React Component Analysis - Parses React source code to identify props, types, and methods for build-time tooling.
- Metadata Extractors - Parses React source code to extract structured information about components, props, and types.
- Static Source Analysis - Provides a programmatic library for traversing source code and extracting metadata without execution.
- AST Code Parsers - Analyzes the abstract syntax tree of files to identify component patterns and property annotations.
- Source Code Analysis Tools - Analyzes source code to create structured representations of component states using static analysis.
- Component Structure Parsing - Processes source files and directories to generate structured abstract syntax trees for component metadata.
- Automated Documentation Tools - Transforms React component definitions into machine-readable formats for technical documentation.
- Property Type Extraction - Identifies and extracts property type definitions by analyzing static property assignments.
- Source Metadata Extraction - Analyzes source code without execution to extract structural metadata for component documentation.
- Component Name Resolution - Identifies component names by analyzing static properties, class definitions, and function declarations.
- Build and Development Tools - Provides infrastructure for building custom tools that require programmatic access to component definitions.
- AST - Walks through analyzed component structures using custom visitor functions to process specific nodes.
- Docblock Descriptions - Extracts human-readable descriptions from docblock comments to populate component metadata.
- Imperative Method Extraction - Identifies and extracts imperative methods, arguments, and return types from component definitions.
- Extraction Handlers - Employs specialized extraction handlers to pull specific metadata like props and descriptions from ASTs.
- Documentation Build Integration - Integrates as a library or CLI tool within build processes to generate documentation artifacts.
- Extraction Logic - Allows customization of how components are discovered and parsed via custom handlers and resolvers.
- Static Type Metadata Extractors - Programmatically retrieves type information from static definitions within the source code.
- AST Visitor Patterns - Implements the visitor design pattern to traverse abstract syntax trees and process target language nodes.
- Metadata Mapping - Transforms abstract syntax tree nodes into machine-readable JSON for automated documentation pipelines.
- Property Documentation Extraction - Parses docblock comments associated with property types to extract human-readable descriptions.
- Plugin-Based Architectures - Uses a plugin-driven architecture to flexibly resolve component definitions across various coding patterns.
- Component Property Defaults - Identifies default property values from static properties or function arguments for metadata inclusion.
- Composition Tracking - Tracks when property types are extended from other modules by recording the source module in the metadata.
