-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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
Only necessary files are published to npm #4819
Conversation
Thanks for the PR! Is there any advantage to specifying included files in |
The general reason is that dotfiles are easy to miss when downloading/sharing source code or copying directories around. There is also an argument to suggest that dotfiles are better for machine-specific config (eg: |
package.json
Outdated
"dist/", | ||
"plugins/", | ||
"LICENSE.txt", | ||
"ARCHITECTURE.md" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we'd want to include ARCHITECTURE.md
in the npm package. We should include README.md
and CHANGELOG.md
though.
Also the plugins/
folder isn't needed (it actually shouldn't even be in master
anymore)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Readme and changelog are automatically added see https://docs.npmjs.com/files/package.json#files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also remove the LICENSE.txt
.
In the npm documentation it states
Certain files are always included, regardless of settings:
[...]
LICENSE / LICENCE
README, CHANGES, LICENSE & NOTICE can have any case and extension.
You've still got |
Done! 💪🏻 @mollymerp |
@mourner @anandthakker do you know if we need to include the |
Yeah, IMO we should keep these in so that people who want to bundle our source directly have a fighting chance. |
Switched from .npmignore to files array inside package.json - https://github.com/npm/npm/wiki/Files-and-Ignores - https://docs.npmjs.com/files/package.json
We should not publish the |
@LitoMore we intentionally publish |
Switched from .npmignore to files array inside package.json