react-docgen-typescript

• fix: trimFileName no longer works in a monorepo (#404) thanks to @ecraig12345 PR #405

• component raw typescript expression as part of the ComponentDoc.expression - thanks to @TrevorBurnham #398
• fixed type for ComponentDoc - thanks to @jt-stripe PR #399

• better TS error reporting - thanks @mmomtchev PR #390
• follow symbol aliases also for named exports - thanks @rihardsgravis PR #387

• feature: parse displayName for stateless components - thanks to @roddds PR #368
• feature: get comment info for union type - thanks to @ron0115 PR #376
• fix: resolving imported defaultProps @DarkGenius PR #379

As we started to use a function that is available from typescript 4.3 we are forced to bump the major version.

• feature: Adding filePath to parser results - thanks to @fforres PR #343
• fix: TypeError: (tag.text || "").trim is not a function #356 - thanks to @michelengelen PR #360
• fix: shouldRemoveUndefinedFromOptional in TypeScript strict mode #341 - thanks to @shilman PR #361
• fix: Cannot read property 'length' of undefined #363 - thanks to @hazem3500 PR #364

• feature: more accurate determination of enumeration type and return the expected enumeration value - thanks to @angular-moon PR #325
• feature: added tags for props to serialization - thanks to @carmnk PR #328
• feature: add an ability to extend component types by option field - thanks to @ypanyukov PR #333
• feature: parse default values in immediately destructured props - thanks to @michelengelen PR #338

• feature: Inferring type from constrained generics - thanks to @Muritavo PR #318
• feature: Add more information about parent declaration - thanks to @appbak3r PR #312
• feature: Add tags to ComponentDoc - thanks to @rohantalkad747 PR #307

• fix: fix when initializer is undefined - thanks to @SimplyY PR #303
• fix: fixed declarations.length is undefined - thanks to @careteenL PR #291
• fix: Export defaultOptions from parser - thanks to @AndrewLeedham PR #299

• fix jsDoc visibleName support thanks to @hipstersmoothie PR #289

• fix docgen for default exports wrapped in React.memo or React.forwardRef - thanks to @hipstersmoothie PR #288
• follow default props that are PropertyAccessExpressions - thanks to @hipstersmoothie PR #286

• use just the description for JSDoc comment instead of full comment - thanks to @hipstersmoothie PR #283
• respect base apparentProperties in unions - thanks to @hipstersmoothie PR #272

• fix - Cannot read property 'getSourceFile' of undefined thanks to @buhichan PR 276

• handle complex generic props - thanks to @hipstersmoothie PR #268
• added ability to handle more complex union types - thanks to @davidlindley PR #269
• Added filter to remove same name components - thanks to @davidlindley PR #270
• Read default prop values from inside a forwardRef - thanks to @Tigge PR #271

• feat: adds the ability to generate docs for static sub-components - thanks to @hipstersmoothie PR #265

• fix: Components using React.forwardRef get the name ForwardRefExoticComponent (#215) - thanks to @hipstersmoothie PR #263

• Added shouldExtractValuesFromUnion option - thanks to @hipstersmoothie PR #261

• feat: allow jsdoc @type to override a prop's type - thanks to @CyriacBr PR #258

• fixes: #176 Incorrectly parse props with several named exports and consts - thanks to @hipstersmoothie and his PR #253
• fix parse error for export default interface - thanks to @ddelbondio and his PR #257

Lot of fixes by @hipstersmoothie!

Fixed #158 Intersection types are not documented #57 Support for Union types #243 Default props are null when functional component is a declaration #246 Can't parse union type of component when exported as default #245 typescript added as peer dependency

Partially fixed #68 Union types cannot be documented

• fix for #203 - thanks to @hipstersmoothie and his PR #241

• fix for #179 Problem with export default and pure styled-components - thanks to @Lazyuki PR #234

Fix @default jsdoc annotation with no description being ignored (#73) thanks to @squah-u and his PR #230

• Сhange the default value when getting literal value PR #219 by @Hooked74
• Upgrading typescript to 3.7.2 breaks builds (#220) PR #221 by @irvelervel

• fix: defensive get function statement initializer #207 - PR #208 by @gabrielberlanda
• fix: name variable check to avoid build fail - PR #209 by @alireza-mh
• fix: cannot read property 'filter' of undefined #213 - PR #2014 by @unzico
• Fix broken unit test in windows - PR #216 by @malcolm-kee

• fix: the default params are parsed properly - thanks to @evless and his PR #210 The minor version has been change as this can be seen also as a new feature.

• fix: props which values are defined in defaultProps are marked as required anyway - thanks to @hipstersmoothie and his PR #205

• extract literal values from enums (PR #201 thanks to @nekitk)

fix: Docgen of defaulted properties in a SFC #154 - thanks to @nekitk and his PR #200

• no changes in the library itself, just fixes in package.json to fix #185

fix: support for styled components v4 #179 (PR: #181)

• Fix for filename -> js identifier conversion has broken conversion #167 thanks to @RoystonS and his PR #168

• fix: failing if component names are not js identifiers - thanks to @Diokuz and his PR #157
• fix: #134 Give a better error message when using a custom tsconfig with an invalid include path by PR #156

• fix exportName for functional components
• fix commentSource missing component types

thanks to @BeroBurny and his PR #153

• support for method documentation - big thanks to @BenLorantfy and his PR #145

• component name and description is extracted even when no props are present - thanks to @fabioelia and his PR #142

• Fix comments with \r\n breaking on runtime - thanks to @JoaoMosmann and his PR #136
• Determine parent fileNames relative to the current directory - thanks to @thomascmost and his PR #138
• Fix enum default values - thanks to @veiko and her PR #139
• Exports for Parser thanks to @mutsys and his PR #140

• exporting getDefaultExportForFile - thanks to @ bebraw and his PR #130

• fix #123 styleguidist warnings caused by crash of react-docgen-typescript- thanks to @bebraw and his PR #125
• possibility to define component names - thanks to @bebraw and his PR #127

• fix for #121 - The example code don't work
• fix for #120 - programProvider is not a function
• fix for #92 - console.log causes TypeError in parser

• possibility to pass factory method that creates instance of TS program class - thanks to @strothj and his PR #119

• Allow filtering by parent interface or type declaration - thanks to @rkostrzewski and his PR #111

• Some components showing up as "Requireable" #106 - fixed thanks to @milesj and his PR #110

• additional exports added to support easier integrations with other project (thanks to @strothj and his PR #104)

• support shorthand default props (thanks to @milesj and his PR #99)

• parse can be called with multiple source file paths (thanks to @marionebl PR #91)
• upgraded typescript version and fixed parsing comment problem (thanks to @kbukum PR #97)

This is @milesj release. Thanks for that!

• feat: folder name as a fallback for component name if file is index.tsx (@milesj PR #88)
• fix: parser fails for defaultProps that use spreading syntax (@milesj PR #89)

• use displayName as default component name (thanks to @argshook for his PR #87)

• improving default props for stateless components (thanks to @chrisalbert for his PR #84)
• improving tsconfig parsing fix for #83 (thanks to @yoiang for his PR #85)

• default props doesn't work if they are not defined in place (thanks to @argshook for his PR #80)

• extracting default props from stateless components (thanks to @ asilgag for his PR #78)

Type information added to package.json

Correct name for stateless components.

Thanks to @skeate and his #76 PR. This release closes issue about wrong names for stateless components #74.

Custom tsconfig.json can include comments.

Thanks to @eps1lon and his PR #75, the parsing of tsconfig.json uses the same code as the typescript itself. This enables to use whatever is allowed in typescript configuration as comments for example.

Default values as numbers are not parsed.

Fix for #62