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

Add "files" to "package.json" #41

Merged
merged 1 commit into from
Mar 1, 2015
Merged

Add "files" to "package.json" #41

merged 1 commit into from
Mar 1, 2015

Conversation

zertosh
Copy link
Contributor

@zertosh zertosh commented Mar 1, 2015

Specify what files to include in npm releases - this way tests and bower.json don't get included in the packaged version. (See https://docs.npmjs.com/files/package.json#files)

@ScottHamper
Copy link
Owner

Cool, thanks Andres!

ScottHamper added a commit that referenced this pull request Mar 1, 2015
Add "files" to "package.json"
@ScottHamper ScottHamper merged commit 62f8766 into ScottHamper:master Mar 1, 2015
@ScottHamper
Copy link
Owner

Hey, what are your thoughts about reducing the list of files even further? Specifically, removing the "src" folder and "CHANGELOG.md"?

If the "files" property is intended to only include files that are relevant for a production ready package, then it seems like it would make sense to only include the "dist" folder. Is there a semantic difference between "tests" and "src" that means we should treat them differently from each other? They both seem like they'd only be relevant when doing development work on the library.

Let me know what you think!

@zertosh
Copy link
Contributor Author

zertosh commented Mar 1, 2015

Hey @ScottHamper, np. I have no opinion on CHANGELOG.md, but yeah src should be excluded too - I missed it.

@ScottHamper
Copy link
Owner

Ok, cool! Thanks again

@zertosh
Copy link
Contributor Author

zertosh commented Mar 1, 2015

Not sure how familiar you are with npm, so I hope I'm not offending by offering this tip: You can see what your final package will look like by running npm pack. It'll make tar.gz that you can then open and inspect to make sure everything you expect to be there is actually there.

@ScottHamper
Copy link
Owner

Nice! That's great to know - I am not really that familiar with NPM. I'll have to prepare a new release with these changes soon.

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