Use package.json files entry instead of .npmignore
#5800
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
cee-chen
reviewed
Apr 15, 2022
| "test-env", | ||
| "eui.d.ts", | ||
| "i18ntokens.json", | ||
| "NOTICE.txt" |
There was a problem hiding this comment.
Should we keep the main README as well?
There was a problem hiding this comment.
Ah thanks for reminding me. There are certain files that are included regardless of your config; README is one of them: https://docs.npmjs.com/cli/v7/configuring-npm/package-json#files
cee-chen
approved these changes
Apr 15, 2022
|
Preview documentation changes for this PR: https://eui.elastic.co/pr_5800/ |
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.
Summary
🤔
#5799 ("remove
.cifrom the EUI package") got me exploring.npmingnorewhich reminded me of #4769 ("what else can we ignore?"). Reading thenpmdocs highlighted that we can make an include list rather than an exclude list by using thepackage.jsonfilesentry.The result is a decrease of 8MB or ~11% of the distributed package.
Confirmed Kibana and CRA both continue to work as expected.
Addendum
Yes, 63MB is still massive, but considering that includes 4 different targeted builds, 2 webpack bundles (one of which is 12MB), and 4 ~500KB CSS files. The CSS files will shrink rapidly with the move to CSS-in-JS, and we will likely stop distributing webpack bundles. Regardless, an actual consumer only (lol) sees 7MB (unpacked) in use, and the eventual move to packages will help immensely.
### Checklist