Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/storybookjs/babel-plugin-react-docgen
📝 Babel plugin to add react-docgen info into your code.
https://github.com/storybookjs/babel-plugin-react-docgen
babel-plugin doc-gen docgen-info proptypes react storybook
Last synced: 6 days ago
JSON representation
📝 Babel plugin to add react-docgen info into your code.
- Host: GitHub
- URL: https://github.com/storybookjs/babel-plugin-react-docgen
- Owner: storybookjs
- License: mit
- Created: 2016-10-06T12:18:15.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-08-13T06:37:48.000Z (about 1 year ago)
- Last Synced: 2024-04-13T21:44:24.081Z (7 months ago)
- Topics: babel-plugin, doc-gen, docgen-info, proptypes, react, storybook
- Language: JavaScript
- Homepage:
- Size: 634 KB
- Stars: 162
- Watchers: 57
- Forks: 67
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome - babel-plugin-react-docgen - 📝 Babel plugin to add react-docgen info into your code. (JavaScript)
README
# babel-plugin-react-docgen
[react-docgen](https://github.com/reactjs/react-docgen) allows you to write propType descriptions, class descriptions and access propType metadata programatically.
This babel plugin allow you to access those information right inside your React class.
For an example, let's say you've a React class like this:
```js
/**
This is an awesome looking button for React.
*/
import React from 'react';
export default class Button extends React.Component {
render() {
const { label, onClick } = this.props;
return (
{ label }
);
}
}
Button.propTypes = {
/**
Label for the button.
*/
label: React.PropTypes.string,
/**
Triggered when clicked on the button.
*/
onClick: React.PropTypes.func,
};
```
With this babel plugin, you can access all these information right inside your app with:
```js
console.log(Button.__docgenInfo);
```
Click to see the output
```js
{
description: 'This is an awesome looking button for React.',
props: {
label: {
type: {
name: 'string'
},
required: false,
description: 'Label for the button.'
},
onClick: {
type: {
name: 'func'
},
required: false,
description: 'Triggered when clicked on the button.'
}
}
}
```
This will be pretty useful for documentations and some other React devtools like [Storybook](https://github.com/kadirahq/react-storybook).
## Usage
Install the plugin:
```sh
npm install -D babel-plugin-react-docgen
```
Use it inside your `.babelrc`
```json
{
"plugins": ["react-docgen"]
}
```
## .babelrc Options
| option | description | default |
| --- | --- | --- |
| resolver | You may use the 3 built-in [react-docgen resolvers](https://github.com/reactjs/react-docgen#resolver-1) by specifying its name as a `string`, or you may specify a custom resolver by specifying the function explicitly. | ```"findAllExportedComponentDefinition"``` |
| handlers | All [react-docgen handlers](https://github.com/reactjs/react-docgen#handlers-1) are automatically applied. However, custom handlers can be added by specifying them here. Any `string` value will be loaded by `require`, and a `function` will be used directly. | |
| removeMethods | Used to remove docgen information about methods. | ```false``` |
| DOC_GEN_COLLECTION_NAME | The name of a global variable where all docgen information can be stored. See [below](#collect-all-docgen-info) for more information. | |
| ...options | Remaining options will be passed directly as [react-docgen options](https://github.com/reactjs/react-docgen#options). Any options they allowed will be passed through, but the `filename` will be overwritten by the filename provided by babel. | |
## Collect All Docgen Info
Sometimes, it's a pretty good idea to collect all of the docgen info into a collection. Then you could use that to render style guide or similar.
So, we allow you to collect all the docgen info into a global collection. To do that, add following config to when loading this babel plugin:
```js
{
"plugins":[
[
"babel-plugin-react-docgen",
{
"DOC_GEN_COLLECTION_NAME": "MY_REACT_DOCS",
"resolver": "findAllComponentDefinitions", // optional (default: findAllExportedComponentDefinitions)
"removeMethods": true, // optional (default: false)
"handlers": ["react-docgen-deprecation-handler"] // optional array of custom handlers
}
]
]
}
```
Then you need to create a global variable(an object) in your app called `MY_REACT_DOCS` before any code get's executed.
Then we'll save them into that object. We do it by adding a code block like this to the transpiled file:
```js
if (typeof MY_REACT_DOCS !== 'undefined') {
MY_REACT_DOCS['test/fixtures/case4/actual.js'] = {
name: 'Button',
docgenInfo: Button.__docgenInfo,
path: 'path/to/my/button.js'
};
}
```
## Compile Performance
We parse your code with `react-docgen` to get this info, but we only do it for files which contain a React component.
There will be some overhead to your project, but you can leverage [babel's cache directory](http://stackoverflow.com/a/30384710) to avoid this a huge performance hit.
## Output Size
Yes this increase the output size of your transpiled files. The size increase varies depending on various factors like:
* How many react classes you've
* Amount of docs you've written
* Amount of propTypes you've
Most of the time, you need this plugin when you are developing your app or with another tool like [Storybook](https://github.com/kadirahq/react-storybook). So, you may not need to use this on the production version of your app.