Add custom importers for importing types/values #464

phated · 2020-09-01T22:21:34Z

Alright, I think this is ready to get some serious feedback. Promoting from draft!

Building on the excellent work by @devongovett and @motiz88, I've been trying to implement the requested changes in #352 (specifically #352 (comment))

What I've done

Made the "importer" configurable. It is passed as an argument to the parse method, but if using the defaultParse from main.js, it is an additional option that can be specified. This is to make everything backwards compatible.
Made the default importer a no-op, which might result in some extra function calls during resolution, but keeps all behavior completely the same unless someone explicitly overrides it. This is to make everything backwards compatible.
Threaded the importer throughout the codebase.
Added tests for a "mockImporter" throughout the entire test suite.
Renamed the importer added in Support for importing types #352 to fsImporter and wrapped it in a factory function so the module lookup and cache could be configured. This also allows caching to be done for entire run of react-docgen (if you have a way to reuse your cache, it can even be done between runs).

Stuff I still need to do:

Add tests for makeFsImporter
Add docs for importers

package.json

phated · 2020-09-03T01:36:06Z

I might have run into a problem when testing this against some local code today. Need to dig in further.

Squashed commit of the following: commit 3b3bbf6 Author: Daniel Tschinder <[email protected]> Date: Thu Nov 21 21:52:40 2019 +0100 Add additional test commit 048646d Author: Daniel Tschinder <[email protected]> Date: Thu Nov 21 21:41:41 2019 +0100 Fix order of deps commit e69ef4f Author: Daniel Tschinder <[email protected]> Date: Thu Nov 21 21:39:59 2019 +0100 Add mjs commit 26874ee Merge: 02649b7 b3601b6 Author: Daniel Tschinder <[email protected]> Date: Fri Oct 25 22:25:43 2019 +0200 Merge branch 'master' into importing # Conflicts: # src/utils/isReactComponentClass.js commit 02649b7 Merge: 8c0a15f aa54200 Author: Daniel Tschinder <[email protected]> Date: Fri Oct 25 22:21:51 2019 +0200 Merge branch 'master' into importing # Conflicts: # src/__tests__/__snapshots__/main-test.js.snap # src/__tests__/fixtures/component_28.tsx commit 8c0a15f Author: Devon Govett <[email protected]> Date: Sat May 4 17:56:04 2019 -0700 Missing typedef commit 08b5e7f Author: Devon Govett <[email protected]> Date: Sat May 4 17:45:34 2019 -0700 Fix lint commit c180af8 Author: Devon Govett <[email protected]> Date: Sat May 4 15:08:19 2019 -0700 Support named re-exports commit 80200c8 Author: Devon Govett <[email protected]> Date: Sat May 4 13:18:59 2019 -0700 Handle recursive imports commit 79a814f Author: Devon Govett <[email protected]> Date: Sat May 4 13:09:16 2019 -0700 Support export all declaration commit 840ca88 Author: Devon Govett <[email protected]> Date: Fri May 3 23:25:57 2019 -0700 Handle namespace imports commit 268b828 Author: Devon Govett <[email protected]> Date: Fri May 3 22:51:00 2019 -0700 Add noop browser version of resolveImportedValue commit 00b3d35 Author: Devon Govett <[email protected]> Date: Sun Apr 28 21:59:00 2019 -0700 Initial support for importing prop types

This is not airtight. 1. We may need to make this configurable with a pragma comment. 2. We should probably shallowly resolve the import and record the file and exported name of the alias, instead of just the local name.

… bug

…ure for better type safety

…ons, update tests

phated · 2020-09-21T23:01:39Z

Alright, I think this is ready for an initial review while I continue the follow up work of adding test for makeFsImporter and document importers.

What do you think @danez?

shilman · 2020-09-22T03:22:47Z

Heroic work @phated 🎖️ 🏅 🥇

phated · 2020-09-23T02:40:57Z

It's probably worth mentioning; I bootstrapped this into a large project that I'm working on and it works splendidly!

kivervinicius · 2020-09-29T20:58:16Z

@phated wow!

kivervinicius · 2020-09-30T15:29:14Z

@phated can i use this with you repository? In npm

danez · 2020-10-21T14:32:28Z

I will merge now and release an alpha version with it. Feel free to create follow up PRs for the tests, bugfixes etc.

yarn add react-docgen@next

stu039 · 2021-06-02T09:42:09Z

@danez - Any documentation on usage of this please? Using imported proptypes has been an issue for us for a while. If there is no documentation showing how to enable this in the alpha version, we may have to move away from docgen.

danez · 2021-06-02T09:54:47Z

@stu039 see #507 the cli does not support it at the moment. There might still be bugs, so if you find anything not working please report.

dozortsev · 2021-06-22T11:51:14Z

@danez @phated I guess note that imported types aren't supported is redundant, right?

https://github.com/reactjs/react-docgen/blob/master/README.md#flow-and-typescript-support

phated commented Sep 1, 2020

View reviewed changes

package.json Outdated Show resolved Hide resolved

shilman mentioned this pull request Sep 14, 2020

Support for importing types #352

Closed

2 tasks

motiz88 and others added 27 commits September 20, 2020 12:50

