Add more information about parent declaration

[opcode0x]

Summary

As a developer I would like to have extended information about property type declaration. As some of props could be described as an inheritance of types in node_modules it's impossible to opt in such props in propFilter function and opt out all the props from node_modules.

Example

import { FC, PropsWithRef } from 'react';

type HTMLButtonProps = JSX.IntrinsicElements['button'];

type Props = HTMLButtonProps & {
  /** onClick event handler */
  onClick?: HTMLButtonProps['onClick'];
};

const ButtonWithOnClickComponent: FC<Props> = props => {
  return <button {...props} />;
};

export default ButtonWithOnClickComponent;

Current version of react-docgen-typescript will generate next prop description

{
   onClick: {
     // ... 
    parent: {
        fileName: "node_modules/@types/react/index.d.ts",
        // ...
    }
  }
}

Proposal

Provide an ability to retrieve all the parent declarations of prop. I have specified an additional parents field to the prop declaration that exposes all the Node declarations that typescript handles.

[opcode0x]

@pvasek Hello, could you give feedback, please?

[pvasek]

In general, it seems to be fine. The main issue is that there is no example of what to expect in parents.

[opcode0x]

@pvasek I've updated PR