Create .npmignore

[quinton-ashley]

I think offering Box2D v3 at a lightweight size is one of the big advantages of this JS port! But the npm package is a hefty 12MB.

Therefore it might be best to use an .npmignore file so that only the dist folder and only other necessary files be included in the npm package, which is more typical. If users want to get everything else they can download the git repo.

[photonstorm]

The npm size has zero relation to the bundle size. The tradeoff is purely convenience vs a relative small amount of disk space.

[quinton-ashley]

For web apps, yes. But it would have an impact on Electron app bundle size.

I suppose if people are concerned about making their apps smaller they can install phaser-box2d as a dev dependency and then copy the release build within their app folder as part of their build process.

Personally I wouldn't make users to do that. I'd only include the release build and minified release build in the package so users can simply use npm for package management. I don't think users need to build from source or read through the docs from within node_modules. Just a suggestion though.

[mreinstein]

I don't see any upside to bloating the npm package. If it's not used at run time it probably doesn't belong in the npm module. Dev artifacts should stay in the git repo. Electron app bundle size is a valid example of this, and also CI/CD (not having to pull down 10s of extra megabytes adds up over thousands of runs. :) )