improve readability of dependency tree

camunda · Sep 18, 2023 · 8a52948 · 8a52948
1 parent a3a1613
commit 8a52948
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 11 deletions.
diff --git a/common/dist/index.js b/common/dist/index.js
@@ -163287,8 +163287,32 @@ module.exports = async function (sbomDiff, template, partials = {}) {
     return value + 1;
   });
 
-  handlebars.registerHelper('indent', function(times) {
-    return '&nbsp;'.repeat(times * 2);
+  // stores if the currently rendered item is the last one for each
+  // of the nested lists
+  const currentIndentationState = []; 
+
+  handlebars.registerHelper('indent', function(times, lastItemInList) {
+
+    while (times > currentIndentationState.length) {
+      currentIndentationState.push(false);
+    }
+    while (times < currentIndentationState.length) {
+      currentIndentationState.pop();
+    }
+
+    currentIndentationState[times - 1] = lastItemInList;
+
+    const visualizationComponents = currentIndentationState.map((lastItemInListAtCurrentLevel, index) => {
+      const isMostDeeplyNestedList = index == currentIndentationState.length - 1;
+
+      if (lastItemInListAtCurrentLevel) {
+        return isMostDeeplyNestedList ? ' └─ ' : '    ';
+      } else {
+        return isMostDeeplyNestedList ? ' ├─ ' : ' │  ';
+      }
+    });
+
+    return visualizationComponents.join('');
   });
 
   handlebars.registerHelper('emojifyLicense', function(licenseType) {

diff --git a/common/src/sbom-diff/format-handlebars-template.js b/common/src/sbom-diff/format-handlebars-template.js
@@ -46,8 +46,32 @@ module.exports = async function (sbomDiff, template, partials = {}) {
     return value + 1;
   });
 
-  handlebars.registerHelper('indent', function(times) {
-    return '&nbsp;'.repeat(times * 2);
+  // stores if the currently rendered item is the last one for each
+  // of the nested lists
+  const currentIndentationState = []; 
+
+  handlebars.registerHelper('indent', function(times, lastItemInList) {
+
+    while (times > currentIndentationState.length) {
+      currentIndentationState.push(false);
+    }
+    while (times < currentIndentationState.length) {
+      currentIndentationState.pop();
+    }
+
+    currentIndentationState[times - 1] = lastItemInList;
+
+    const visualizationComponents = currentIndentationState.map((lastItemInListAtCurrentLevel, index) => {
+      const isMostDeeplyNestedList = index == currentIndentationState.length - 1;
+
+      if (lastItemInListAtCurrentLevel) {
+        return isMostDeeplyNestedList ? ' └─ ' : '    ';
+      } else {
+        return isMostDeeplyNestedList ? ' ├─ ' : ' │  ';
+      }
+    });
+
+    return visualizationComponents.join('');
   });
 
   handlebars.registerHelper('emojifyLicense', function(licenseType) {

diff --git a/java-dependency-check/component-diff.hbs b/java-dependency-check/component-diff.hbs
@@ -1,14 +1,14 @@
 {{!-- careful: preserve the double space characters at the end of the content lines to make sure that new lines are generated--}}
-{{#indent nestingLevel}}{{/indent}}{{emojifyChangeType changeType}} {{#baseComponent}}{{ name }}: {{>componentVersion}}{{/baseComponent}} => {{#comparingComponent}}{{>componentVersion}}{{/comparingComponent}}  
+{{#indent nestingLevel lastItemInList}}{{/indent}}{{emojifyChangeType changeType}} {{#baseComponent}}{{ name }}: {{>componentVersion}}{{/baseComponent}} => {{#comparingComponent}}{{>componentVersion}}{{/comparingComponent}}  
 {{#if (shouldRenderComponentDiff this)}}
 {{#each changedDependencies}}
-{{>componentDiff nestingLevel=(increment ../nestingLevel)}}
+{{>componentDiff nestingLevel=(increment ../nestingLevel) lastItemInList=@last}}
 {{/each}}
 {{#each addedDependencies}}
-{{>componentTree nestingLevel=(increment ../nestingLevel) changeType='Added'}}  
+{{>componentTree nestingLevel=(increment ../nestingLevel) lastItemInList=@last changeType='Added'}}  
 {{/each}}
 {{#each removedDependencies}}
-{{>componentTree nestingLevel=(increment ../nestingLevel) changeType='Removed'}}  
+{{>componentTree nestingLevel=(increment ../nestingLevel) lastItemInList=@last changeType='Removed'}}  
 {{/each}}
 {{else if (hasChanges this)}}{{#indent (increment nestingLevel)}}{{/indent}}(Repeating subtree omitted)  
 {{/if}}
diff --git a/java-dependency-check/component-tree.hbs b/java-dependency-check/component-tree.hbs
@@ -1,7 +1,7 @@
-{{#indent nestingLevel}}{{/indent}}{{emojifyChangeType changeType}} {{ name }}:{{>componentVersion}}  
+{{#indent nestingLevel lastItemInList}}{{/indent}}{{emojifyChangeType changeType}} {{ name }}:{{>componentVersion}}  
 {{#if (shouldRenderComponentTree this)}}
 {{#each dependencies}}
-{{>componentTree nestingLevel=(increment ../nestingLevel) changeType=../changeType}}
+{{>componentTree nestingLevel=(increment ../nestingLevel) lastItemInList=@last changeType=../changeType}}
 {{/each}}
 {{else if (hasDependencies this)}}{{#indent (increment nestingLevel)}}{{/indent}}(Repeating subtree omitted)  
 {{/if}}
diff --git a/java-dependency-check/component-version.hbs b/java-dependency-check/component-version.hbs
@@ -1,5 +1,5 @@
 {{#if thirdParty~}}
-[{{ version }}](#{{ renderId }}-{{ urlEncode name }}{{ urlEncode ':' }}{{ urlEncode version }}) {{#if allLicensesGo}}{{emojifyLicense 'Go'}}{{/if}}{{#each carefulLicenseTypes}}{{#if used}}{{emojifyLicense type}}{{/if}}{{/each}}{{#if hasMultipleLicenses}}&#8252;{{/if}}
+<a href="#{{ renderId }}-{{ urlEncode name }}{{ urlEncode ':' }}{{ urlEncode version }}">{{ version }}</a> {{#if allLicensesGo}}{{emojifyLicense 'Go'}}{{/if}}{{#each carefulLicenseTypes}}{{#if used}}{{emojifyLicense type}}{{/if}}{{/each}}{{#if hasMultipleLicenses}}&#8252;{{/if}}
 {{~else~}}
 {{version}}
 {{~/if}}
diff --git a/java-dependency-check/diff.hbs b/java-dependency-check/diff.hbs
@@ -1,9 +1,11 @@
 # Java dependency diff
 
 {{#unless excludeTree}}
+<pre>
 {{#diff.rootComponentDiff}}
 {{>componentDiff nestingLevel=0}}
 {{/diff.rootComponentDiff}}
+</pre>
 {{else}}
 Omitted due to character limit. See workflow artifacts for full diff file.
 {{/unless}}