Added clustering / highlight feature for conflicting versions

Author: Michael Kriegel

README.md

@@ -24,6 +24,7 @@ node-dependency-visualizer has the following options:
 | :----- | :---------- |
 | --treewalk-prefix (-p) PREFIX | The tree walk only continues on modules, that start with PREFIX. |
 | --show-leaf-dependencies (-l) | The leaf dependencies (those on which recursion stops) are only emitted when this option is set. |
+| --no-highlight-conflicting-versions (-c) | Does not highlight / cluster different versions of the same module. |
 
 node-dependency-visualizer emits a dot digraph, which can be piped directly into graphviz dot.
 

js/cli.js

@@ -7,6 +7,7 @@ const commandLineArgs = require('command-line-args');
 const optionDefinitions = [
 	{ name: 'treewalk-prefix', alias: 'p', type: String },
 	{ name: 'show-leaf-dependencies', alias: 'l', type: Boolean },
+	{ name: 'no-highlight-conflicting-versions', alias: 'c', type: Boolean },
 ];
 
 const options = commandLineArgs(optionDefinitions);
@@ -22,5 +23,5 @@ ls.stdout.on("data", (chunk) => {
 
 ls.stdout.on("close", () => {
 	const tree = JSON.parse(data);
-	process.stdout.write(treeWalk(tree, options["treewalk-prefix"], options["show-leaf-dependencies"]));
+	process.stdout.write(treeWalk(tree, options["treewalk-prefix"], options["show-leaf-dependencies"], options["no-highlight-conflicting-versions"] !== true));
 });

js/tree.js

@@ -1,36 +1,61 @@
 
-function treeWalk(name, node, stopTreewalkPrefix, showUnprefixedDependencies) {
+function treeWalk(name, node, stopTreewalkPrefix, showUnprefixedDependencies, depVersions) {
 	let result = "";
-	const depVersions = new Map();
 	const version = node.version;
-	const lastDepVersion = depVersions.get(name);
 	const nodeName = `${name}\\n${version}`;
-	if (lastDepVersion !== undefined && lastDepVersion !== version) {
-		const lastDepVersionNodeName = `${name}\\n${lastDepVersion}`;
-		result += `  "${nodeName}"[fillcolor=red]\n`;
-		result += `  "${lastDepVersionNodeName}"[fillcolor=red]\n`;
-		result += `"${lastDepVersionNodeName}" -> "${nodeName}"[color=red arrowhead=none]`;
+	if (depVersions !== undefined && version !== undefined) {
+		const duplicates = depVersions.get(name);
+		if (duplicates !== undefined) {
+			if (duplicates.has(version) === false) duplicates.add(version);
+		} else {
+			const duplicates = new Set();
+			duplicates.add(version);
+			depVersions.set(name, duplicates);
+		}
 	}
-	if (version !== undefined) depVersions.set(name, version);
 	for (const depName in node.dependencies) {
 		const dependency = node.dependencies[depName];
 		const depNodeName = `${depName}\\n${dependency.version}`;
 		if (stopTreewalkPrefix === undefined || depName.startsWith(stopTreewalkPrefix)) {
 			result += `  "${nodeName}" -> "${depNodeName}"\n`;
-			result += treeWalk(depName, dependency, stopTreewalkPrefix, showUnprefixedDependencies);
+			result += treeWalk(depName, dependency, stopTreewalkPrefix, showUnprefixedDependencies, depVersions);
 		} else if (showUnprefixedDependencies) {
 			result += `  "${nodeName}" -> "${depNodeName}"\n`;
 		}
 	}
 	return result;
 }
 
-module.exports = function(node, stopTreewalkPrefix, showUnprefixedDependencies) {
-	return `strict digraph DeviceTypeHierarchy_Oblamatikproducts {
-	rankdir=BT;
-	compound=true;
-	node[shape=record,style=filled,fillcolor=white]
-	${treeWalk(node.name, node, stopTreewalkPrefix, showUnprefixedDependencies)}
+module.exports = function(node, stopTreewalkPrefix, showUnprefixedDependencies, highlightConflictingVersions) {
+	const depVersions = highlightConflictingVersions === true ? new Map() : undefined;
+	const data = treeWalk(node.name, node, stopTreewalkPrefix, showUnprefixedDependencies, depVersions);
+	let conflicts = "";
+	if (highlightConflictingVersions) {
+		for (const [pkgName, versions] of depVersions) {
+			if (versions.size > 1) {
+				conflicts += `  subgraph "cluster_${pkgName}" {
+    node[shape=rectangle,style=filled,fillcolor=white]
+    edge[style=invis];
+    color=red;
+`;
+				const versionsArray = Array.from(versions);
+				while (versionsArray.length > 0) {
+					const version = versionsArray.pop();
+					for (let i = 0; i < versionsArray.length; i++) {
+						const otherVersion = versionsArray[i];
+						conflicts += `    "${pkgName}\\n${version}" -> "${pkgName}\\n${otherVersion}";\n`
+					}
+				}
+				conflicts += "  }\n";
+			}
+		}
+	}
+	return `strict digraph DeviceTypeHierarchy {
+  rankdir=BT;
+  compound=true;
+  node[shape=rectangle,style=filled,fillcolor=white]
+${conflicts}
+${data}
 }
 `;
 };