cortex-shrinkwrap

Lock down the versions of a package's dependencies

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
cortex-shrinkwrap
025.0.010 years ago10 years agoMinified + gzip package size for cortex-shrinkwrap in KB

Readme

Cortex Shrinkwrap
NPM version Build Status
This command will lock down the versions of a package's dependencies and generate a cortex-shrinkwrap.json file in your package directory.

Install

npm install cortex-shrinkwrap -g

API

Also this lib can be used in nodejs.
var shrinkwrap = require('cortex-shrinkwrap');

var traveller = shrinkwrap(pkg, built_root, options, function(err, shrinked) {
    // console.log(shrinked);
});

traveller.on('ignoreDev', function(pkgName) {
  
});

traveller.on('ignoreAsync', function(pkgName) {
  
});

shrinkwrap(pkg, builtroot, options, callback): Traveller

Generate shrinkwrap.json from pkg, return a Traveller object, see cortex-deps-traveller for more details;

pkg

Pakcage information stored in cortex.json.

builtroot(=require=): path of directory where cortex packages will be built to

Options

  • dev: whehter include devDependencies
  • async: whether incldue asyncDependencies
  • stableOnly: only include stable version in shrinkwrap, default value is =false=

callback(err, shrinkedJson)

shrinktree((name, range)|pkg, options, callback)

Generate a simple deps tree with information of shrinkwrap.json
var shrinktree = require('cortex-shrinkwrap').shrinktree

shrinktree('deep-eql', "~0.1.0", built_root,  function(err, tree) {
  
});

// or provide a package json if already have one

shrinktree({
  name: 'deep-eql',
  version: '0.1.0',
  dependencies: {
     'type-detect': "~1.0.0"
  }
}, built_root, {
  enableDev: true
}, function(err, tree) {

});

name

Package name of the tree root

range

Range of the tree root

pkg

Package json as the root

Options

The same as options in shrinkwrap

License

(The MIT License)
Copyright (c) 2014, Villa.Gao <jky239@gmail.com>;
All rights reserved.