Optimize package published to npm
#257
Open
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.
Currently, the entire repository contents are published to NPM. The package can be optimized by excluding unnecessary files/folders/metadata when publishing to NPM.
The distributed package size can be optimized by using the
package.json#filesproperty. It's an allowlist of files or folders for publishing.This PR proposes allowlisting
distandsrcfolders. Note that some files are automatically included and do not need to be specified (e.g., README, LICENSE).Running
npm packshows the following comparison.Before
mainbranchnpm i; npm run buildnpm packAfter
npm i; npm run buildnpm packResult
Consequently, the size of the publish package (both packed/unpacked) can be dramatically reduced.