react-docgen

New

• @wcjordan added support for the create-react-class module! ( #179 ) (cherry picked) from v2.15.0

You can install this version via npm install react-docgen@next.

New

• @wcjordan added support for the create-react-class module! ( #179 )

Fixed

• Revert Babel setting changes ( #174 , #175 , @danez )

• Upgraded to babylon v7.0.0-beta.8
• Cherry-picked some changes released with v2.14.0
  • 34ab2aef215e2c557a25e952540ed868334dd349
  • d19d73d064cfa804157aa5afe979ba9e1ef8f6cb
  • 51e0938d06b092a09b79b0da87afff02cc322508

You can install this version via npm install react-docgen@next.

New

• Added support for developit/proptypes ( #163, @eduardoboucas) and prop-types ( #172, @sawyerh) packages.
• Recognize functions calling React.Children.only as React components ( #169, @damian )

Improvement

• Ignore coverage/ folder when publishing to npm, reducing package size by more than 50%! ( #166, @fabiosantoscode )

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

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:

• The 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

New / changed

• Ignore __mocks__ directories by default (#135) (@aitherios)
• Recognized functions that call React.cloneElement as stateless components (#138) (@khankuan)

Fixes

• Infinite loop issue with MemberExpressions inside stateless components ( #136, #139, #143 ) (@tchon, @danez)
• Crash when a SpreadProperty is used in shape propTypes (#145) (@arktes)

Internal changes

• Switched from nomnom to commander.js (#142) (@withinboredom)

Fixed

• Fixed an issue where props without default value would be reported as having computed default values. This only affected stateless components. Reported by @arunoda in #131 and fixed by @CompuIves in #132.

New

• Support for objectOf prop type (86b167f) (reported as #74)
• Treat default arguments as default props in stateless components ( #108, @CompuIves)

Improved

• When passing an unknown value to shape(...), react-docgen will now report that value as computed.

  Example: shape(Child.propTypes)
  Before:

  "type": {
    "name": "shape",
    "value": "unkown"
  }
  

  Now:

  "type": {
    "name": "shape",
    "value": "Child.propTypes",
    "computed": true
  }
  

  (eb0edaa) (reported as #87)

• Resolve static values passed to oneOf. Examples:

  React.PropTypes.oneOf([TYPES.FOO, TYPES.BAR]);
  // or:
  var TYPES = ["FOO", "BAR"];
  React.PropTypes.oneOf(TYPES);
  // or:
  var TYPES = ["A", "B"];
  var MORE = [...TYPES, "C"];
  React.PropTypes.oneOf(MORE);
  

  (#122, @ZauberNerd)

Fixed

• Fixed an issue with the output of react-docgen being truncated when piping to another command (#127, @mmeineke)

New

Detect exported components passed to HOCs

Until now, react-docgen didn’t find components that are passed to a higher order component (HOC):

function MyComponent() { /* ... */ }
export default hoc(MyComponent);

The workaround was to change the resolver to find all component definitions in the file, something that is not always desirable.

With #124, @rtsao extended the default resolver to be able to handle these cases.

Fixes

• findAllExportedComponentDefinitions can now be selected in the CLI.
  (reported as issue #119)

• The static variable resolution process was fixed to consider assignments to variables. The following example didn’t work before and works now:

  var Component;
  Component = React.createClass(...);
  module.exports = Component;
  

  (reported as issue #58)

• The display name handler now takes displayName getters in class definitions into account:

  class Component extends React.Component {
    static get displayName() {
      return 'Name';
    }
  }
  

  (reported as issue #61)

Internal improvements

To guard ourselves better against regressions, we are using jest’s snapshot tests to test component definitions that are reported as broken.

New

• New findAllExportedComponentDefinitions resolver. As the name suggests, it finds all exported component definitions. This complements the resolvers for finding all component definitions and the default exported definition ( #114, @ZauberNerd )
• New CLI option: -e, --exclude PATTERN, allows you to skip files that match the provided pattern ( #102, @wallaroo )

Fixed / improved

• Currently resolve namespace imports to their module ( #109, @ZauberNerd )
• Resolve MemberExpressions (such as propTypes of a stateless component) to the correct object ( #111, @ZauberNerd )
• Handle intersection and union flow types for prop types definitions. Intersection types are supported, union types are silently ignored. Before react-docgen would throw an error. ( #118, @danez )
• If a default prop value references an imported value, the value of the prop will now be the variable name ( #99 , @nathanmarks )
• The jsdoc type declarations @param {x|y} and @param {*} now correctly resolve to their equivalent flow type declarations (union and mixed). ( #95 , @dickeylth )

Thanks to everyone who contributed, this is great!

Fixed

• Handling of optional JSDoc types ( @caabernathy , #89 )

New: Type aliases and optional method parameter flag

@caabernathy added new information to method parameters ( #83 ). If the parameter has a flow type, the name of the type is no also included. I.e. if the type definition is:

export type StatusBarStyle = $Enum<{
     ...
}

the docs for a parameter of that type will include alias: "StatusBarStyle".

In addition the docs now include an optional field indicating whether the parameter is optional or nor.

Fix/Improvement

• Better handling of method parameters ( #72 )

I believe publishing 2.8.0 to npm didn't work properly, so this just to ensure that there is a working version in npm.

No changes in this release.

New

@janicduplessis added support for extracting documentation about custom React component methods ( #66 ).

New

This version adds a great new feature: Support for Flow type definitions. Thanks a lot to @danez for implementing this feature ( #48 ).

react-docgen is now able to extract type definitions as in this example:

import React, { Component } from 'react';

type Props = {
  /** Description of prop "foo". */
  primitive: number,
  /** Description of prop "bar". */
  literalsAndUnion: 'string' | 'otherstring' | number,
  arr: Array<any>,
  func?: (value: string) => void,
  obj?: { subvalue: ?boolean },
};

/**
 * General component description.
 */
export default class MyComponent extends Component<void, Props, void> {

  props: Props;

  render(): ?ReactElement {
    // ...
  }
}

In the JSON output, every prop will have a new field named flowType. If you use both, flow (for static type checks) and React propTypes (for dynamic type checks) you can do so without any collisions. The JSON blob now simply contains more information and you can decide which one to use for your documentation.

Have a look at the more extensive description in the README to learn how flow types are represented.

Fixes

• propTypeHandler now ignores nodes that are not ObjectExpressions. If there was something else, e.g.

  propTypes: Foo.bar,
  

  propTypeHandler used to throw an error.

Fixes

• Fixed docblock parsing for stateless named functions (function declarations) used as default exports ( #51, 0b8546acf1e52e73093696e45afd4947c83ece32 ).