Addon-docs: Move to react-docgen for typescript prop tables

[shilman]

We currently use react-docgen for JS prop tables and react-typescript-docgen-loader (RDTL) for TS prop tables. Now that react-docgen supports Typescript natively, let's simplify our lives and our users' configurations by moving to react-docgen for all react prop table generation.

• Use react-docgen
  • Remove RDTL from preset-typescript Remove react-typescript-docgen-loader from preset-typescript presets#68
  • Remove RDTL from preset-create-react-app feat(cra): remove ts docgen loader presets#103
• Set up test cases in Addon-docs: Snapshot testing and bug reporting setup for props tables #9836
• File bugs as needed to react-docgen
• Update Storybook Docs w/ CRA & TypeScript walkthrough
• Migration guide

[maniax89]

@shilman was taking a look at the reasoning behind this issue and one of the issues I was trying to get around was this statement in react-docgen for typescript:

https://github.com/reactjs/react-docgen#flow-and-typescript-support

Note: react-docgen will not be able to grab the type definition if the type is imported or declared in a different file.

This is noted in strothj/react-docgen-typescript-loader#80 (comment)

This loader unfortunately does not automatically locate your project's tsconfig.json file (would be a great enhancement if a pull request is made).

If its path isn't specified, the underlying library react-docgen-typescript will fallback to creating a new TypeScript project for each file (I believe), which unfortunately does not resolve types external to the file being checked.

I've updated the documentation and updated the example project to show its usage:

will react-docgen support loading types external to the file being checked eventually? or is this use-case dropped in the CRA preset (storybookjs/presets#103) without a workaround?

[shilman]

@maniax89 please upvote this reactjs/react-docgen#352

There's currently no workaround for this issue. The rationale for the move is that, despite this limitation:

1. there are LOTS of bugs in react-docgen-typescript-loader that are already fixed in react-docgen
2. going "all in" on one library simplifies support and maintenance on the storybook side
3. react-docgen seems to have critical mass, react-styleguidist also adopted it in 110 https://github.com/styleguidist/react-styleguidist/releases/tag/v11.0.0
4. you can still use the old configuration if needed (for now)

[shilman]

OK gang. We've reversed course on this:

👉👉👉 react-docgen-typescript is now the default in SB6.

I documented this out in detail for anybody who cares, and will be updating the rest of the docs shortly.