@code-pushup/core 0.8.8 → 0.8.10

package/index.js

@@ -808,13 +808,13 @@ function getGroupWithAudits(refSlug, refPlugin, plugins) {
     },
     []
   );
-  const audits = groupAudits.sort(sortCategoryAudits);
+  const audits = groupAudits.sort(compareCategoryAudits);
   return {
     ...groupWithAudits,
     audits
   };
 }
-function sortCategoryAudits(a, b) {
+function compareCategoryAudits(a, b) {
   if (a.weight !== b.weight) {
     return b.weight - a.weight;
   }
@@ -826,7 +826,7 @@ function sortCategoryAudits(a, b) {
   }
   return a.title.localeCompare(b.title);
 }
-function sortAudits(a, b) {
+function compareAudits(a, b) {
   if (a.score !== b.score) {
     return a.score - b.score;
   }
@@ -1120,23 +1120,18 @@ function reportToCategoriesSection(report) {
       category.score
     )} Score:  ${style(formatReportScore(category.score))}`;
     const categoryDocs = getDocsAndDescription(category);
-    const auditsAndGroups = category.refs.reduce(
-      (acc2, ref) => ({
-        ...acc2,
-        ...ref.type === "group" ? {
-          groups: [
-            ...acc2.groups,
-            getGroupWithAudits(ref.slug, ref.plugin, plugins)
-          ]
-        } : {
-          audits: [...acc2.audits, getAuditByRef(ref, plugins)]
-        }
-      }),
-      { groups: [], audits: [] }
-    );
-    const audits = auditsAndGroups.audits.sort(sortCategoryAudits).map((audit) => auditItemToCategorySection(audit, plugins)).join(NEW_LINE);
-    const groups = auditsAndGroups.groups.map((group) => groupItemToCategorySection(group, plugins)).join("");
-    return acc + NEW_LINE + categoryTitle + NEW_LINE + NEW_LINE + categoryDocs + categoryScore + NEW_LINE + groups + NEW_LINE + audits;
+    const categoryMDItems = category.refs.reduce((acc2, ref) => {
+      if (ref.type === "group") {
+        const group = getGroupWithAudits(ref.slug, ref.plugin, plugins);
+        const mdGroupItem = groupItemToCategorySection(group, plugins);
+        return acc2 + mdGroupItem + NEW_LINE;
+      } else {
+        const audit = getAuditByRef(ref, plugins);
+        const mdAuditItem = auditItemToCategorySection(audit, plugins);
+        return acc2 + mdAuditItem + NEW_LINE;
+      }
+    }, "");
+    return acc + NEW_LINE + categoryTitle + NEW_LINE + NEW_LINE + categoryDocs + categoryScore + NEW_LINE + categoryMDItems;
   }, "");
   return h2("\u{1F3F7} Categories") + NEW_LINE + categoryDetails;
 }
@@ -1175,7 +1170,7 @@ function groupItemToCategorySection(group, plugins) {
 }
 function reportToAuditsSection(report) {
   const auditsSection = report.plugins.reduce((acc, plugin) => {
-    const auditsData = plugin.audits.sort(sortAudits).reduce((acc2, audit) => {
+    const auditsData = plugin.audits.reduce((acc2, audit) => {
       const auditTitle = `${audit.title} (${getPluginNameFromSlug(
         audit.plugin,
         report.plugins
@@ -1198,7 +1193,7 @@ function reportToAuditsSection(report) {
       }
       const detailsTableData = [
         detailsTableHeaders,
-        ...audit.details.issues.sort(compareIssues).map((issue) => {
+        ...audit.details.issues.map((issue) => {
           const severity = `${getSeverityIcon(issue.severity)} <i>${issue.severity}</i>`;
           const message = issue.message;
           if (!issue.source) {
@@ -1302,7 +1297,7 @@ function reportToDetailSection(report) {
     output += addLine(chalk3.magentaBright.bold(`${title} audits`));
     output += addLine();
     const ui = cliui({ width: 80 });
-    audits.sort(sortAudits).forEach(({ score, title: title2, displayValue, value }) => {
+    audits.forEach(({ score, title: title2, displayValue, value }) => {
       ui.div(
         {
           text: withColor({ score, text: "\u25CF" }),
@@ -1462,6 +1457,56 @@ var verboseUtils = (verbose) => ({
   exec: getExecVerbose(verbose)
 });
 
+// packages/utils/src/lib/sort-report.ts
+function sortReport(report) {
+  const { categories, plugins } = report;
+  const sortedCategories = categories.map((category) => {
+    const { audits, groups } = category.refs.reduce(
+      (acc, ref) => ({
+        ...acc,
+        ...ref.type === "group" ? {
+          groups: [
+            ...acc.groups,
+            getGroupWithAudits(ref.slug, ref.plugin, plugins)
+          ]
+        } : {
+          audits: [...acc.audits, getAuditByRef(ref, plugins)]
+        }
+      }),
+      { groups: [], audits: [] }
+    );
+    const sortedAuditsAndGroups = [
+      ...groups,
+      ...audits.sort(compareCategoryAudits)
+    ];
+    const sortedRefs = category.refs.slice().sort((a, b) => {
+      const aIndex = sortedAuditsAndGroups.findIndex(
+        (ref) => ref.slug === a.slug
+      );
+      const bIndex = sortedAuditsAndGroups.findIndex(
+        (ref) => ref.slug === b.slug
+      );
+      return aIndex - bIndex;
+    });
+    return { ...category, refs: sortedRefs };
+  });
+  const sortedPlugins = plugins.map((plugin) => ({
+    ...plugin,
+    audits: plugin.audits.sort(compareAudits).map((audit) => ({
+      ...audit,
+      details: {
+        ...audit.details,
+        issues: audit?.details?.issues.slice().sort(compareIssues) || []
+      }
+    }))
+  }));
+  return {
+    ...report,
+    categories: sortedCategories,
+    plugins: sortedPlugins
+  };
+}
+
 // packages/core/src/lib/implementation/persist.ts
 var PersistDirError = class extends Error {
   constructor(outputDir) {
@@ -1475,8 +1520,8 @@ var PersistError = class extends Error {
 };
 async function persistReport(report, options) {
   const { outputDir, filename, format } = options;
-  const scoredReport = scoreReport(report);
-  console.info(reportToStdout(scoredReport));
+  const sortedScoredReport = sortReport(scoreReport(report));
+  console.info(reportToStdout(sortedScoredReport));
   const results = [];
   if (format.includes("json")) {
     results.push({
@@ -1489,7 +1534,7 @@ async function persistReport(report, options) {
     validateCommitData(commitData);
     results.push({
       format: "md",
-      content: reportToMd(scoredReport, commitData)
+      content: reportToMd(sortedScoredReport, commitData)
     });
   }
   if (!existsSync(outputDir)) {
@@ -1634,7 +1679,7 @@ function auditOutputsCorrelateWithPluginOutput(auditOutputs, pluginConfigAudits)
 
 // packages/core/package.json
 var name = "@code-pushup/core";
-var version = "0.8.8";
+var version = "0.8.10";
 
 // packages/core/src/lib/implementation/collect.ts
 async function collect(options) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/core",
-  "version": "0.8.8",
+  "version": "0.8.10",
   "dependencies": {
     "@code-pushup/models": "*",
     "@code-pushup/utils": "*",