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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

add .npmignore #43

Closed
wants to merge 1 commit into from
Closed

add .npmignore #43

wants to merge 1 commit into from

Conversation

necccc
Copy link

@necccc necccc commented Oct 26, 2018

Hi 馃憢

I鈥檝e been doing a little research for a conference talk on how npm package size relates to their content, and your package was one in the several ones that were flagged by my scripts. It has an outstanding weekly download count on npm and relatively large content that is not related directly to the package functionality.

I've added some files and folders to an .npmignore file, so they won't get packaged next time you release it on npm.

Thanks, and have a great day!

@mourner
Copy link
Member

mourner commented Oct 26, 2018

Thank you, good catch! Instead of adding an .npmignore, can we add a files field in package.json instead?

@necccc
Copy link
Author

necccc commented Oct 26, 2018

sure thing, you can do both, note that anything in 'files' will have precedence over the content of .npmignore

@mourner
Copy link
Member

mourner commented Oct 26, 2018

@necccc I mean, can we do that in this PR? I prefer the package.json approach that doesn't clutter the repo with additional files and is easier to maintain.

@necccc
Copy link
Author

necccc commented Oct 26, 2018

I'll try, the quickest way was just to ignore these, for the "files" field I have to check what exactly your package needs.

@mourner
Copy link
Member

mourner commented Oct 26, 2018

@necccc I think only the bin/pixelmatch, everything else should be included automatically. We can
confirm with npm publish --dry-run.

@mourner
Copy link
Member

mourner commented Jan 30, 2019

Fixed in e19712b

@mourner mourner closed this Jan 30, 2019
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.

None yet

2 participants