Skip to content
This repository has been archived by the owner on Aug 31, 2021. It is now read-only.

Use package.json's files field to cut down on what we publish #185

Closed
jeffposnick opened this issue Sep 21, 2016 · 2 comments
Closed

Use package.json's files field to cut down on what we publish #185

jeffposnick opened this issue Sep 21, 2016 · 2 comments
Labels

Comments

@jeffposnick
Copy link
Contributor

We're currently distributing the following to npm:

$ ls
LICENSE         bower.json      docs            package.json        sw-toolbox.map.json
README.md       companion.js        lib         sw-toolbox.js

We should use the files field in package.json to limit what we publish.

Specifically, I don't think we need to publish the following:

  • docs/
  • lib/
  • bower.json
@addyosmani
Copy link
Contributor

I don't think we should distribute docs or lib as part of the package. Looking at the bower.json file, https://github.com/GoogleChrome/sw-toolbox/blob/master/bower.json#L4 seems like the only really useful hint and I don't think the lack of presence of this file is going to break anything. +1 for using files.

@jeffposnick
Copy link
Contributor Author

package.json's main field lists lib/sw-toolbox.js, so I guess we should continue to shiplib/ as well. (It might be safe to just switch main to point to build/sw-toolbox.js, but we'd need to think more about how developers are consuming this library.)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants