Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs] Add custom default props handler (#15473)
* [docs] Add custom defaultPropsHandler * WIP defaultProps removal Early commit to see bundle size impact. * continue * and now to the tricky bit * [Grid] Resolve default props in destructuring Removes some default values that served no purpose * [GridListTile] Disable eslint for docs * [CssBaseline] Use es5 syntax * get the Grid default values back * Upgrade react-docgen * Use react-docgen v5 beta * cleanup lockfile
- Loading branch information
Showing
99 changed files
with
590 additions
and
848 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| import astTypes from 'ast-types'; | ||
| import { utils as docgenUtils } from 'react-docgen'; | ||
|
|
||
| const { getPropertyName, isReactForwardRefCall, printValue, resolveToValue } = docgenUtils; | ||
|
|
||
| // based on https://github.com/reactjs/react-docgen/blob/735f39ef784312f4c0e740d4bfb812f0a7acd3d5/src/handlers/defaultPropsHandler.js#L1-L112 | ||
| // adjusted for material-ui getThemedProps | ||
|
|
||
| const { namedTypes: types } = astTypes; | ||
|
|
||
| function getDefaultValue(path) { | ||
| let node = path.node; | ||
| let defaultValue; | ||
| if (types.Literal.check(node)) { | ||
| defaultValue = node.raw; | ||
| } else { | ||
| if (types.AssignmentPattern.check(path.node)) { | ||
| path = resolveToValue(path.get('right')); | ||
| } else { | ||
| path = resolveToValue(path); | ||
| } | ||
| if (types.ImportDeclaration.check(path.node)) { | ||
| defaultValue = node.name; | ||
| } else { | ||
| node = path.node; | ||
| defaultValue = printValue(path); | ||
| } | ||
| } | ||
| if (typeof defaultValue !== 'undefined') { | ||
| return { | ||
| value: defaultValue, | ||
| computed: | ||
| types.CallExpression.check(node) || | ||
| types.MemberExpression.check(node) || | ||
| types.Identifier.check(node), | ||
| }; | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| function getDefaultValuesFromProps(properties, documentation) { | ||
| properties | ||
| .filter(propertyPath => types.Property.check(propertyPath.node)) | ||
| // Don't evaluate property if component is functional and the node is not an AssignmentPattern | ||
| .filter(propertyPath => types.AssignmentPattern.check(propertyPath.get('value').node)) | ||
| .forEach(propertyPath => { | ||
| const propName = getPropertyName(propertyPath); | ||
| if (!propName) return; | ||
|
|
||
| const propDescriptor = documentation.getPropDescriptor(propName); | ||
| const defaultValue = getDefaultValue(propertyPath.get('value', 'right')); | ||
| if (defaultValue) { | ||
| propDescriptor.defaultValue = defaultValue; | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| function getRenderBody(componentDefinition) { | ||
| const value = resolveToValue(componentDefinition); | ||
| if (isReactForwardRefCall(value)) { | ||
| return value.get('arguments', 0, 'body', 'body'); | ||
| } | ||
| return value.get('body', 'body'); | ||
| } | ||
|
|
||
| function getPropsPath(functionBody) { | ||
| let propsPath; | ||
| // visitVariableDeclarator, can't use visit body.node since it looses scope information | ||
| functionBody | ||
| .filter(path => { | ||
| return types.VariableDeclaration.check(path.node); | ||
| }) | ||
| .forEach(path => { | ||
| const declaratorPath = path.get('declarations', 0); | ||
| if (declaratorPath.get('init', 'name').value === 'props') { | ||
| propsPath = declaratorPath.get('id'); | ||
| } | ||
| }); | ||
|
|
||
| return propsPath; | ||
| } | ||
|
|
||
| export default function defaultPropsHandler(documentation, componentDefinition) { | ||
| const renderBody = getRenderBody(componentDefinition); | ||
| const props = getPropsPath(renderBody); | ||
| if (props !== undefined) { | ||
| getDefaultValuesFromProps(props.get('properties'), documentation); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.