NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
npm
npm, #2142 most downloaded on npm
A library to extract information from React components for documentation generation.
Latest stable
8.0.4
Last release 2 months ago
20 Sep 2026
Release timing varies
gaps range from 2 weeks to 10 months
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
12 years old
99 releases · first in 2015
Drag across the ruler to compare, or tap a release to open it.
### Patch Changes - #1141 `f037f20` Thanks @danez-bot! - Prevent stack overflows caused by circular interface inheritance and type aliases. Thanks @ro
f037f20
Thanks @danez-bot! - Prevent stack overflows
caused by circular interface inheritance and type aliases. Thanks
@router0mail for reporting this issue.`a8a8bb8` Thanks [@renovate\[bot\]](https://github.com/renovate%5Bbot%5D)! - Added more defensive checks throughout the codebase. No functional change
a8a8bb8
Thanks @renovate[bot]! - Added more
defensive checks throughout the codebase. No functional changes.Your coding agent can read these notes before it upgrades. Set up the MCP server →
@DiogoDoreto made their first contribution in https://github.com/reactjs/react-docgen/pull/1036
a122bff
Thanks @DiogoDoreto! - Do not fail when
resolving inside ObjectMethod nodesFull Changelog: https://github.com/reactjs/react-docgen/compare/@react-docgen/cli@3.0.3...react-docgen@8.0.2
### Patch Changes - #1009 `4c7dd9d` Thanks @danez! - Do not fail on new VoidPattern type
With this react-docgen version Node.js support is:
### Patch Changes - #969 `639bf37` Thanks @christon88! - Expose more TypeScript types
639bf37
Thanks @christon88! - Expose more TypeScript
typesreact-docgen will now find IButtonProps.
### Patch Changes - #890 `afe8d02` Thanks @danez! - Do not throw error when using namespace specifiers in export statements
`64bf1aa` Thanks @danez! - Fix handling of template literals
### Patch Changes - #870 `2b51bbd` Thanks @renovate! - update dependency @types/doctrine to ^0.0.9
`ts const Component: React.FC = (props: { some: string }) => {}; `
#846
82154c3
Thanks @danez! - getTypeFromReactComponent now
returns an array of paths to types instead of just one. This can appear when
multiple type definitions are found for a component, for example:
const Component: React.FC<Props> = (props: { some: string }) => {};
In this example both the Props definition as well as { some: string } are
now found and used.
Here is a simple diff to illustrate the change when using
getTypeFromReactComponent:
const type = getTypeFromReactComponent(path)
-if (type) {
+if (type.length > 0) {
// do smth
}
#848
dda8915
Thanks @danez! - Drop support for Node.js
version 14.
The minimum supported version is now 16.14.0
#846
62e692f
Thanks @danez! - resolveToValue will not resolve
to ImportDeclaration anymore but instead to one of the possible specifiers
(ImportSpecifier, ImportDefaultSpecifier or ImportNamespaceSpecifier).
This gives better understanding to which specifier exactly resolveToValue
did resolve a NodePath to.
Here is a possible easy fix for this in a code snippet that uses
resolveToValue
const resolved = resolveToValue(path);
-if (resolved.isImportDeclaration()) {
+if (resolved.parentPath?.isImportDeclaration()) {
// do smth
}
#862
40ebb00
Thanks @danez! - Support PropsWithoutRef,
PropsWithRef and PropsWithChildren in TypeScript.
Component props are now detected correctly when these builtin types are used, but they do currently not add any props to the documentation.
#846
82154c3
Thanks @danez! - Add support for React.FC in
TypeScript.
6312f2f
Thanks @renovate[bot]! - update
dependency @types/doctrine to ^0.0.7
#846
c01d1a0
Thanks @danez! - Fix detection of react class
components when super class is imported via named import.
#861
74b6680
Thanks @renovate! - update dependency
@types/doctrine to ^0.0.8
#846
0641700
Thanks @danez! - Remove unnecessary call to
resolveToValue when trying to find props type from react components.
#858
3be404e
Thanks @danez! - Fix detection of React.Children
with ESM imports
### Patch Changes - #838 `8ba9ac7` Thanks @danez! - Support index types correctly in flow
### Patch Changes - #830 `c3c16e3` Thanks @danez! - Fixed error with object and array patterns in function signatures.
### Patch Changes - #810 `ddf4e20` Thanks @danez! - Read docblock in nested flow object types and use them as descriptions
### Patch Changes - #806 `c7e2bd5` Thanks @danez! - Make docblocks for assigned methods be correctly detected.
`96d6e9e` Thanks @danez! - The main parse API had some breaking changes.
Migration Guide: https://react-docgen.dev/docs/migrate/v6
96d6e9e
Thanks @danez! - Rename flowTypeHandler to
codeTypeHandler because it handles Flow and TypeScript
#719
d7a39af
Thanks @danez! - Refactored
resolveComponentDefinition utility.
findComponentDefinitionisComponentDefinition#761
dfc2f85
Thanks @danez! - Renamed propDocBlockHandler to
propDocblockHandler for consistency
96d6e9e
Thanks @danez! - Simplify
resolveObjectValuesToArray and remove type handling. None of the code that
was handling types was used.
caae6bf
Thanks @danez! - The return values of
resolveObjectValuesToArray are now in the order they are defined in the
source code.
#744
e956802
Thanks @danez! - Removed match utility.
The utility can be replaced by babel helpers and is not needed anymore. Also
using explicit checks like path.isMemberExpression() is better for type
safety and catching potential bugs.
96d6e9e
Thanks @danez! - Migrate react-docgen to ES
modules. Please read
this
#693
3b28f6e
Thanks @danez! - The CLI was removed from
react-docgen into its own package @react-docgen/cli.
Check out https://react-docgen.dev/docs/getting-started/cli for the documentation.
96d6e9e
Thanks @danez! - The main parse API had some
breaking changes.
The arguments were changed from previously 5 to just 2. The following diff illustrates how to migrate:
-parse(src, resolver, handlers, importer, options: { filename, ...babelOptions})
+parse(src, { resolver, handlers, importer, filename, babelOptions: {} })
The return type is now always an array, independent of the resolver, even if only one component was found in the file.
#786
0a2481d
Thanks @danez! - Renamed the method toObject to
build in the DocumentationBuilder.
This method might be used by integrations.
96d6e9e
Thanks @danez! - Renamed some of the main exports
for clarity.
Renamed handlers to builtinHandlers Renamed resolver to
builtinResolvers Renamed importers to builtinImporters
#743
5215bab
Thanks @danez! - Removed support for the
@extends React.Component annotation on react class components.
Instead, you can use the new @component annotation or define your own
annotation by creating a custom FindAnnotatedDefinitionsResolver instance
#714
80e4c74
Thanks @danez! - Renamed and migrated built-in
resolvers to classes.
findAllComponentDefinitions was renamed to FindAllDefinitionsResolver
and is now a class.
-const resolver = builtinResolvers.findAllComponentDefinitions
+const resolver = new builtinResolvers.FindAllDefinitionsResolver()
findAllExportedComponentDefinitions was renamed to
FindExportedDefinitionsResolver and is now a class.
-const resolver = builtinResolvers.findAllExportedComponentDefinitions
+const resolver = new builtinResolvers.FindExportedDefinitionsResolver()
findExportedComponentDefinition was removed. Use
FindExportedDefinitionsResolver with the limit option instead.
This is still the default resolver.
-const resolver = builtinResolvers.findExportedComponentDefinition
+const resolver = new builtinResolvers.FindExportedDefinitionsResolver({ limit: 1 })
96d6e9e
Thanks @danez! - Migrated to babel toolchain
This is one of the big changes in this new version of react-docgen. It made the code a lot more robust because there are now finally working TypeScript types for the ASTs.
Another benefit from this change is that react-docgen is now a lot faster. 🚀 In some tests an improvement of nearly 50% was seen in comparison to version 5.
#707
d4c27d4
Thanks @danez! - Improve performance of file
system importer.
The file system importer now also caches the resolving of files in addition to parsing files. If the importer is used in an environment where files do change at runtime (like a watch command) then the caches will need to be cleared on every file change.
96d6e9e
Thanks @danez! - Changed the minimum Node.js
version to 14.18.0
96d6e9e
Thanks @danez! - Add support for .cts and .mts
extension when using typescript
96d6e9e
Thanks @danez! - Treat functions returning
React.Children.map as components
96d6e9e
Thanks @danez! - Improve performance by creating
all visitors only once
96d6e9e
Thanks @danez! - Support all possible kinds of
functions in the displayNameHandler
#786
0a2481d
Thanks @danez! - Export the type for the
DocumentationBuilder.
#786
0a2481d
Thanks @danez! - The types NodePath and
babelTypes are now exported.
These types are useful when building integrations in TypeScript.
babelTypes includes all types from @babel/types.
#714
80e4c74
Thanks @danez! - Add the new ChainResolver which
allows multiple resolvers to be chained.
import { builtinResolvers } from 'react-docgen';
const { ChainResolver } = builtinResolvers;
const resolver = new ChainResolver([resolver1, resolver2], {
chainingLogic: ChainResolver.Logic.ALL, // or ChainResolver.Logic.FIRST_FOUND,
});
96d6e9e
Thanks @danez! - Support all literal types in
typescript
96d6e9e
Thanks @danez! - Support class and function
declarations without identifier
96d6e9e
Thanks @danez! - Support resolving of
destructuring in resolveToValue
#714
80e4c74
Thanks @danez! - Allow resolvers to be classes in
addition to functions.
import type { ResolverClass, ResolverFunction } from 'react-docgen';
// This was the only option until now
const functionResolver: ResolverFunction = (file: FileState) => {
//needs to return array of found components
};
// This is the new class resolver
class MyResolver implements ResolverClass {
resolve(file: FileState) {
//needs to return array of found components
}
}
const classResolver = new MyResolver();
96d6e9e
Thanks @danez! - Improve performance drastically
by making changes to AST traversal
Visitors are now pre-exploded and are cached in the module scope instead of creating them on every call. This change brought the benchmark from 170ops/s to 225ops/sec
96d6e9e
Thanks @danez! - Add codes to errors to be able to
easily detect them
There is a new export ERROR_CODES that contains all possible error codes.
The two errors that have codes right now are:
MISSING_DEFINITION: No component found in a fileMULTIPLE_DEFINITIONS: Multiple components found in one file96d6e9e
Thanks @danez! - Support handling
useImperativeHandle correctly
#743
5215bab
Thanks @danez! - Added a new resolver that finds
annotated components. This resolver is also enabled by default.
To use this feature simply annotated a component with @component.
// @component
class MyComponent {}
#745
8fe3dbf
Thanks @danez! - Fix crash when using TypeScript
mapped types
#789
7c99f15
Thanks @danez! - Fix TypeScript types when strict
null checks are disabled
96d6e9e
Thanks @danez! - Handle React.forwardRef calls
without a function
96d6e9e
Thanks @danez! - Fixed the handling of some edge
cases in resolveToValue
96d6e9e
Thanks @danez! - Remove trailing commas and
semicolons from raw values in the documentation
#767
a684d82
Thanks @danez! - Fix handling of PropTypes.oneOf
to handle unresolved imported values correctly
#761
cc94da2
Thanks @danez! - Fix using react-docgen in
browsers
#761
98a1138
Thanks @danez! - Add displayName and
description to Documentation type
96d6e9e
Thanks @danez! - Parse jsdoc comments for
TypeScript structs
#748
ea25b16
Thanks @danez! - Handle cyclic references in
PropTypes shape() and exact() methods.
#787
5a226ac
Thanks @danez! - Fix @babel/traverse import to
work in non ESM environments
96d6e9e
Thanks @danez! - Correctly handle ObjectProperties
in isReactComponentMethod
#747
1aa0249
Thanks @danez! - Handle typeof import('...') and
typeof MyType.property correctly in TypeScript
050313d
Thanks @danez! - Correctly add LICENSE file to
published packages
96d6e9e
Thanks @danez! - Add support for TSAsExpressions
when trying to stringify expressions
#720
f6e4fe7
Thanks @renovate! - Update dependency
strip-indent to v4
#769
e08e08d
Thanks @danez! - Correctly resolve the values in
an Object.values() call
### Patch Changes - #789 `7c99f15` Thanks @danez! - Fix TypeScript types when strict null checks are disabled
### Patch Changes - #787 `5a226ac` Thanks @danez! - Fix @babel/traverse import to work in non ESM environments
This method might be used by integrations.
#786
0a2481d
Thanks @danez! - Renamed the method toObject to
build in the DocumentationBuilder.
This method might be used by integrations.
#786
0a2481d
Thanks @danez! - Export the type for the
DocumentationBuilder.
#786
0a2481d
Thanks @danez! - The types NodePath and
babelTypes are now exported.
These types are useful when building integrations in TypeScript.
babelTypes includes all types from @babel/types.
dfc2f85: Rename propDocBlockHandler to propDocblockHandler for consistency
propDocBlockHandler to propDocblockHandler for consistencydisplayName and description to Documentation typed7a39af: Refactored resolveComponentDefinition utility.
d7a39af: Refactored resolveComponentDefinition utility.
findComponentDefinitionisComponentDefinitione956802: Remove match utility.
The utility can be replaced by babel helpers and is not needed anymore. Also
using explicit checks like path.isMemberExpression() is better for type
safety and catching potential bugs.
5215bab: Removed support for the @extends React.Component annotation on
react class components.
Instead you can use the new @component annotation.
80e4c74: Renamed and migrated built-in resolvers to classes.
findAllComponentDefinitions was renamed to FindAllDefinitionsResolver
and is now a class.
-const resolver = builtinResolvers.findAllComponentDefinitions
+const resolver = new builtinResolvers.FindAllDefinitionsResolver()
findAllExportedComponentDefinitions was renamed to
FindExportedDefinitionsResolver and is now a class.
-const resolver = builtinResolvers.findAllExportedComponentDefinitions
+const resolver = new builtinResolvers.FindExportedDefinitionsResolver()
findExportedComponentDefinition was removed. Use
FindExportedDefinitionsResolver with the limit option instead.
This is still the default resolver.
-const resolver = builtinResolvers.findExportedComponentDefinition
+const resolver = new builtinResolvers.FindExportedDefinitionsResolver({ limit: 1 })
80e4c74: Add the new ChainResolver which allows multiple resolvers to be chained.
import { builtinResolvers } from 'react-docgen';
const { ChainResolver } = builtinResolvers;
const resolver = new ChainResolver([resolver1, resolver2], {
chainingLogic: ChainResolver.Logic.ALL, // or ChainResolver.Logic.FIRST_FOUND,
});
80e4c74: Allow resolvers to be classes in addition to functions.
import type { ResolverClass, ResolverFunction } from 'react-docgen';
// This was the only option until now
const functionResolver: ResolverFunction = (file: FileState) => {
//needs to return array of found components
};
// This is the new class resolver
class MyResolver implements ResolverClass {
resolve(file: FileState) {
//needs to return array of found components
}
}
const classResolver = new MyResolver();
5215bab: Added a new resolver that finds annotated components. This resolver is also enabled by default.
To use this feature simply annotated a component with @component.
// @component
class MyComponent {}
shape() and exact()
methods.typeof import('...') and typeof MyType.property correctly
in TypeScript96d6e9e: The main parse API had some breaking changes.
96d6e9e: Rename flowTypeHandler to codeTypeHandler because it handles Flow and TypeScript
96d6e9e: Simplify resolveObjectValuesToArray and remove type handling. None of the code that was handling types was actually used.
caae6bf: The return values of resolveObjectValuesToArray are now in the order they are defined in the source code.
96d6e9e: Migrate react-docgen to ES modules. Please read this
3b28f6e: The CLI was removed from react-docgen into its own package @react-docgen/cli.
Check out https://react-docgen.dev/docs/getting-started/cli for the documentation.
96d6e9e: The main parse API had some breaking changes.
The arguments were changed from previously 5 to just 2. Checkout the diff to see how to migrate:
-parse(src, resolver, handlers, importer, options)
+parse(src, { resolver, handlers, importer, filename, babelOptions: {} })
The return type is now always an array, independent of resolver and even if only one component was found in the file.
96d6e9e: Renamed some of the main exports for clarity.
Renamed handlers to builtinHandlers
Renamed resolver to builtinResolvers
Renamed importers to builtinImporters
96d6e9e: Migrated to babel toolchain
This is one of the big changes in this new version of react-docgen. It made the code a lot more robust because there are now finally working TypeScript types for the ASTs.
Another benefit from this change that react-docgen is now a lot faster. 🚀 In some tests an improvement of nearly 50% was seen in comparison to version 5.
d4c27d4: Improve performance of file system importer.
The file system importer now also caches resolving of files in addition to parsing files. If the importer is used in an environment where files do change at runtime (like a watch command) then the caches will need to be cleared on every file change.
96d6e9e: Changed the minimum Node.js version to 14.17.0
96d6e9e: Add support for .cts and .mts extension when using typescript
96d6e9e: Treat functions returning React.Children.map as components
96d6e9e: Improve performance by creating all visitors only once
96d6e9e: Support all possible kinds of functions in the displayNameHandler
96d6e9e: Support all literal types in typescript
96d6e9e: Support flow qualified type names
96d6e9e: Support class and function declarations without identifier
96d6e9e: Support resolving of destructurings in resolveToValue
96d6e9e: Improve performance drastically by making changes to AST traversal
Visitors are now pre-exploded and are cached in the module scope instead of creating them on every call. This change brought the benchmark from 170ops/s to 225ops/sec
96d6e9e: Add codes to errors to be able to easily detect them
There is a new export ERROR_CODES that contains all possible error codes.
The two errors that have codes right now are:
MISSING_DEFINITION: No component found in fileMULTIPLE_DEFINITIONS: Multiple components found in one files96d6e9e: Support handling useImperativeHandle correctly
96d6e9e: Rename flowTypeHandler to codeTypeHandler because it handles Flow
and TypeScript
96d6e9e: Simplify resolveObjectValuesToArray and remove type handling. None
of the code that was handling types was actually used.
caae6bf: The return values of resolveObjectValuesToArray are now in the
order they are defined in the source code.
96d6e9e: Migrate react-docgen to ES modules. Please read this
3b28f6e: The CLI was removed from react-docgen into its own package
@react-docgen/cli.
Check out https://react-docgen.dev/docs/getting-started/cli/ for the documentation.
96d6e9e: Main parse API was changed
The main API changed and now includes only 2 arguments.
-parse(src, resolver, handlers, importer, options)
+parse(src, { resolver, handlers, importer, ... })
96d6e9e: Renamed some of the main exports for clarity.
Renamed handlers to builtinHandlers Renamed resolver to
builtinResolvers Renamed importers to builtinImporters
96d6e9e: Migrated to babel toolchain
This is one of the big changes in this new version of react-docgen. It made the code a lot more robust because there are now finally working TypeScript types for the ASTs.
Another benefit from this change that react-docgen is now a lot faster. 🚀 In some tests an improvement of nearly 50% was seen in comparison to version 5.
d4c27d4: Improve performance of file system importer.
The file system importer now also caches resolving of files in addition to parsing files. If the importer is used in an environment where files do change at runtime (like a watch command) then the caches will need to be cleared on every file change.
96d6e9e: Changed the minimum Node.js version to 14.18.0
96d6e9e: Add support for .cts and .mts extension when using typescript
96d6e9e: Treat functions returning React.Children.map as components
96d6e9e: Improve performance by creating all visitors only once
96d6e9e: Support all possible kinds of functions in the displayNameHandler
96d6e9e: Support all literal types in typescript
96d6e9e: Support flow qualified type names
96d6e9e: Support class and function declarations without identifier
96d6e9e: Support resolving of destructurings in resolveToValue
96d6e9e: Improve performance drastically by making changes to AST traversal
Visitors are now pre-exploded and are cached in the module scope instead of creating them on every call. This change brought the benchmark from 170ops/s to 225ops/sec
96d6e9e: Add codes to errors to be able to easily detect them
There is a new export ERROR_CODES that contains all possible error codes.
The two errors that have codes right now are:
MISSING_DEFINITION: No component found in fileMULTIPLE_DEFINITIONS: Multiple components found in one files96d6e9e: Support handling useImperativeHandle correctly
React.forwardRef calls without a functionisReactComponentMethodCorrectly detect index access types in typescript
Object.value() calls (4fc5b21)_This is a pre-release that is under heavy development. Please report any issues you might encounter here: #579_
This is a pre-release that is under heavy development. Please report any issues you might encounter here: #579
dist. (5f3da8c)
There was no real reason to change this and happened during the TypeScript migration._This is a pre-release that is under heavy development. Please report any issues you might encounter here: #576_
This is a pre-release that is under heavy development. Please report any issues you might encounter here: #576
resolveToValue will not create a MemberExpression for targets ending in destructuring. It will now simply resolve to the Identifier inside the destructuring. Use new helper isDestructuringAssignment to further check this identifier.resolveObjectValuesToArray and resolveObjectKeysToArray return now string[] instead of a NodePath> This version does not yet really have any breaking changes, so for updating from 5.4.0 or 5.4.0-alpha.0 nothing needs to be done. The import-resolvi…
Install with
yarn add react-docgen@next
Includes all commits that are also in 5.4.0.
This version does not yet really have any breaking changes, so for updating from 5.4.0 or 5.4.0-alpha.0 nothing needs to be done. The import-resolving feature is such a big change that it will be released in the next major version, so this is the only change for now in this alpha version. Also to come in 6.0 is a complete rewrite in TypeScript, the removal of the
ast-typesdependency and some more major changes. See #502.
Add support for TSAsExpressions when trying to stringify expressions
Fix wrong detection of forwardRef in combination with memo
Correctly detect index access types in typescript
> This does not include #464. Resolving of imports will be added in 6.0. There is a new 6.0.0-alpha.0 version which includes resolving of imports.
This does not include #464. Resolving of imports will be added in 6.0. There is a new
6.0.0-alpha.0version which includes resolving of imports.
componentMethodsHandler ignores private properties (#440)@babel/generate to serialise AST nodes w/o loc in printValue (#482)Allow resolving of imported types/proptypes
Update ast-types to latest version
Support static methods on function components
forwardRef (#435)displayName given forwardRef node (#436)Support forwardRef with out of line argument
empty type for flow (#431)Support new topLevelAwait plugin in babel parser
skip private methods in Documentation
The license changed to MIT. When updating ensure that MIT is one of the licenses allowed in your project.
Program AST node as first param and recast as second param. The new signature receives the File AST node as first argument and the preconfigured parser as second argument.
resolver(ast: ASTNode, parser: { parse: (string) => AST })@computed#.React.forwardRef (#350).ts, .tsx). If you have babel already setup for TypeScript in your project then all you need to do is supply the filename via the parse options. In the output there will be a new property called tsType which will include the documentation extracted from TypeScript.parse function can now receive a string or a Buffer.handler(documentation: Documentation, path: NodePath, parser: { parse: (string) => AST })The first prerelease of yet another breaking version, but it comes with a lot of nice goodies and three massive changes.
The first prerelease of yet another breaking version, but it comes with a lot of nice goodies and three massive changes.
recast dependency and using babel directly for parsing the code. In our measurements we saw a 20% to 25% performance increase. If you are testing this new prerelease let us now if you see any improvement in your project.And there are more helpful changes to come till the final. Stay tuned.
This release includes all changes up to v4.1.1.
Program AST node as first param and recast as second param. The new signature receives the File AST node as first argument and the preconfigured parser as second argument.
resolver(ast: ASTNode, parser: { parse: (string) => AST })@computed#.React.forwardRef (#350).ts, .tsx). If you have babel already setup for TypeScript in your project then all you need to do is supply the filename via the parse options. In the output there will be a new property called tsType which will include the documentation extracted from TypeScript.parse function can now receive a string or a Buffer.handler(documentation: Documentation, path: NodePath, parser: { parse: (string) => AST })Resolve spread properties in object type
Support all the config resolving related babel options (#334) This allows the new options envName, babelrc, root, rootMode, configFile and babelrcRoot
envName, babelrc, root, rootMode, configFile and babelrcRoots in the programatic API. To see what this options do head over to the babel documentationThanks @jquense.
Support elementType in proptypes correctly
elementType in proptypes correctly (#330)Thanks to @eps1lon for fixing it.
In most cases the automatic pickup of babel configuration files will already be enough to not make this a breaking change. With the new parserOptions…
In this version we focused on allowing our internals to be more flexible when it comes to allowing different configurations for @babel/parser. This will make it easier to introduce support for different javascript flavors (like TypeScript 🎉) in the future.
Thanks to @jquense for working on this changes.
--legacy-decorators and --decorators-before-export. (#327)
As a replacement react-docgen will read your babel config and pickup the correct configuration from there.legacyDecorators and decoratorsBeforeExport. (#327)
This probably will only affect libraries or tools that integrate react-docgen and use the programmatic API. In most cases the automatic pickup of babel configuration files will already be enough to not make this a breaking change. With the new parserOptions option you could still set this configuration, for example: react-docgen.parse(code, null, null, {
- decoratorsBeforeExport: true
+ parserOptions: {
+ plugins: [
+ ["decorators", { decoratorsBeforeExport: true }],
+ ],
+ },
});
@babel/parser we use. This was a necessary step as a lot of recent proposals in babel have configuration options, so we cannot simply activate everything. This change is not breaking unless your babel configuration is broken and does not enable all necessary features (which should throw already in your project).
If you are using react-docgen in the browser, ensure that fs, net and module are correctly mocked, as babel uses them. (see our website configuration)fileName (#320)
This is a new option which gets forwarded to babel in order to pick the correct configuration file. Library and tool authors are strongly recommended to set this option whenever possible. Not setting it might result in no or the wrong babel configuration being picked up.cwd (#320)
This is a new option which gets forwarded to babel in order to pick the correct configuration file. This option is usually autodetected by babel itself using process.cwd().@babel/parser options through the react-docgen API with the newly added option parserOptions. See our README for more information.Add forwardRef as a valid component definition
forwardRef as a valid component definition (#311)$Keys to union when typeParameter is an ObjectTypeAnnotation (#290)PropTypes.exactObject.values() in PropType.oneOf() (#318)babylon@5 to @babel/parser@7. This should not break anything, but will support a lot more newer javascript syntax features as well as newer flow syntaxes.--legacy-decorators or the programmatic options { legacyDecorators: true } passed as 4th parameter to ReactDocgen.parse().#942
c3dfead
Thanks @danez! - Drop support for Node.js 16, 17,
18, 19 and 21.
With this react-docgen version Node.js support is:
Support flow NullLiteralTypeAnnotation node type
The types of method params and return are now the same as the flow types.
react-docgen now parses only the new decorators proposal syntax and not the old one anymore by default. You can switch back to the legacy decorators p
--legacy-decorators or the programmatic options { legacyDecorators: true } passed as 4th parameter to ReactDocgen.parse().@extends React.Component support to mark classes which do not extend from React.Component as valid react components (#269)(merged changes released in `v2.20.0`)
(merged changes released in v2.20.0)
See v2.20.0.
Update babylon to latest beta. This allows a lot new syntax proposal which were added to babylon (see babylon changes)
Enable more babylon plugins (#220)
Enables the following new plugins in babylon:
You can install this version via npm install react-docgen@next.
(cherry picked changes released in `v2.19.0`)
(cherry picked changes released in v2.19.0)
See v2.19.0.
See v2.19.0.
Flow: Function type definitions without parameter names are now supported. For example:
type Props = {
callback: (string) => void,
}
In such a case the parameter name will simply be empty. See the commit ( #218 ) for an example of the output. Thank you @odinuge!
v2.19.0.getMemberValuePath now understands TaggedTemplateExpressions. This is used by @Jmeyering's custom annotation resolver. Check it out at https://github.com/Jmeyering/react-docgen-annotation-resolver ! Thank you @Jmeyering!You can install this version via npm install react-docgen@next.
(cherry picked changes released in `v2.18.0`)
(cherry picked changes released in `v2.17.0`)
(cherry picked changes from v2.16.0)
(cherry picked changes from v2.16.0)
-e, --exclude now accepts a regular expression to filter out files by name: -e /.*-test\.js/ The argument will only be treated as a regular expression if the parameter is only passed once ( #164).You can install this version via npm install react-docgen@next.
@wcjordan added support for the create-react-class module! ( #179 ) (cherry picked) from v2.15.0
create-react-class module! ( #179 ) (cherry picked) from v2.15.0You can install this version via npm install react-docgen@next.
Upgraded to babylon v7.0.0-beta.8
You can install this version via npm install react-docgen@next.
You can install this release via
Upgrade babylon to v7.0-beta.4 ( #165 )
You can install this release via
npm install react-docgen@next
# or
yarn add react-docgen@next
Support for "unwrapping" $Exact<...> and $ReadOnly<...> type annotations. Example:
Support for "unwrapping" $Exact<...> and $ReadOnly<...> type annotations. Example:
type Props = $ReadOnly<{
foo: string,
}>;
Handle Logical and Conditional Expressions
Nothing published for this version
While this a new major version, there shouldn't be any breaking changes. We switched to babylon v7(beta) ( #158 ) internally, which supports most flow…
While this a new major version, there shouldn't be any breaking changes. We switched to babylon v7(beta) ( #158 ) internally, which supports most flow type annotations. It is published as a prerelease so you can test it on your codebase first.
Other changes:
proptypes package is recognized as proptypes definition provider ( #163 ).You can install this release via
npm install react-docgen@next
# or
yarn add react-docgen@next
Also output information about (old) react context usages (#260, #130)
@extends React.Component support to isReactComponentClass (#269)Handle Logical and Conditional Expressions
One column per quarter.