[breaking] when NODE_ENV is production, export mocks instead of real validators
#5
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
lencioni
requested changes
Jan 7, 2017
|
It would be good to add some information about this in the readme. |
lencioni
approved these changes
Jan 7, 2017
|
Yes, sorry, I'd pushed the mocks to master prior. Good point, I'll update the readme before merging this PR. |
|
Readme updated. |
lencioni
reviewed
Jan 9, 2017
| @@ -25,6 +25,9 @@ Custom React PropType validators that we use at Airbnb. Use of [airbnb-js-shims] | |||
| - `uniqueArrayOf`: `uniqueArray`, with a type validator applied. Like `PropTypes.arrayOf`, but with uniqueness. | |||
| - `withShape`: takes a PropType and a shape, and allows a shape to be enforced on any non-null/undefined value. | |||
|
|
|||
| ## Production | |||
| Since `PropTypes` are typically not included in production builds of React, this library’s functionality serves no useful purpose. As such, when the `NODE_ENV` environment variable is `"production"`, instead of exporting the implementations of all these prop types, we export mock functions - in other words, something that ensures that no exceptions are thrown, but does no validation. When environment variables are inlined (via a browserify transform or webpack plugin), then tool like webpack or uglify are able to determine that only the mocks will be imported - and can avoid including the entire implementations in the final bundle that is sent to the browser. This allows for a much smaller ultimate file size, and faster in-browser performance, without sacrificing the benefits of `PropTypes` themselves. | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
It'd be ideal to test locally and ensure this is working as intended.