react-docgen
react-docgen copied to clipboard
reactjs
A CLI and library to extract information from React component files for documentation generation purposes.
The default arrays like https://github.com/reactjs/react-docgen/blob/e05219b08c8b17899be812a521b4985f2b66fae2/bin/react-docgen.js#L34 can only be appended to, not replaced, by passing values on the CLI. This is most consequential for the one that I linked, as it's...
The underlying node-dir library that consumes the --exclude pattern takes a regex or an array of string literals to match against: https://github.com/fshost/node-dir/blob/a57c3b1b571dd91f464ae398090ba40f64ba38a2/lib/readfiles.js#L22-L31 When passing that arg multiple times, I had...
In our component library, a lot of comments are historically made on `defaultProps` not on `propTypes`. It would be nice if react-docgen could catch them as well
Hi,react-docgen does't recognize description for oneOf enum value.Sometimes enum value will make people so confused.It's good to show the comment in description. ## Example Component ```jsx import React, { Component...
## Example Component ```js import React from 'react' import PropTypes from 'prop-types' import { DEFAULT_NAME_1, DEFAULT_NAME_2 } from './constants' export default class ExampleComponent extends React.Component { render() { return Hello...
I use command: ``` react-docgen lib --extension [tsx,jsx] -o dist/foundation.doc.json ``` But it is not able to exclude *.js files. [email protected]
It looks like even if I have a resolver that resolves to components that use tagged templates like styled-components, the type annotations aren't extracted. Consider the following example: ```ts import...
For webpack project, using the react-docgen cause compiling errors because fs is not available in browser environment. I have to add: ```js { node: { fs: 'empty' } } ```
Babel should be defined as peer dependencies so one version is pulled into a module at the root level.
**Current behavior** Components that return an array lead to the following error (via [react-styleguidist](https://github.com/styleguidist/react-styleguidist)): `Warning: some/folder/index.jsx matches a pattern defined in “components” or “sections” options in your style guide config...
