perf(npm): remove superfluous files from npm package #328
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
sheerlox
force-pushed
the
perf/reduce-npm-package-size
branch
from
c8b690d
to
d4e78ed
Compare
sheerlox
changed the title
|
hello @harrisiirak 👋 are you interested in the improvement changes proposed in this PR? thanks in advance 🙏 |
|
Hi @sheerlox! I saw your PR but I haven't really had time to look into it. I'll assign it to myself and try to find some time next week. Best regards |
harrisiirak
approved these changes
Aug 11, 2023
|
Let's go 🎉 thank you very much! |
harrisiirak
pushed a commit
that referenced
this pull request
Aug 28, 2023
* perf(npm): remove superfluous files from npm package * test: fix TS tests to point to the right file
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.
Description
This PR reduces the npm package size by 64%, mainly preventing the
testfolder from being published.I've replaced the
.npmignorefile with the opposite, thefilessection inpackage.jsonwhich specifies which files should be published to npm. This is the preferred behavior, as it will automatically filter any useless file not explicitly added to thefilesarray.The root
index.d.tshas been removed as it wasn't needed, andpackage.jsonhas been adjusted to point types directly totypes/index.d.ts.Motivation
I am considering using this library in another I'm maintaining, and the main blocking point is the package size. If this gets merged, it will instantly become a better option.