-
Notifications
You must be signed in to change notification settings - Fork 792
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
fix: Remove unnecessary files from npm package #3054
Conversation
We just had to manually publish `@next`, as [a `develop` build failed](https://app.circleci.com/pipelines/github/dequelabs/axe-core/2462/workflows/19d5c98e-c7e4-4a85-87f1-3503179ac326/jobs/33275). When doing this, I noticed how many things are included in the tarball we send to npm. This patch drastically reduces the size of the tarball and the number of files it contains. Previously: ``` npm notice === Tarball Details === npm notice name: axe-core npm notice package size: 811.9 kB npm notice unpacked size: 3.5 MB npm notice total files: 689 ``` Now: ``` npm notice === Tarball Details === npm notice name: axe-core npm notice package size: 314.3 kB npm notice unpacked size: 1.5 MB npm notice total files: 7 ``` This will hopefully reduce the chance of another failed upload.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe these are all the files we need, but @WilcoFiers should also approve so we don't mess it up.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure why this is better over updating npmignore
. At the very least let's not use both.
"axe.js", | ||
"axe.min.js", | ||
"axe.d.ts", | ||
"locales/" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"locales/" | |
"LICENSE", | |
"locales/" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
npm includes this itself.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it? OK sure cool.
Good catch. I'll remove the |
Suggested change is redundant; removed .npmignore
"axe.js", | ||
"axe.min.js", | ||
"axe.d.ts", | ||
"locales/" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does it? OK sure cool.
We just had to manually publish
@next
, as adevelop
build failed. When doing this, I noticed how many things are included in the tarball we send to npm. This patch drastically reduces the size of the tarball and the number of files it contains.Previously:
Now:
This will hopefully reduce the chance of another failed upload.