lockdown

npm-lockdown

Put your dependencies on lockdown.

What's this?

NPM Lockdown is a tool that locks your node.js app to specific versions of dependencies... So that you can:

• know that the code you develop against is what you test and deploy
• npm install and get the same code, every time.
• not have to copy all of your dependencies into your project
• not have to stand up a private npm repository to solve this problem.

Who is this for?

Node.JS application developers, but not library authors. Stuff published in npm as libraries probably wouldn't be interested.

Why Care?

Even if you express verbatim versions in your package.json file, you're still vulnerable to your code breaking at any time. This can happen if a dependency of a project you depend on with a specific version itself depends on another packages with a version range.

How can other people accidentally or intentionally break your node.js app? Well, they might...

• ... push a new version that no longer supports your preferred version of node.js.
• ... fix a subtle bug that you actually depend on.
• ... accidentally introduce a subtle bug.
• ... be having a bad day.

And, any author at any time can overwrite the package version they have published so one under-thought npm publish -f can mean a subtle bug that steals days of your week.

Usage!

npm install --save foo@0.8.1
./node_modules/.bin/lockdown-relock

npm-lockdown is easy to get started with. It generates a single file that lists the versions and check-sums of the software you depend on, so any time something changes out from under you, npm install will fail and tell you what package has changed.

One Time Project Setup

• npm install the version of lockdown you want: npm install --save lockdown
• add a line to your package.json file: "scripts": { "preinstall": "lockdown" }
• generate a lockdown.json: node_modules/.bin/lockdown-relock
• commit: git add package.json lockdown.json && git commit -m "be safe"

Adding new modules

• npm install the specific dependencies of your app npm install --save foo@0.8.1
• re-generate your lockdown.json: node_modules/.bin/lockdown-relock
• commit: git add package.json lockdown.json && git commit -m "be safe"

Changing dependencies once locked down

You update your dependencies explicitly, relock, and commit:

npm install --save foo@1.2.3
node_modules/.bin/lockdown-relock
git add lockdown.json package.json
git commit -m "move to foo v1.2.3"

done!

Using an npm mirror

You can fetch resources from an npm mirror by specifying the NPM_CONFIG_REGISTRY environment variable when invoking npm install. If NPM_CONFIG_REGISTRY is not specified, http://registry.npmjs.org will be used.

NPM_CONFIG_REGISTRY=http://registry.npmjs.eu/ npm install

Notes:

• You should use the latest stable version of lockdown, find it from the npm registry

Installing dependencies once locked down

npm install

Related Tools

npm shrinkwrap - NPM itself has a feature called "shrinkwrap" that

locks down the versions of a package's dependencies so that you can control exactly which versions of each dependency will be used when your package is installed.

At present (as of npm v1.1.33), the implementation of shrinkwrap has a couple flaws which make it unusable for certain applications:

• No checksums! NPM shrinkwrap does not guarantee bit-wise equality of the installed dependencies, so if an upstream server or author decides to change the contents of version 1.2.3 of foo, you'll install something different than you intended without knowing.
• Does not play nice with optionalDependencies - If you "shrinkwrap" your app and you have an installed dep that is optional, the dependency is no longer optional. This might not be what you want.

NOTE: you can combine lockdown with shrinkwrap just fine. If all you care about is #1 above.

The path forward is to build checksums into shrinkwrap and kick lockdown to the curb, but until then, lockdown solves some problems. (@izs is interested in patches).

npm-seal - Solves the same problem as lockdown in a very different way. Because seal is built to be used in concert with shrinkwrap, it suffers from the optionalDependencies issue described above.