@code-pushup/utils 0.8.8 → 0.8.10

package/index.js

@@ -856,13 +856,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;
   }
@@ -874,7 +874,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;
   }
@@ -1168,23 +1168,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;
 }
@@ -1223,7 +1218,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
@@ -1246,7 +1241,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) {
@@ -1350,7 +1345,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" }),
@@ -1573,6 +1568,56 @@ var verboseUtils = (verbose) => ({
   log: getLogVerbose(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
+  };
+}
 export {
   CODE_PUSHUP_DOMAIN,
   FOOTER_PREFIX,
@@ -1613,6 +1658,7 @@ export {
   reportToStdout,
   scoreReport,
   slugify,
+  sortReport,
   toArray,
   toUnixPath,
   truncateDescription,

package/package.json

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

package/src/index.d.ts

@@ -13,3 +13,4 @@ export { reportToStdout } from './lib/report-to-stdout';
 export { ScoredReport, scoreReport } from './lib/scoring';
 export { CliArgsObject, countOccurrences, distinct, factorOf, objectToCliArgs, objectToEntries, objectToKeys, toArray, toUnixPath, } from './lib/transform';
 export { verboseUtils } from './lib/verbose-utils';
+export { sortReport } from './lib/sort-report';

package/src/lib/report.d.ts

@@ -18,8 +18,8 @@ export declare function countWeightedRefs(refs: CategoryRef[]): number;
 export declare function countCategoryAudits(refs: CategoryRef[], plugins: ScoredReport['plugins']): number;
 export declare function getAuditByRef({ slug, weight, plugin }: CategoryRef, plugins: ScoredReport['plugins']): WeighedAuditReport;
 export declare function getGroupWithAudits(refSlug: string, refPlugin: string, plugins: ScoredReport['plugins']): EnrichedScoredGroupWithAudits;
-export declare function sortCategoryAudits(a: WeighedAuditReport, b: WeighedAuditReport): number;
-export declare function sortAudits(a: EnrichedAuditReport, b: EnrichedAuditReport): number;
+export declare function compareCategoryAudits(a: WeighedAuditReport, b: WeighedAuditReport): number;
+export declare function compareAudits(a: EnrichedAuditReport, b: EnrichedAuditReport): number;
 export declare function compareIssueSeverity(severity1: CliIssueSeverity, severity2: CliIssueSeverity): number;
 type LoadedReportFormat<T extends Format> = T extends 'json' ? Report : string;
 export declare function loadReport<T extends Format>(options: Required<Pick<PersistConfig, 'outputDir' | 'filename'>> & {

package/src/lib/scoring.d.ts

@@ -8,7 +8,7 @@ export type WeighedAuditReport = EnrichedAuditReport & {
 export type EnrichedScoredGroupWithAudits = EnrichedScoredGroup & {
     audits: AuditReport[];
 };
-type ScoredCategoryConfig = CategoryConfig & {
+export type ScoredCategoryConfig = CategoryConfig & {
     score: number;
 };
 export type EnrichedScoredGroup = Group & {
@@ -26,4 +26,3 @@ export declare function calculateScore<T extends {
     weight: number;
 }>(refs: T[], scoreFn: (ref: T) => number): number;
 export declare function scoreReport(report: Report): ScoredReport;
-export {};

package/src/lib/sort-report.d.ts

@@ -0,0 +1,2 @@
+import { ScoredReport } from './scoring';
+export declare function sortReport(report: ScoredReport): ScoredReport;