Skip to content

Add developit/proptypes to allowed module names #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 7, 2017

Conversation

eduardoboucas
Copy link
Contributor

This PR adds @developit's proptypes module to the list of recognised React modules, for better support of engines other than Facebook's React. In this case, I'm using it with Preact.

Having looked at #96, I don't know if adding another hardcoded value to the list of modules is the way you want to go. If you prefer a more flexible solution of being able to supply the names of the modules to validate against, I can also look into that if you give me some pointers.

Thanks!

@developit
Copy link

This is great. Would love to recommend react-docgen as a documentation solution that works out-of-the-box with preact :)

@fkling
Copy link
Member

fkling commented Mar 7, 2017

Thank you for that! Overall I'm not very happy with the current solution, but I cannot think of an elegant alternative. The ideas that I had were to either add parameter that disables the "module origin" check or that allows you to define the "React" module(s). While that's flexible its also kind of annoying to have to pass such an option.
Maybe having a configuration file for react-docgen would make this less of an issue.

If you have a suggestion I'm happy to hear about it. For now, we'll stick with what we have 😉

@fkling fkling merged commit aa3e22a into reactjs:master Mar 7, 2017
@eduardoboucas
Copy link
Contributor Author

Just checking if this has been merged to npm so I can go back to using the main package instead of my fork.

Thanks! 🤓

@fkling
Copy link
Member

fkling commented Mar 28, 2017

Yeah, this is available in the beta version. See https://github.com/reactjs/react-docgen/releases/tag/v3.0.0-beta1

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 29, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants