Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds react-docgen-displayname-handler #205

Merged
merged 5 commits into from
Oct 28, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 21 additions & 15 deletions docs/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,27 +163,33 @@ You can change settings in the `styleguide.config.js` file in your project’s r
```

* **`handlers`**<br>
Type: `Array of Function`, optional<br>
Type: `Array of Function`, optional, default: [[react-docgen-displayname-handler](https://github.com/nerdlabs/react-docgen-displayname-handler)]<br>
Array of functions used to process the discovered components and generate documentation objects. Default behaviours include discovering component documentation blocks, prop types, and defaults. If setting this property, it is best to build from the default `react-docgen` handler list, such as in the example below. See the [react-docgen handler documentation](https://github.com/reactjs/react-docgen#handlers) for more information about handlers.

Also note that the default handler, `react-docgen-displayname-handler` should be included to better support higher order components.

```javascript
module.exports = {
// ...
handlers: require('react-docgen').defaultHandlers.concat((documentation, path) => {
// Calculate a display name for components based upon the declared class name.
if (path.value.type === 'ClassDeclaration' && path.value.id.type === 'Identifier') {
documentation.set('displayName', path.value.id.name);

// Calculate the key required to find the component in the module exports
if (path.parentPath.value.type === 'ExportNamedDeclaration') {
documentation.set('path', path.value.id.name);
handlers: require('react-docgen').defaultHandlers.concat(
(documentation, path) => {
// Calculate a display name for components based upon the declared class name.
if (path.value.type === 'ClassDeclaration' && path.value.id.type === 'Identifier') {
documentation.set('displayName', path.value.id.name);

// Calculate the key required to find the component in the module exports
if (path.parentPath.value.type === 'ExportNamedDeclaration') {
documentation.set('path', path.value.id.name);
}
}
}

// The component is the default export
if (path.parentPath.value.type === 'ExportDefaultDeclaration') {
documentation.set('path', 'default');
}
}),
// The component is the default export
if (path.parentPath.value.type === 'ExportDefaultDeclaration') {
documentation.set('path', 'default');
}
},
// To better support higher order components
require('react-docgen-displayname-handler').default,
),
};
```
3 changes: 3 additions & 0 deletions examples/basic/lib/components/WrappedButton/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Enhanced/Decorated components work as well:

<WrappedButton>I'm a wrapped button</WrappedButton>
10 changes: 10 additions & 0 deletions examples/basic/lib/components/WrappedButton/WrappedButton.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.root {
padding: .5em 1.5em;
color: #666;
background-color: #fff;
border: 1px solid currentColor;
border-radius: .3em;
text-align: center;
vertical-align: middle;
cursor: pointer;
}
47 changes: 47 additions & 0 deletions examples/basic/lib/components/WrappedButton/WrappedButton.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
import React, { Component, PropTypes } from 'react';
import s from './WrappedButton.css';


/**
* A button wrapped by a Decorator/Enhancer
*/
const WrappedButton = ({
color,
size,
children,
}) => {
let styles = {
color,
fontSize: WrappedButton.sizes[size],
};

return (
<button className={s.root} style={styles}>{children}</button>
);
};
WrappedButton.propTypes = {
/**
* Button label.
*/
children: PropTypes.string.isRequired,
color: PropTypes.string,
size: PropTypes.oneOf(['small', 'normal', 'large']),
};
WrappedButton.defaultProps = {
color: '#333',
size: 'normal',
};
WrappedButton.sizes = {
small: '10px',
normal: '14px',
large: '18px',
};


const Decorator = Composed => class MyHOC extends Component {
render() {
return <Composed {...this.props} />;
}
};

export default Decorator(WrappedButton);
1 change: 1 addition & 0 deletions examples/basic/lib/components/WrappedButton/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export { default } from './WrappedButton.js';
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
"prettyjson": "1.1.3",
"react-codemirror": "0.2.6",
"react-docgen": "2.12.1",
"react-docgen-displayname-handler": "1.0.0",
"react-group": "^1.0.0",
"remark": "~6.0.1",
"remark-parse": "~2.0.2",
Expand Down
4 changes: 4 additions & 0 deletions scripts/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ const merge = require('lodash/merge');
const utils = require('./utils/utils');
const consts = require('./consts');
const StyleguidistError = require('./utils/error');
const displayNameHandler = require('react-docgen-displayname-handler').default;

const CONFIG_FILENAME = 'styleguide.config.js';
const DEFAULT_CONFIG = {
Expand All @@ -30,6 +31,9 @@ const DEFAULT_CONFIG = {
getExampleFilename: componentpath => path.join(path.dirname(componentpath), 'Readme.md'),
getComponentPathLine: componentpath => componentpath,
updateWebpackConfig: null,
handlers: [
displayNameHandler,
],
};
const DEPENDENCIES = [
{
Expand Down