react-docgen-typescript

A simple parser for react properties defined in typescript instead of propTypes.

MIT License

Downloads
18.8M
Stars
1.2K
Committers
84

Bot releases are hidden (Show)

react-docgen-typescript - v2.2.2 Latest Release

Published by pvasek almost 3 years ago

  • fix: trimFileName no longer works in a monorepo (#404) thanks to @ecraig12345 PR #405
react-docgen-typescript - v2.2.1

Published by pvasek almost 3 years ago

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

Published by pvasek about 3 years ago

  • better TS error reporting - thanks @mmomtchev PR #390
  • follow symbol aliases also for named exports - thanks @rihardsgravis PR #387
react-docgen-typescript - v2.1.0

Published by pvasek about 3 years ago

  • 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
react-docgen-typescript - v2.0.0

Published by pvasek over 3 years ago

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
react-docgen-typescript - v1.22.0

Published by pvasek over 3 years ago

  • 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
react-docgen-typescript - v1.21.0

Published by pvasek over 3 years ago

  • 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
react-docgen-typescript - v1.20.5

Published by pvasek about 4 years ago

  • 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
react-docgen-typescript - v1.20.4

Published by pvasek about 4 years ago

  • fix jsDoc visibleName support thanks to @hipstersmoothie PR #289
react-docgen-typescript - v1.20.3

Published by pvasek about 4 years ago

  • 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
react-docgen-typescript - v1.20.2

Published by pvasek about 4 years ago

  • 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
react-docgen-typescript - v1.20.1

Published by pvasek about 4 years ago

  • fix - Cannot read property 'getSourceFile' of undefined thanks to @buhichan PR 276
react-docgen-typescript - v1.20.0

Published by pvasek about 4 years ago

  • 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
react-docgen-typescript - v1.18.0

Published by pvasek over 4 years ago

  • feat: adds the ability to generate docs for static sub-components - thanks to @hipstersmoothie PR #265
react-docgen-typescript - v1.17.1

Published by pvasek over 4 years ago

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

Published by pvasek over 4 years ago

  • Added shouldExtractValuesFromUnion option - thanks to @hipstersmoothie PR #261
react-docgen-typescript - v1.16.6

Published by pvasek over 4 years ago

  • feat: allow jsdoc @type to override a prop's type - thanks to @CyriacBr PR #258
react-docgen-typescript - v1.16.5

Published by pvasek over 4 years ago

  • 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
react-docgen-typescript - v1.16.4

Published by pvasek over 4 years ago

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

react-docgen-typescript - v1.16.3

Published by pvasek over 4 years ago

  • fix for #203 - thanks to @hipstersmoothie and his PR #241
Package Rankings
Top 0.87% on Npmjs.org
Badges
Extracted from project README
Build Status