npm-packlist icon indicating copy to clipboard operation
npm-packlist copied to clipboard

[FEATURE] Expand the list of default ignored files

Open ruyadorno opened this issue 5 years ago • 3 comments

What / Why

A large population of npm users are concerned about package sizes and with the advent of the file explorer now available on the npmjs.com website we can now see a number of common files that are very intrinsic to the JS community that we could start ignoring from package bundles without too much friction to the larger ecosystem.

Being a breaking change if we are to do it, we should bring this in time for npm@7

How

Expand the current list of ignored files to also ignore by default:

  • .editorconfig
  • .gitattributes
  • .idea (folders and more editors similar configs/store)
  • .travis.yml (and/or more ci services)
  • .yo-rc.json

...and whatever more we think makes sense

Who

  • @npm/cli-team

References

  • n/a

ruyadorno avatar Dec 17 '19 18:12 ruyadorno

This makes sense to me. .github is another good one.

isaacs avatar Jan 02 '20 01:01 isaacs

So, I wasn't able to attend the RFC meeting where this was discussed, but from the notes, it looks like the consensus reached was "let's look at the packages in the registry and see if anything will break"?

isaacs avatar Jan 26 '20 03:01 isaacs

@isaacs

This makes sense to me. .github is another good one.

Just be aware that some people put images they reference in the readme within the .github directory. If that were not published, there would be 404 images in the published readme displayed in npm.

jaydenseric avatar May 25 '21 05:05 jaydenseric