directory-layout - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

lib/generate.js

@@ -6,2 +6,3 @@ var fs = require('fs');
 var byline = require('byline');
+var Promise = require('bluebird');
 
@@ -62,5 +63,8 @@ function parseFilePaths (root, filePaths, options) {
 	var layout = "";
+	var defer = Promise.defer();
 
 	dir.paths(root, function(err, paths) {
-	    if (err) throw err;
+	    if (err) {
+    		defer.reject();
+	    }
 
@@ -71,3 +75,6 @@ paths = parsePaths(paths);
 	    writeToFile(paths, options);
+	    defer.resolve();
 	});
+
+	return defer.promise;
 }
@@ -74,0 +81,0 @@

lib/verify.js

 var fs = require('fs');
 var path = require('path');
 var byline = require('byline');
+var Promise = require('bluebird');
 
@@ -37,3 +38,4 @@
 	var nestedLevel = [];
-	var failure = 0;
+	var deferred = Promise.defer();
+    var failures = [];
 
@@ -68,14 +70,15 @@ readStream
 	    if(!checkIfResourceExists(location)) {
-	    	console.log("Issue with: " + location);
-	    	failure++;
+	    	failures.push(location);
 	    }
 	  })
 	  .on('end', function () {
-	  	if(failure > 0) {
-  			console.log('\n' + failure + ' failure(s) found');
+	  	if(failures.length > 0) {
+	  		deferred.reject(failures);
 	  	}
 	  	else {
-	  		console.log('0 failure, verified successfully.');
+	  		deferred.resolve();
 	  	}
 	  });
+
+	  return deferred.promise;
 };
@@ -82,0 +85,0 @@

package.json

 {
   "name": "directory-layout",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Verifies directory layout for existence of files and folders in specified positions",
@@ -8,4 +8,17 @@ "main": "lib/verify.js",
   "license": "MIT",
+  "directories": {
+    "test": "test"
+  },
+  "bin": {
+    "verify": "bin/verify.js",
+    "generate": "bin/generate.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ApoorvSaxena/grunt-directory-layout"
+  },
   "dependencies": {
+    "bluebird": "^3.3.5",
     "byline": "^4.2.1",
+    "commander": "^2.9.0",
     "node-dir": "^0.1.11",
@@ -18,3 +31,10 @@ "underscore": "^1.8.3"
     "test": "npm run test-layout-generator && npm run test-layout-verifier"
-  }
+  },
+  "keywords": [
+    "directory",
+    "layout",
+    "structure",
+    "test"
+  ],
+  "readmeFilename": "README.md"
 }

README.md

@@ -5,5 +5,5 @@ ### Directory Layout Verifier
 
-Creation of directory structure is also automated, thus you don't need to create it by yourself. Checkout our tests folder for further understanding.
+Creation of directory structure is also automated, checkout our [tests](https://github.com/ApoorvSaxena/directory-layout/tree/master/test) folder for further understanding.
 
-We've used markdown syntax to store the directory structure, easy for you to verify visually (if possible).
+We've used markdown syntax to store the directory structure, easy for you to verify visually. Here's an [example](https://raw.githubusercontent.com/ApoorvSaxena/directory-layout/master/test/output/layout.md).
 
@@ -17,8 +17,12 @@ ##### Usage:
 
-LayoutGenerator.generate('test/fixtures/', {
-	output: './test/output/layout.md',
-	ignore: [
-		'.DS_Store'
-	]
-});
+LayoutGenerator
+	.generate('test/fixtures/', {
+		output: './test/output/layout.md',
+		ignore: [
+			'.DS_Store'
+		]
+	})
+	.then(function() {
+		console.log('Layout successfully generated');
+	});
 ```
@@ -31,5 +35,15 @@
 
-LayoutVerifier.verify('test/output/layout.md', {
-	root: './test/fixtures'
-});
+LayoutVerifier
+	.verify('test/output/layout.md', {
+		root: './test/fixtures'
+	})
+	.then(function() {
+		console.log('Successfully resolved');
+	})
+	.catch(function(failures) {
+		console.log('Failures found at: ');
+		for (var i = 0; i < failures.length; i++) {
+			console.log("- " + failures[i]);
+		}
+	});
 ```
@@ -36,0 +50,0 @@

test/generate.js

 var LayoutGenerator = require('../lib/generate.js');
 
-LayoutGenerator.generate('test/fixtures/', {
-	output: './test/output/layout.md',
-	ignore: [
-		'.DS_Store'
-	]
-});
+LayoutGenerator
+	.generate('test/fixtures/', {
+		output: './test/output/layout.md',
+		ignore: [
+			'.DS_Store'
+		]
+	})
+	.then(function() {
+		console.log('Layout successfully generated');
+	});

test/verify.js

 var LayoutVerifier = require('../lib/verify.js');
 
-LayoutVerifier.verify('test/output/layout.md', {
-	root: './test/fixtures'
-});
+LayoutVerifier
+	.verify('test/output/layout.md', {
+		root: './test/fixtures'
+	})
+	.then(function() {
+		console.log('Successfully resolved');
+	})
+	.catch(function(failures) {
+		console.log('Failures found at: ');
+		for (var i = 0; i < failures.length; i++) {
+			console.log("- " + failures[i]);
+		}
+	});

Fixed alerts

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8299

increased by50.34%

Number of package files

11

increased by22.22%

Lines of code

197

increased by44.85%

Number of lines in readme file

49

increased by40%

Number of low supply chain risk alerts

2

decreased by-33.33%

Worsened metrics

Dependency count

5

increased by66.67%

Dependency changes

• + Addedbluebird@^3.3.5

• + Addedcommander@^2.9.0

• + Addedbluebird@3.7.2(transitive)

• + Addedcommander@2.20.3(transitive)