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

Reducing Size of NPM Package #484

Merged
merged 2 commits into from
Dec 1, 2018
Merged

Reducing Size of NPM Package #484

merged 2 commits into from
Dec 1, 2018

Conversation

fishcharlie
Copy link
Member

Summary:

This PR limits the amount of project files uploaded to NPM. Which has an AMAZING result in terms of download size of the package.

The node_modules/dynamoose folder size:

  • Before this PR: 2.2 MB (2,198,988 bytes)
  • After this PR: 171 KB (170,578 bytes)

Before this PR was calculated using Dynamoose version 1.2.0.

If my math is correct, that is just under 13x smaller. So HUGE improvement here.

Type (select 1):

  • Bug fix
  • Feature implementation
  • Documentation improvement
  • Testing improvement
  • Test added to report bug (GitHub issue #--- @---)
  • Something not listed here

Is this a breaking change? (select 1):

  • 🚨 YES 🚨
  • No
  • I'm not sure

Is this ready to be merged into Dynamoose? (select 1):

  • Yes
  • No

Are all the tests currently passing on this PR? (select 1):

  • Yes
  • No

Other:

  • I have searched through the GitHub pull requests to ensure this PR has not already been submitted
  • I have updated the Dynamoose documentation (if required) given the changes I made
  • I have added/updated the Dynamoose test cases (if required) given the changes I made
  • I have run npm test from the root of the project directory to ensure all tests continue to pass
  • I agree that all changes made in this pull request may be distributed and are made available in accordance with the Dynamoose license
  • All of my commits and commit messages are detailed, explain what changes were made, and are easy to follow and understand
  • I have confirmed that all my code changes are indented properly using 2 spaces
  • I have filled out all fields above

@coveralls
Copy link

coveralls commented Dec 1, 2018

Pull Request Test Coverage Report for Build 757

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 2 unchanged lines in 1 file lost coverage.
  • Overall coverage remained the same at 85.662%

Files with Coverage Reduction New Missed Lines %
lib/Table.js 2 79.59%
Totals Coverage Status
Change from base Build 755: 0.0%
Covered Lines: 2113
Relevant Lines: 2392

💛 - Coveralls

Copy link
Contributor

@jutaz jutaz left a comment

Choose a reason for hiding this comment

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

Worth also include Readme.md, so that npm is able to still see the readme? IIRC it pulls it from the package itself

@fishcharlie
Copy link
Member Author

@jutaz According to this page the README is included by default regardless of settings. A few other files are included regardless of settings.

Copy link
Contributor

@jutaz jutaz left a comment

Choose a reason for hiding this comment

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

Oh, that makes sense. Good stuff 👍

@fishcharlie fishcharlie changed the title Reducing Size of NPM Dynamoose Reducing Size of NPM Package Dec 1, 2018
@fishcharlie fishcharlie mentioned this pull request Dec 1, 2018
@fishcharlie fishcharlie merged commit 926c55e into dynamoose:master Dec 1, 2018
@fishcharlie fishcharlie deleted the npminclude branch December 1, 2018 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants