reactjs / reactjs/react-docgen

Typescript: Component declaration reference is not recognized by parser

Open
#898 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

typescript
Dominant language
TypeScript
Stars
3.8k
Forks
316
Avg merge
5h 7m
Merged PRs (30d)
4

Description

Description

Many Typescript libraries publish types in declaration files (.d.ts) alongside their associated .js bundles. In .d.ts files generated through TS compilation, function types are often defined using declaration references, such as:

declare const MyComponent: React.FunctionComponent<ComponentProps>;

Currently declaration references are not recognized by reactDocgen.parse(). When react-docgen parses a .d.ts file with a single declaration reference, it emits an error: Error: No suitable component definition found..

Desired Behavior

The following code:

import * as React from 'react';

interface ComponentProps {
  foo: string;
}

/**
 * My component is so darn cool!
 */
const Component1: React.FunctionComponent<ComponentProps> = () => <div />;

/**
 * Mine too!
 */
declare const Component2: React.FunctionComponent<ComponentProps>;

Results in the following output:

[
  {
    "description": "My component is so darn cool!",
    "displayName": "Component1",
    "methods": [],
    "props": {
      "foo": {
        "required": true,
        "tsType": {
          "name": "string"
        },
        "description": ""
      }
    }
  },
  {
    "description": "Mine too!",
    "displayName": "Component2",
    "methods": [],
    "props": {
      "foo": {
        "required": true,
        "tsType": {
          "name": "string"
        },
        "description": ""
      }
    }
  }
]

Actual Behavior

The same code results in the following output:

[
  {
    "description": "My component is so darn cool!",
    "displayName": "Component1",
    "methods": [],
    "props": {
      "foo": {
        "required": true,
        "tsType": {
          "name": "string"
        },
        "description": ""
      }
    }
  }
]

Steps to Reproduce

Paste the .tsx sample code from the "Expected Behavior" section into the react-docgen playground with Language set to Typescript.

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.

Research direction

Start by reproducing the issue in the react-docgen playground with Language set to Typescript, using the .tsx sample and calling reactDocgen.parse() on the declaration reference. Trace the parser entry point for .d.ts declarations and compare the result with the expected output, where Component2 is included with its description, displayName, methods, and props.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
devtools
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.