NEW @W-20028078@ Updated HTML template (#377)

jfeingold35 · web-flow · commit 21f4668528f4 · 2025-10-27T14:17:47.000-05:00
diff --git a/packages/code-analyzer-core/output-templates/html-template-0.0.14.txt b/packages/code-analyzer-core/output-templates/html-template-0.0.14.txt
@@ -237,8 +237,16 @@
           );
         }
         getLocation(violation) {
-          const position = this.getPosition(violation);
-          return `<ul class="locations"><li><span class="file">${position ? `${violation.file} (${position})` : violation.file}</span></li></ul>`;
+          var _a, _b;
+          const position = this.getPosition(violation),
+            location = position
+              ? `${violation.file} (${position})`
+              : violation.file,
+            comment =
+              (_b = (_a = violation.locations) == null ? void 0 : _a[0]) == null
+                ? void 0
+                : _b.comment;
+          return `<ul class="locations"><li><span class="file">${location}</span>${comment ? `<span class="comment">${comment}</span>` : ""}</li></ul>`;
         }
         getLocationsList(violation) {
           var _a;
@@ -1793,7 +1801,7 @@
           Generated by Code Analyzer from path:
 
 <!-- START OF RUNDIR -->
-        <span class="rundir">{{###RUNDIR###}}</span>
+        <code class="rundir">{{###RUNDIR###}}</code>
 <!-- END OF RUNDIR -->
 
         </p>
diff --git a/packages/code-analyzer-core/package.json b/packages/code-analyzer-core/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/code-analyzer-core",
   "description": "Core Package for the Salesforce Code Analyzer",
-  "version": "0.39.0",
+  "version": "0.40.0-SNAPSHOT",
   "author": "The Salesforce Code Analyzer Team",
   "license": "BSD-3-Clause",
   "homepage": "https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/overview",
@@ -72,4 +72,4 @@
       "!src/index.ts"
     ]
   }
-}
+}
diff --git a/packages/code-analyzer-core/src/output-formats/results/html-run-results-format.ts b/packages/code-analyzer-core/src/output-formats/results/html-run-results-format.ts
@@ -8,7 +8,7 @@ import {
     toJsonResultsOutput
 } from "./json-run-results-format";
 
-const HTML_TEMPLATE_VERSION: string = '0.0.13';
+const HTML_TEMPLATE_VERSION: string = '0.0.14';
 const HTML_TEMPLATE_FILE: string = path.resolve(__dirname, '..', '..', '..', 'output-templates', `html-template-${HTML_TEMPLATE_VERSION}.txt`);
 
 /**
diff --git a/packages/code-analyzer-core/test/test-data/expectedOutputFiles/multipleViolations.goldfile.html b/packages/code-analyzer-core/test/test-data/expectedOutputFiles/multipleViolations.goldfile.html
@@ -237,8 +237,16 @@
           );
         }
         getLocation(violation) {
-          const position = this.getPosition(violation);
-          return `<ul class="locations"><li><span class="file">${position ? `${violation.file} (${position})` : violation.file}</span></li></ul>`;
+          var _a, _b;
+          const position = this.getPosition(violation),
+            location = position
+              ? `${violation.file} (${position})`
+              : violation.file,
+            comment =
+              (_b = (_a = violation.locations) == null ? void 0 : _a[0]) == null
+                ? void 0
+                : _b.comment;
+          return `<ul class="locations"><li><span class="file">${location}</span>${comment ? `<span class="comment">${comment}</span>` : ""}</li></ul>`;
         }
         getLocationsList(violation) {
           var _a;
@@ -1793,7 +1801,7 @@ <h4 aria-hidden="true">Group</h4>
           Generated by Code Analyzer from path:
 
 <!-- START OF RUNDIR -->
-        <span class="rundir">{{###RUNDIR###}}</span>
+        <code class="rundir">{{###RUNDIR###}}</code>
 <!-- END OF RUNDIR -->
 
         </p>
diff --git a/packages/code-analyzer-core/test/test-data/expectedOutputFiles/unexpectedEngineErrorViolation.goldfile.html b/packages/code-analyzer-core/test/test-data/expectedOutputFiles/unexpectedEngineErrorViolation.goldfile.html
@@ -237,8 +237,16 @@
           );
         }
         getLocation(violation) {
-          const position = this.getPosition(violation);
-          return `<ul class="locations"><li><span class="file">${position ? `${violation.file} (${position})` : violation.file}</span></li></ul>`;
+          var _a, _b;
+          const position = this.getPosition(violation),
+            location = position
+              ? `${violation.file} (${position})`
+              : violation.file,
+            comment =
+              (_b = (_a = violation.locations) == null ? void 0 : _a[0]) == null
+                ? void 0
+                : _b.comment;
+          return `<ul class="locations"><li><span class="file">${location}</span>${comment ? `<span class="comment">${comment}</span>` : ""}</li></ul>`;
         }
         getLocationsList(violation) {
           var _a;
@@ -1793,7 +1801,7 @@ <h4 aria-hidden="true">Group</h4>
           Generated by Code Analyzer from path:
 
 <!-- START OF RUNDIR -->
-        <span class="rundir">{{###RUNDIR###}}</span>
+        <code class="rundir">{{###RUNDIR###}}</code>
 <!-- END OF RUNDIR -->
 
         </p>
diff --git a/packages/code-analyzer-core/test/test-data/expectedOutputFiles/zeroViolations.goldfile.html b/packages/code-analyzer-core/test/test-data/expectedOutputFiles/zeroViolations.goldfile.html
@@ -237,8 +237,16 @@
           );
         }
         getLocation(violation) {
-          const position = this.getPosition(violation);
-          return `<ul class="locations"><li><span class="file">${position ? `${violation.file} (${position})` : violation.file}</span></li></ul>`;
+          var _a, _b;
+          const position = this.getPosition(violation),
+            location = position
+              ? `${violation.file} (${position})`
+              : violation.file,
+            comment =
+              (_b = (_a = violation.locations) == null ? void 0 : _a[0]) == null
+                ? void 0
+                : _b.comment;
+          return `<ul class="locations"><li><span class="file">${location}</span>${comment ? `<span class="comment">${comment}</span>` : ""}</li></ul>`;
         }
         getLocationsList(violation) {
           var _a;
@@ -1793,7 +1801,7 @@ <h4 aria-hidden="true">Group</h4>
           Generated by Code Analyzer from path:
 
 <!-- START OF RUNDIR -->
-        <span class="rundir">{{###RUNDIR###}}</span>
+        <code class="rundir">{{###RUNDIR###}}</code>
 <!-- END OF RUNDIR -->
 
         </p>

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@salesforce/code-analyzer-core",`
`3`	`3`	`"description": "Core Package for the Salesforce Code Analyzer",`
`4`		`- "version": "0.39.0",`
	`4`	`+ "version": "0.40.0-SNAPSHOT",`
`5`	`5`	`"author": "The Salesforce Code Analyzer Team",`
`6`	`6`	`"license": "BSD-3-Clause",`
`7`	`7`	`"homepage": "https://developer.salesforce.com/docs/platform/salesforce-code-analyzer/overview",`
`@@ -72,4 +72,4 @@`
`72`	`72`	`"!src/index.ts"`
`73`	`73`	`]`
`74`	`74`	`}`
`75`		`-}`
	`75`	`+}`