A consistent shrinkwrap tool
A consistent shrinkwrap tool Note: npm >= 3 is currently not supported.
This runs shrinkwrap, which verifies your package.json & node_modules tree are in sync. If they are it runs shrinkwrap then fixes the resolved fields and trims from fields
When you run
npm-shrinkwrap it will either:
--saveor hand edited your package.json
npm-shrinkwrap syncwhich writes the npm-shrinkwrap.json back into node_modules
We need to verify that
node_modules all have the same content.
Currently npm verifies most things but doesn't verify git completely.
The edge case npm doesn't handle is if you change the tag in your package.json. npm happily says that the dependency in your node_modules tree is valid regardless of what tag it is.
NPM shrinkwrap serializes your node_modules folder. Depending on whether you installed a module from cache or not it will either have or not have a resolved field.
npm-shrinkwrap will put a
resolved field in for everything
in your shrinkwrap.
There are a few tricks to ensuring there is no unneeded churn
in the output of
This first is to ensure you install with
npm cache clean so
npm ls output is going to consistently give you the
The second is to just delete all
from fields from the
generated shrinkwrap file since they change a lot but are
never used. However you can only delete some
When you run shrinkwrap and check it into git you have an unreadable git diff.
npm-shrinkwrap comes with an
npm-shrinkwrap diff command.
npm-shrinkwrap diff master HEADnpm-shrinkwrap diff HEAD npm-shrinkwrap.json --short
You can use this command to print out a readable context specific diff of your shrinkwrap changes.
npm-shrinkwrap can be programmatically configured with an
validators run over every node in the shrinkwrap file
and can do assertions.
Useful assertions are things like assertion all dependencies point at your private registry instead of the public one.
var npmShrinkwrap = ;
npm ls to verify that node_modules & package.json
verifyGit() which has a similar algorithm to
npm ls and will verify that node_modules & package.json
agree for all git links.
read the old
npm-shrinkwrap.json into memory
copy over excess non-standard keys from old shrinkwrap into new shrinkwrap and write new shrinkwrap with extra keys to disk.
setResolved() which will ensure that the new
npm-shrinkwrap.json has a
"resolved" field for every
package and writes it to disk.
trimFrom() which normalizes or removes the
field from the new npm-shrinkwrap.json. It also sorts
the new npm-shrinkwrap.json deterministically then
writes that to disk
trimNested() which will trim any changes in the
npm-shrinkwrap.json to dependencies at depth >=1. i.e.
any changes to nested dependencies without changes to
the direct parent dependency just get deleted
sync() to the new
npm-shrinkwrap.json back into
verifyGit() only has a depth of 0, where as
has depth infinity.
verifyGit() is only sound for git tags. This means that
for non git tags it gives warnings / errors instead.
trimFrom() also sorts and rewrites the package.json
By default, the npm-shrinkwrap algorithm does not dedupe
nested dependencies. This means that the shrinkwrap is
closer to the installed dependencies by default. If this
is not desired
--keepNested=false can be passed to the
node_modules are in sync.
npm shrinkwrap and cleans up the
npm-shrinkwrap.json file to be consistent.
npm shrinkwrap but better
Options:--dirname sets the directory location of the package.jsondefaults to `process.cwd()`.--keep-nested If set, will not remove nested changes.--warnOnNotSemver If set, will downgrade invalid semver errorsto warnings--dev If set, will shrinkwrap dev dependencies--silent If set, will be silent.
Prints this message
npm-shrinkwrap.json file into the
This will ensure that your local
node_modules matches the
npm-shrinkwrap.json file verbatim. Any excess modules in
your node_modules folder will be removed if they are not in
Options: --dirname sets the directory of the npm-shrinkwrap.json
Will write a
shrinkwrap script to your
Options: --dirname sets the directory location of the package.json
This will show a human readable for the shrinkwrap file.
You can pass it either a path to a file or a git shaism.
npm-shrinkwrap diff HEAD npm-shrinkwrap.jsonnpm-shrinkwrap diff origin/master HEAD
Options:--depth configure the depth at which it prints--short when set it will print add/remove tersely--dirname configure which folder to run within
For usage with npm@2
npm install npm-shrinkwrap
For usage with npm@1
npm install email@example.com
Note: npm >= 3 is not supported.