@code-pushup/utils 0.3.1 → 0.4.0

package/index.js

@@ -905,6 +905,30 @@ function throwIsNotPresentError(itemName, presentPlace) {
 function getPluginNameFromSlug(slug, plugins) {
   return plugins.find(({ slug: pluginSlug }) => pluginSlug === slug)?.title || slug;
 }
+function compareIssues(a, b) {
+  if (a.severity !== b.severity) {
+    return -compareIssueSeverity(a.severity, b.severity);
+  }
+  if (!a.source && b.source) {
+    return -1;
+  }
+  if (a.source && !b.source) {
+    return 1;
+  }
+  if (a.source?.file !== b.source?.file) {
+    return a.source?.file.localeCompare(b.source?.file || "") || 0;
+  }
+  if (!a.source?.position && b.source?.position) {
+    return -1;
+  }
+  if (a.source?.position && !b.source?.position) {
+    return 1;
+  }
+  if (a.source?.position?.startLine !== b.source?.position?.startLine) {
+    return (a.source?.position?.startLine || 0) - (b.source?.position?.startLine || 0);
+  }
+  return 0;
+}
 
 // packages/utils/src/lib/execute-process.ts
 var ProcessError = class extends Error {
@@ -1236,7 +1260,7 @@ function reportToAuditsSection(report) {
       }
       const detailsTableData = [
         detailsTableHeaders,
-        ...audit.details.issues.map((issue) => {
+        ...audit.details.issues.sort(compareIssues).map((issue) => {
           const severity = `${getSeverityIcon(issue.severity)} <i>${issue.severity}</i>`;
           const message = issue.message;
           if (!issue.source) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "dependencies": {
     "@code-pushup/models": "*",
     "bundle-require": "^4.0.1",

package/src/lib/report.d.ts

@@ -1,4 +1,4 @@
-import { CategoryRef, IssueSeverity as CliIssueSeverity, Format, PersistConfig, Report } from '@code-pushup/models';
+import { CategoryRef, IssueSeverity as CliIssueSeverity, Format, Issue, PersistConfig, Report } from '@code-pushup/models';
 import { EnrichedAuditReport, EnrichedScoredAuditGroupWithAudits, ScoredReport, WeighedAuditReport } from './scoring';
 export declare const FOOTER_PREFIX = "Made with \u2764 by";
 export declare const CODE_PUSHUP_DOMAIN = "code-pushup.dev";
@@ -27,4 +27,5 @@ export declare function loadReport<T extends Format>(options: Required<Pick<Pers
 }): Promise<LoadedReportFormat<T>>;
 export declare function throwIsNotPresentError(itemName: string, presentPlace: string): never;
 export declare function getPluginNameFromSlug(slug: string, plugins: ScoredReport['plugins']): string;
+export declare function compareIssues(a: Issue, b: Issue): number;
 export {};