Safe Shrinkwrap

Safe shrinkwrap allows you to clean OS specific dependencies from NPM's shrinkwrap JSON file. This makes it a lot easier to create a cross platform shrinkwrap that doesn't break the world even if the maintainer of the systems doesn't.

Installation

npm install -g safe-shrinkwrap

This gives you safe-shrinkwrap and the shorter ssw for use on the command line.

Usage

To use this program, issue ssw or safe-shrinkwrap from the root directory of your Node.JS project. It will run npm shrinkwrap --dev and then clean up the resulting npm-shrinkwrap.json file. It leaves behind an npm-shrinkwrap.unsafe.json in addition to the cleaned up npm-shrinkwrap.json file. You'll then be good to go.

Be aware that it removes your node_modules directory and reinstalls your node modules. If you had any extra modules that aren't in the package.json, or OS dependant modules, you will need to install them again after this is done.

Arguments

    -ni, --no-install : doesn't install
    -ndd, --no-dedupe : keeps it from running npm dedupe as part of the process
    -nd, --no-dev : don't include the dev dependencies in the shrinkwrap file
    -rs, --remove-shrinkwrap : delete the npm-shrinkwrap.json file first
    -v, --version : outputs just the version
    -h, --help : outputs this help information

No install version

If you really don't want to have this program wipe and reinstall then you can to pass --no-install or -ni. This often lead to errors though. So be warned of this.

No dedupe version

If you run into problems then you may need to run the --no-dedupe version. This is likely to happen if you are using chokidar or something that uses it... which is a lot of things these days. It prevents safe-shrinkwrap from running npm dedupe which tries to flatten out the dependency tree.

License

See LICENSE.md for the license

Code of Conduct

See CODE-OF-CONDUCT.md for the code of conduct.

Contributing

See CONTRIBUTING.md