Skip to content
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

Add bower_components and dist to .npmignore. #5245

Merged
merged 1 commit into from
May 30, 2018
Merged

Add bower_components and dist to .npmignore. #5245

merged 1 commit into from
May 30, 2018

Conversation

coreyfarrell
Copy link
Contributor

Fixes #5244

Copy link
Contributor

@TimvdLippe TimvdLippe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per #5244 (comment) using files is probably a better change. Could you use that instead?

Also: how can I test/verify this locally?

This effectively removes the following from the NPM packages:
* bower_components
* dist
* CONTRIBUTING.md
* gen-tsd.json
* gulpfile.js
* wct.conf.json

Fixes #5244
@coreyfarrell
Copy link
Contributor Author

coreyfarrell commented May 29, 2018

I've switched to using files, deleted .npmignore. This cleans a couple more files that are development only (detailed in commit message). Redundant entries are not listed, see npmjs docs for files that are automatically included. You can test this using npm pack, then inspect the tarball that is created.

With this change @polymer/polymer will be 1022kb unpacked. Of this CHANGELOG.md (automatically included by npm pack) is 324k, 31% of the total install. Maybe CHANGELOG.md should be split so it only includes the current semver-major, have a CHANGELOG-ARCHIVE.md or similar containing entries for legacy versions, add an a link to the end of the current changelog? Not included in this commit as decreasing from 14936kb to 1022kb is a huge improvement but I still feel it's worth considering not allowing the CHANGELOG.md included in the package to expand indefinitely.

Edit: note the sizes I've mentioned does not include any dependencies.

Copy link
Contributor

@TimvdLippe TimvdLippe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is nice, thanks! We will keep the CHANGELOG for now, but we can revisit later.

@TimvdLippe TimvdLippe merged commit eb84ea0 into Polymer:master May 30, 2018
@coreyfarrell coreyfarrell deleted the fix-5244 branch June 1, 2018 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants