Add explicit files list to package.json #1951
Merged
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.
This PR removes
.npmignore
and replaces it with a whitelist of files to include in the published module.It's a bit safer and more convenient as you do not need to keep updating
.npmignore
to exclude non-release files. For example, I have a separate (work in progress) PR to add code coverage to the CI system which (after this PR is merged) would not need to worry about adding the local coverage or report directories.I only included the
lib
directory and theSPONSORS.md
file. NPM will always include the README, LICENSE, and CHANGELOG so no need to specify them.Here's the before / after:
npm pack
prior to this PRnpm pack
after this PROnly differences are
.eslintrc
andMakefile
are no longer included in the published tgz. Rather than just update.npmignore
to exclude them, this should fix things for anything else in the future too.