tarjan-graph - npm Package Compare versions

Comparing version 0.3.0 to 1.0.0

index.js

@@ -1,9 +0,9 @@
-function Vertex(name, successors) {
-	this.name = name;
-	this.successors = successors;
-	this.reset();
-}
+class Vertex {
+	constructor(name, successors) {
+		this.name = name;
+		this.successors = successors;
+		this.reset();
+	}
 
-Vertex.prototype = {
-	reset: function() {
+	reset() {
 		this.index = -1;
@@ -14,19 +14,18 @@ this.lowLink = -1;
 	}
-};
-
-function Graph() {
-	this.vertices = {};
 }
 
-Graph.prototype = {
-	add: function(key, descendants) {
-		var self = this;
 
-		descendants = Array.isArray(descendants) ? descendants : [ descendants ];
+class Graph {
+	constructor() {
+		this.vertices = {};
+	}
 
-		var successors = descendants.map(function(key) {
-			if (!self.vertices[key]) {
-				self.vertices[key] = new Vertex(key, []);
+	add(key, descendants) {
+		descendants = Array.isArray(descendants) ? descendants : [descendants];
+
+		const successors = descendants.map((key) => {
+			if (!this.vertices[key]) {
+				this.vertices[key] = new Vertex(key, []);
 			}
-			return self.vertices[key];
+			return this.vertices[key];
 		});
@@ -40,22 +39,21 @@
 		return this;
-	},
+	}
 
-	reset: function() {
-		var self = this;
-		Object.keys(this.vertices).forEach(function(key) {
-			self.vertices[key].reset();
+	reset() {
+		Object.keys(this.vertices).forEach((key) => {
+			this.vertices[key].reset();
 		});
-	},
+	}
 
-	addAndVerify: function(key, dependencies) {
-		this.add(key, dependencies);
-		var cycles = this.getCycles();
+	addAndVerify(key, descendants) {
+		this.add(key, descendants);
+		const cycles = this.getCycles();
 		if (cycles.length) {
-			var message = 'Detected ' + cycles.length + ' cycle' + (cycles.length === 1 ? '' : 's') + ':';
-			message += '\n' + cycles.map(function(scc) {
-				var names = scc.map(function(v) { return v.name; });
-				return '  ' + names.join(' -> ') + ' -> ' + names[0];
+			let message = `Detected ${cycles.length} cycle${cycles.length === 1 ? '' : 's'}:`;
+			message += '\n' + cycles.map((scc) => {
+				const names = scc.map(v => v.name);
+				return `  ${names.join(' -> ')} -> ${names[0]}`;
 			}).join('\n');
 
-			var err = new Error(message);
+			const err = new Error(message);
 			err.cycles = cycles;
@@ -66,8 +64,8 @@ throw err;
 		return this;
-	},
+	}
 
-	dfs: function(key, visitor) {
+	dfs(key, visitor) {
 		this.reset();
-		var stack = [ this.vertices[key] ],
-			v;
+		const stack = [this.vertices[key]];
+		let v;
 		while (v = stack.pop()) {
@@ -82,12 +80,10 @@ if (v.visited) {
 
-			v.successors.forEach(function(w) {
-				stack.push(w);
-			});
+			v.successors.forEach(w => stack.push(w));
 		}
-	},
+	}
 
-	getDescendants: function(key) {
-		var descendants = [],
-			ignore = true;
-		this.dfs(key, function(v) {
+	getDescendants(key) {
+		const descendants = [];
+		let ignore = true;
+		this.dfs(key, (v) => {
 			if (ignore) {
@@ -100,22 +96,21 @@ //ignore the first node
 		});
+
 		return descendants;
-	},
+	}
 
-	hasCycle: function() {
+	hasCycle() {
 		return this.getCycles().length > 0;
-	},
+	}
 
-	getStronglyConnectedComponents: function() {
-		var self = this;
-
-		var V = Object.keys(self.vertices).map(function(key) {
-			self.vertices[key].reset();
-			return self.vertices[key];
+	getStronglyConnectedComponents() {
+		const V = Object.keys(this.vertices).map((key) => {
+			this.vertices[key].reset();
+			return this.vertices[key];
 		});
 
-		var index = 0,
-			stack = [],
-			components = [];
+		let index = 0;
+		const stack = [];
+		const components = [];
 
-		function stronglyConnect(v) {
+		const stronglyConnect = (v) => {
 			v.index = index;
@@ -127,3 +122,3 @@ v.lowLink = index;
 
-			v.successors.forEach(function(w) {
+			v.successors.forEach((w) => {
 				if (w.index < 0) {
@@ -138,5 +133,6 @@ stronglyConnect(w);
 			if (v.lowLink === v.index) {
-				var scc = [];
+				const scc = [];
+				let w;
 				do {
-					var w = stack.pop();
+					w = stack.pop();
 					w.onStack = false;
@@ -148,3 +144,3 @@ scc.push(w);
 			}
-		}
+		};
 
@@ -158,17 +154,14 @@ V.forEach(function(v) {
 		return components;
-	},
+	}
 
-	getCycles: function() {
-		return this.getStronglyConnectedComponents().filter(function(scc) {
-			return scc.length > 1;
-		});
-	},
+	getCycles() {
+		return this.getStronglyConnectedComponents().filter(scc => scc.length > 1);
+	}
 
-	clone: function() {
-		var graph = new Graph(),
-			self = this;
+	clone() {
+		const graph = new Graph();
 
-		Object.keys(this.vertices).forEach(function(key) {
-			var v = self.vertices[key];
-			graph.add(v.name, v.successors.map(function(w) {
+		Object.keys(this.vertices).forEach((key) => {
+			const v = this.vertices[key];
+			graph.add(v.name, v.successors.map((w) => {
 				return w.name;
@@ -179,21 +172,20 @@ }));
 		return graph;
-	},
+	}
 
-	toDot: function() {
-		var V = this.vertices,
-		lines = [ 'digraph {' ];
+	toDot() {
+		const V = this.vertices;
+		const lines = [ 'digraph {' ];
 
-		var cycles = this.getCycles();
-		cycles.forEach(function(scc, i) {
+		this.getCycles().forEach((scc, i) => {
 			lines.push('  subgraph cluster' + i + ' {');
 			lines.push('    color=red;');
-			lines.push('    ' + scc.map(function(v) { return v.name; }).join('; ') + ';');
+			lines.push('    ' + scc.map(v => v.name).join('; ') + ';');
 			lines.push('  }');
 		});
 
-		Object.keys(V).forEach(function(key) {
-			var v = V[key];
+		Object.keys(V).forEach((key) => {
+			const v = V[key];
 			if (v.successors.length) {
-				v.successors.forEach(function(w) {
-					lines.push('  ' + v.name + ' -> ' + w.name);
+				v.successors.forEach((w) => {
+					lines.push(`  ${v.name} -> ${w.name}`);
 				});
@@ -206,4 +198,4 @@ }
 	}
-};
+}
 
 module.exports = Graph;

package.json

 {
 	"name": "tarjan-graph",
-	"version": "0.3.0",
+	"version": "1.0.0",
 	"license": "MIT",
-
 	"scripts": {
 		"test": "node_modules/.bin/mocha -R spec tests"
 	},
-
 	"repository": {
@@ -14,9 +12,12 @@ "type": "git",
 	},
-
-	"files": [ "index.js" ],
-
+	"files": [
+		"index.js",
+		"index.d.ts"
+	],
 	"devDependencies": {
-		"mocha": "2.3.4",
-		"should": "7.1.1"
-	}
+		"mocha": "4.0.1",
+		"should": "13.1.2",
+		"typescript": "2.5.3"
+	},
+	"types": "./index.d.ts"
 }

README.md

@@ -14,2 +14,4 @@ # tarjan-graph
 ## Installation
+Note: as of v1.0.0 this library requires node >= v8.0.0.
+Use v0.3.0 for node < v8.0.0. 
 ```
@@ -26,5 +28,5 @@ npm install tarjan-graph
 ```javascript
-var Graph = require('tarjan-graph');
+const Graph = require('tarjan-graph');
 
-var graph = new Graph()
+const graph = new Graph()
   .add('a', ['b', 'c'])
@@ -68,4 +70,4 @@ .add('b', ['d', 'e'])
 //depth-first search (pre-order)
-graph.dfs('g', function(v) {
-  console.log(v.name + ': ' + v.successors.map(function(w) { return w.name; }).join(', '));
+graph.dfs('g', (v) => {
+  console.log(v.name + ': ' + v.successors.map(w => w.name).join(', '));
 });
@@ -72,0 +74,0 @@ /*

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6828

6.22%

Number of package files

4

33.33%

Lines of code

181

10.37%

Number of low quality alerts

1

-50%

Number of lines in readme file

121

1.68%

Worsened metrics

Dev dependency count

3

50%

No dependency changes