No support for components that directly return `null`

Open
#926 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
react, typescript
Domain
documentation, tooling

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.

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;
};
Dominant language
TypeScript
Stars
3.8k
Forks
316
Avg merge
3h 28m
Merged PRs (30d)
6

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from reactjs/react-docgen

All issues in reactjs/react-docgen

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.