fix(flow): don't add names of spread generics to "composes"

848a17a

fix(imports): visit paths, not nodes

a2bd56a

test(imports): add tests for Flow & type spreads

54227e8

feat(flow): don't resolve imported types in spread

c811dd6

This is not airtight. 1. We may need to make this configurable with a pragma comment. 2. We should probably shallowly resolve the import and record the file and exported name of the alias, instead of just the local name.

Make import resolver configurable by threading throughout

6320417

linter/prettier

31d5c6d

Fix flow type importers

7d9d559

Apply importer changes to typescript

c2c0291

Lint fixes

274bbc0

Apply importer changes to propTypes

791fc60

Remove Parser from the handler signature

d93ebf5

Resolve docblocks from imported components & add tests

0adf638

Test/fix methodsHandler for resolver, lint fixes

65cd0be

Add mockImporter builder util

1bc086f

Add noop & mock importer tests for defaultPropsHandler, fix func decl…

0f52572

… bug

Apply makeMockImporter util

3389897

Fix some tests to avoid doing 2 handler calls in same test

3ed09d1

Add tests for importer with displayNameHandler

ea82351

Fix lint

83c084f

Add importer tests to flowTypeHandler

5425554

Found a place where importer was not threaded through, changed struct…

87a9d74

…ure for better type safety

Temp disable a CLI test until I can figure it out

87fd0d6

Export the importers from main

cf9a5ac

Add importer tests for propDocblockHandler

71a836f

Add importer tests for propTypeCompositionHandler

0f53a67

Lint fixes

5b06149

phated added 5 commits September 21, 2020 15:10

Small cleanup/correction

a4d8158

Update parse tests to match typed function signature

5b5b1b9

Switch default importer to ignoreImports, fix type sigs w/ babel opti…

e397716

…ons, update tests

Add factory around importer that takes args, rename to makeFsImporter

2185a8c

Bump resolve to latest

d8bab0a

phated marked this pull request as ready for review September 21, 2020 23:00

phated changed the title ~~WIP: Importing types~~ Add custom importers for importing types/values Sep 21, 2020

yuqu mentioned this pull request Oct 6, 2020

functional components not working? zeplin/cli-connect-react-plugin#27

Closed

danez merged commit 231fbfa into reactjs:master Oct 21, 2020

c10b10 mentioned this pull request Dec 10, 2020

Addon Docs - build prop table from dynamic propTypes? storybookjs/storybook#10536

Closed

danez mentioned this pull request Dec 12, 2020

Basic React Hooks support (useImperativeHandle only) #454

Closed

Sm1t mentioned this pull request Feb 2, 2021

Make PropTypes.oneOf work with dynamic values in controls storybookjs/storybook#12798

Closed

Sm1t mentioned this pull request Mar 4, 2021

Args: Support dynamic PropTypes storybookjs/storybook#14092

Open

danez mentioned this pull request Mar 30, 2021

react-docgen doesn't see components imported by import directive #448

Closed

shilman mentioned this pull request May 25, 2021

First-class react-docgen support for Typescript storybookjs/storybook#15036

Closed

4 tasks

diegonvs mentioned this pull request May 31, 2021

Dropdown.Section is not documented on ClayDropDown API docs liferay/clay#4095

Closed

1 task

KaiVandivier mentioned this pull request Aug 9, 2021

feat: handle imported/exported components dhis2/cli-utils-docsite#116

Merged

sunyatasattva mentioned this pull request Nov 29, 2021

Addon-docs: Update type/value rendering for 6.0 recommendations storybookjs/storybook#10311

Closed

4 tasks

mscott2757 mentioned this pull request Jan 11, 2022

chore: use [email protected] storybookjs/babel-plugin-react-docgen#104

Closed

danez mentioned this pull request Apr 4, 2022

6.0.0 #502

Closed

19 tasks

github-actions bot locked as resolved and limited conversation to collaborators Jul 28, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add custom importers for importing types/values #464

Add custom importers for importing types/values #464

phated commented Sep 1, 2020 •

edited

Loading

phated commented Sep 3, 2020

phated commented Sep 21, 2020

shilman commented Sep 22, 2020

phated commented Sep 23, 2020

kivervinicius commented Sep 29, 2020

kivervinicius commented Sep 30, 2020

danez commented Oct 21, 2020 •

edited

Loading

stu039 commented Jun 2, 2021

danez commented Jun 2, 2021 •

edited

Loading

dozortsev commented Jun 22, 2021

Add custom importers for importing types/values #464

Add custom importers for importing types/values #464

Conversation

phated commented Sep 1, 2020 • edited Loading

phated commented Sep 3, 2020

phated commented Sep 21, 2020

shilman commented Sep 22, 2020

phated commented Sep 23, 2020

kivervinicius commented Sep 29, 2020

kivervinicius commented Sep 30, 2020

danez commented Oct 21, 2020 • edited Loading

stu039 commented Jun 2, 2021

danez commented Jun 2, 2021 • edited Loading

dozortsev commented Jun 22, 2021

phated commented Sep 1, 2020 •

edited

Loading

danez commented Oct 21, 2020 •

edited

Loading

danez commented Jun 2, 2021 •

edited

Loading