Remove propTypes in production #1322
Merged
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
This will help reduce the bundle size impact. Note that any consumers who are depending on any react-dates components having a `.propTypes` property will no longer work as expected after this change. I enabled this using wrap mode, which adds `process.env.NODE_ENV` checks, which is a pretty standard method for React apps. I believe this will allow this library to have propTypes in development, but for them to be minified out in production builds. To make this safe to enable in this repo, I enabled the react/forbid-foreign-prop-types ESLint rule, which was written specifically for the benefit of this plugin. Here's a diff showing what effect this has on the esm build: https://gist.github.com/lencioni/1b436d365570394ccde659c829ba02c3
ljharb
reviewed
Aug 22, 2018
.babelrc
Outdated
| "production": { | ||
| "presets": ["airbnb"], | ||
| "plugins": [ | ||
| "inline-react-svg", | ||
| ["transform-replace-object-assign", { "moduleSpecifier": "object.assign" }], | ||
| ["transform-react-remove-prop-types", { |
There was a problem hiding this comment.
is this something we could add in babel-preset-airbnb, possibly behind an option, instead of in individual repos?
There was a problem hiding this comment.
Sure, I think so!
I think we'd still need to make it configurable though, since in some places we want the mode to be remove instead of wrap for instance, and other options might be important to manage on a case by case basis, but we could just have a passthrough option.
There was a problem hiding this comment.
sure, a passthrough option sounds great
lencioni
added a commit
to airbnb/babel-preset-airbnb
that referenced
this pull request
Aug 29, 2018
I originally started by adding this plugin to react-dates, but it seems like we are going to want this in a lot of places, so it makes sense to put it into our preset instead. react-dates/react-dates#1322 For the default options, I decided to go with "wrap" as the mode, since we are likely to use this more frequently in packages that are published and consumed by other packages and apps, which aren't very compatible with the "remove" option. In our apps where this is not a concern, we will want to override this to use the "remove" option in production and likely disable this plugin entirely in development for better build speeds.
lencioni
added a commit
to airbnb/babel-preset-airbnb
that referenced
this pull request
Aug 29, 2018
I originally started by adding this plugin to react-dates, but it seems like we are going to want this in a lot of places, so it makes sense to put it into our preset instead. react-dates/react-dates#1322 For the default options, I decided to go with "wrap" as the mode, since we are likely to use this more frequently in packages that are published and consumed by other packages and apps, which aren't very compatible with the "remove" option. In our apps where this is not a concern, we will want to override this to use the "remove" option in production and likely disable this plugin entirely in development for better build speeds.
This new version includes an option for removing propTypes, so I am removing that plugin in favor of using the preset option.
|
@ljharb I just published the new preset with the removePropTypes option and updated this PR to use that instead. |
ljharb
approved these changes
Aug 29, 2018
ljharb
added
the
semver-major: breaking change
|
Agreed! @majapw feel free to merge this when you think it makes sense for the next major. |
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.
This will help reduce the bundle size impact. Note that any consumers
who are depending on any react-dates components having a
.propTypesproperty will no longer work as expected after this change.
I enabled this using wrap mode, which adds
process.env.NODE_ENVchecks, which is a pretty standard method for React apps. I believe this
will allow this library to have propTypes in development, but for them
to be minified out in production builds.
To make this safe to enable in this repo, I enabled the
react/forbid-foreign-prop-types ESLint rule, which was written
specifically for the benefit of this plugin.
Here's a diff showing what effect this has on the esm build:
https://gist.github.com/lencioni/1b436d365570394ccde659c829ba02c3