reactjs / reactjs/react-docgen
No support for components that directly return `null`
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.8k
- Forks
- 316
- Avg merge
- 5h 7m
- Merged PRs (30d)
- 4
Description
If a component directly returns null like this:
export const DataTableColumnDocs: FunctionComponent<
IDataTableColumn<object>
> = () => {
return null;
};
Then it won't find any interface to parse. The same behavior can be seen when a component directly returns a prop like so:
export const AuthenticatedBoundary = ({
children,
fallback,
}: AuthenticatedBoundaryProps) => {
const { isLoggedIn } = useAuthentication();
if (!isLoggedIn) {
return fallback;
}
return children;
};
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the component-parsing entry point and existing tests for components whose return value is inspected. Add regression coverage for components returning null and props directly, then verify the parser still extracts their declared interfaces and prop information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100