cortex-shrinkwrap - npm Package Compare versions

Comparing version 1.1.2 to 2.0.0

lib/index.js

@@ -11,6 +11,3 @@ var path = require('path');
 
-module.exports = function(pkg, cache_root, options, callback) {
-  if (!pkg || !cache_root) {
-    return callback(new Error("Must provide pkg and cache_root"));
-  }
+module.exports = function(pkg, options, callback) {
 
@@ -24,5 +21,12 @@ if (typeof options == 'function' && arguments.length == 3) {
 
+  var cache_root = options.cache_root;
+  var built_root = options.built_root;
+
+  if (!pkg || !cache_root || !built_root) {
+    return callback(new Error("Must provide pkg, cache_root and built_root"));
+  }
+
   var enableDev = options.dev;
   var enableAsync = options.async;
-  var stableOnly = options.stableOnly !== false;
+  var stableOnly = options.stable_only !== false;
   var merge = !! options.merge;
@@ -35,4 +39,6 @@
   var firstRoot = true;
-  var traveller = shrinktree(pkg, cache_root, {
-    stableOnly: stableOnly,
+  var traveller = shrinktree(pkg, {
+    cache_root: cache_root,
+    built_root: built_root,
+    stable_only: stableOnly,
     merge: merge,
@@ -123,3 +129,2 @@ pkgDeps: function(pkg) {
     });
-
   });
@@ -133,3 +138,2 @@
 
-
 function isEmptyObject(obj) {
@@ -136,0 +140,0 @@ if (!obj) return true;

lib/shrinktree.js

@@ -10,9 +10,8 @@ var path = require('path');
 
-module.exports = function(name, from, cache_root, options, callback) {
+module.exports = function(name, from, options, callback) {
   var pkg;
-  if (arguments.length <= 4 && typeof name != 'string') {
+  if (arguments.length <= 3 && typeof name != 'string') {
     pkg = name;
     callback = options;
-    options = cache_root;
-    cache_root = from;
+    options = from;
     from = undefined;
@@ -28,7 +27,12 @@ }
 
+  var cache_root = options.cache_root;
+  var built_root = options.built_root;
+
+  if (!cache_root || !built_root)
+    return callback(new Error("Must provide cache_root and built_root"));
+
   var merge = !! options.merge;
   delete options.merge;
 
-
-  var traveller = depTravel(cache_root, options);
+  var traveller = depTravel(cache_root, built_root, options);
   var trees = {};
@@ -35,0 +39,0 @@

package.json

 {
   "name": "cortex-shrinkwrap",
-  "version": "1.1.2",
+  "version": "2.0.0",
   "description": "Lock down the versions of a package's dependencies",
@@ -33,7 +33,7 @@ "main": "./lib/index.js",
     "async": "~0.9.0",
-    "read-cortex-json": "~2.0.0",
+    "read-cortex-json": "^2.0.0",
     "semver": "~2.3.0",
     "sorted-object": "~1.0.0",
-    "cortex-deps-traveller": "~0.0.1"
+    "cortex-deps-traveller": "^1.0.0"
   }
-}
+}

README.md

@@ -14,25 +14,2 @@ # Cortex Shrinkwrap
 
-## Usage
-
-``` bash
-cortex shrinkwrap [--dev] [--async|--no-async] [--enable-prerelease]
-```
-
-See more info by:
-
-``` bash
-cortex shrinkwrap -h
-```
-
-```
-Usage: cortex shrinkwrap [--dev] [--async] [options]
-
-Options:
-  -v, --version         print version
-  -h, --help    show help
-  --dev, --no-dev       shrinkwrap devDependencies or not, disabled by default
-  --async, --no-async   shrinkwrap asyncDependencies or not, enabled by default
-  --enable-prerelease   shrinkwrap will accept pre-release version in dependency analyze, disable by default% 
-```
-
 ## API
@@ -45,3 +22,3 @@
 
-var traveller = shrinkwrap(pkg, cache_root, options, function(err, shrinked) {
+var traveller = shrinkwrap(pkg, options, function(err, shrinked) {
     // console.log(shrinked);
@@ -62,3 +39,3 @@ });
 
-### shrinkwrap(pkg, cache_root, [options], callback): Traveller
+### shrinkwrap(pkg, [options], callback): Traveller
 
@@ -71,8 +48,7 @@ Generate shrinkwrap.json from pkg, return a Traveller object, see [cortex-deps-traveller](http://github.com/cortexjs/cortex-deps-traveller) for more details;
 
-#### cache_root
 
-Path of cortex build cache.
-
 #### Options
 
+* cacheRoot(=require=): path of cortex package cache
+* builtRoot(=require=): path of directory where cortex packages will be built to
 * dev: whehter include `devDependencies`
@@ -87,3 +63,3 @@ * async: whether incldue `asyncDependencies`
 
-### shrinktree((name, range)|pkg, cache_root, [options], callback)
+### shrinktree((name, range)|pkg, [options], callback)
 
@@ -96,3 +72,3 @@ Generate a simple deps tree with information of shrinkwrap.json
 
-shrinktree('deep-eql', "~0.1.0", cache_root, function(err, tree) {
+shrinktree('deep-eql', "~0.1.0", { cacheRoot: cache_root, builtRoot: built_root }, function(err, tree) {
   
@@ -109,3 +85,5 @@ });
   }
-}, cache_root, {
+}, {
+  cacheRoot: cache_root,
+  builtRoot: built_root,
   enableDev: true
@@ -130,6 +108,2 @@ }, function(err, tree) {
 
-#### cache_root
-
-Path of cortex build cache
-
 #### Options
@@ -136,0 +110,0 @@

No alert changes

Improved metrics

Lines of code

248

increased by2.9%

Worsened metrics

Total package byte prevSize

11788

decreased by-1.43%

Number of lines in readme file

111

decreased by-18.98%

Dependency changes

• + Addedcortex-deps-traveller@1.2.4(transitive)

• + Addedread-cortex-json@2.3.0(transitive)

• - Removedcortex-deps-traveller@0.0.3(transitive)

• - Removedcortex-playground@0.1.9(transitive)

• - Removedfs-expand@0.1.4(transitive)

• - Removedfs-extra@0.10.0(transitive)

• - Removedglob@4.5.3(transitive)

• - Removedjsonfile@1.2.0(transitive)

• - Removedminimatch@2.0.10(transitive)

• - Removedncp@0.5.1(transitive)

• - Removedread-cortex-json@2.0.32.1.1(transitive)

• - Removedtest-fixture@1.0.2(transitive)

• - Removedtmp@0.0.23(transitive)

• Updatedcortex-deps-traveller@^1.0.0

• Updatedread-cortex-json@^2.0.0