Mo support for typescript intersection and parenthesized types #914
Description
I wish this project would just use typescript to parse typescript as the old project react-docgen-typescript did. Why? Because we try to upgrade our design-system to use this new package "react-docgen" but we're already missing some core features.
A union type definition like the following is not parsed correctly:
type ButtonVariant = "standard" | "primary";
type ButtonWithChildren = {
children: ReactNode;
icon?: ReactNode;
};
type ButtonWithIconOnly = {
children?: never;
icon: ReactNode;
};
export type ButtonProps = {
className?: string;
variant?: ButtonVariant;
} & (ButtonWithChildren | ButtonWithIconOnly);
export const RegularFunctionComponent: FunctionComponent<ButtonProps> = (
props,
) => <div>Just a regular component</div>;Result
{
"RegularFunctionComponent": {
"description": "",
"displayName": "RegularFunctionComponent",
"methods": [],
"props": {
"className": {
"required": false,
"tsType": {
"name": "string"
},
"description": ""
},
"variant": {
"required": false,
"tsType": {
"name": "union",
"raw": "\"standard\" | \"primary\"",
"elements": [
{
"name": "literal",
"value": "\"standard\""
},
{
"name": "literal",
"value": "\"primary\""
}
]
},
"description": ""
}
},
"path": "blocks/styled-resolver/test/testComponents.tsx"
}
}The two props "children" and "icon" are missing in the result. Parsing the same thing with react-docgen-typescript would indeed find the two props, so i would expect the following output:
Expected
{
"RegularFunctionComponent": {
"description": "",
"displayName": "RegularFunctionComponent",
"methods": [],
"props": {
"children": {
"required": false,
"tsType": {
"name": "ReactNode"
},
"description": ""
},
"icon": {
"required": false,
"tsType": {
"name": "ReactNode"
},
"description": ""
},
"className": {
"required": false,
"tsType": {
"name": "string"
},
"description": ""
},
"variant": {
"required": false,
"tsType": {
"name": "union",
"raw": "\"standard\" | \"primary\"",
"elements": [
{
"name": "literal",
"value": "\"standard\""
},
{
"name": "literal",
"value": "\"primary\""
}
]
},
"description": ""
}
},
"path": "blocks/styled-resolver/test/testComponents.tsx"
}
}But i'm also wondering why the official babel parser typescript plugin can't handle that case?
Update: A short test with babel parser itselfs shows me that babel indeed is parsing this case correctly and all information would be available to produce the expected result. It is just not implemented in this package.
Update 2: I'm working on a PR and it seems to be quite promising - the complex intersection case with multiple interfaces is working now, i had to modify the "handleTSIntersectionType" function and add the missing "handleTSParenthesizedType". Now only the types are getting in my way and i destroyed some existing cases with intersection.... still working on it, hopefully next week i can present a fix :)