fix: only include necessary files into npm #239
Conversation
There was a problem hiding this comment.
This would be a breaking change.
This is quite intentional. Those files must be included.
Tests should be published with every package, so that
npm explore foo && npm install && npm testalways works.Installed package size is irrelevant; if you never require the test files, they'll never affect the runtime of your application.
Duplicate of #235. Duplicate of #58. Duplicate of #44. See #105 (comment).
| "files": [ | ||
| "/lib", | ||
| "/index.js", | ||
| "/index.mjs" | ||
| ], |
There was a problem hiding this comment.
"files" is highly dangerous and should never be used; only .npmignore should be used to control what files are published.
There was a problem hiding this comment.
Highly disagree, but you're the boss here. 🧐
A lot of popular packages are using files, it makes package cleaner and much easier to maintain.
There was a problem hiding this comment.
"a lot of packages use it" isn't an argument for it being safe.
The worst possible damage caused by accidental omission from "npmignore" is "the package is slightly larger". The worst possible damage caused by accidental omission from "files" is "every consumer breaks".
close #238
cc @ljharb