bbc / VideoContext

An experimental HTML5 & WebGL video composition and rendering API.
http://bbc.github.io/VideoContext/
Apache License 2.0
1.33k stars 157 forks source link

Use "files" whitelist instead of .npmignore #100

Closed PTaylour closed 6 years ago

PTaylour commented 6 years ago

why?

In the eyes of npm .npmignore replaces .gitignore.

This is hard to maintain as the gitignore is pretty much always a subset of the npmignore

Also, we'd rather whitelist than blacklist. There are many more things to exclude than include.

The package.json files field lets us to this.

see https://blog.npmjs.org/post/165769683050/publishing-what-you-mean-to-publish

PTaylour commented 6 years ago

@reecelucas is this inline with your update to production-ui-core?

reecelucas commented 6 years ago

@PTaylour, I also added README.md but I don't think it's essential.

PTaylour commented 6 years ago

Yea appaz these are always included

package.json README CHANGES / CHANGELOG / HISTORY LICENSE / LICENCE NOTICE The file in the "main" field

PTaylour commented 6 years ago

PR 100 merged 🍾