Refactor for flow intersection and union Props #97
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Refactor to resolve, when possible, a list of props from a flow intersection type and to throw an error when encountering a Props of union type. This change addresses a bug found in the flowTypeDocBlockHandler while a props type that is an IntersectionTypeAnnotation or a UnionTypeAnnotation. Union types throw an error, rather than generating misleading documentation. When given a union type, flow will enforce that props conform to only one of the union-ed types. The documentation format, which lists a single set of props can't express this. Fix lint errors
|
Updated commit to fix lint errors |
| } else if (path.node.type == 'UnionTypeAnnotation') { | ||
| // The react-docgen output format does not currently allow | ||
| // for the expression of union types | ||
| throw new TypeError("react-docgen doesn't support Props of union types"); |
There was a problem hiding this comment.
I agree now, that generating props from union types is more tricky and a bad idea like it was before, but imho it would be better to just ignore the type instead of throwing an exception. People should not be forced to restructure their code just to get the docs working. If I think of my companies huge codebase, this might break the complete docs even if it's just one component that has an union type.
|
This has been merged with #118. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This follows up to the flow support added by @danez
Refactor to resolve, when possible, a list of props
from a flow intersection type and to throw an error
when encountering a Props of union type.
This change addresses a bug found in the flowTypeDocBlockHandler
while a props type that is an IntersectionTypeAnnotation or a
UnionTypeAnnotation.
Union types throw an error, rather than generating misleading documentation.
When given a union type, flow will enforce that props conform to only one of
the union-ed types. The documentation format, which lists a single set of props
can't express this.