@code-pushup/utils 0.23.0 → 0.25.6

package/index.js

@@ -752,8 +752,6 @@ var SCORE_COLOR_RANGE = {
   GREEN_MIN: 0.9,
   YELLOW_MIN: 0.5
 };
-
-// packages/utils/src/lib/reports/utils.ts
 var FOOTER_PREFIX = "Made with \u2764 by";
 var CODE_PUSHUP_DOMAIN = "code-pushup.dev";
 var README_LINK = "https://github.com/flowup/quality-metrics-cli#readme";
@@ -784,6 +782,8 @@ var detailsTableHeaders = [
   "Source file",
   "Line(s)"
 ];
+
+// packages/utils/src/lib/reports/utils.ts
 function formatReportScore(score) {
   return Math.round(score * 100).toString();
 }
@@ -820,7 +820,7 @@ function calcDuration(start, stop) {
 function countCategoryAudits(refs, plugins) {
   const groupLookup = plugins.reduce(
     (lookup, plugin) => {
-      if (plugin.groups.length === 0) {
+      if (plugin.groups == null || plugin.groups.length === 0) {
         return lookup;
       }
       return {
@@ -840,7 +840,7 @@ function countCategoryAudits(refs, plugins) {
     return acc + 1;
   }, 0);
 }
-function getAuditByRef({ slug, weight, plugin }, plugins) {
+function getSortableAuditByRef({ slug, weight, plugin }, plugins) {
   const auditPlugin = plugins.find((p) => p.slug === plugin);
   if (!auditPlugin) {
     throwIsNotPresentError(`Plugin ${plugin}`, "report");
@@ -857,39 +857,51 @@ function getAuditByRef({ slug, weight, plugin }, plugins) {
     plugin
   };
 }
-function getGroupWithAudits(refSlug, refPlugin, plugins) {
-  const plugin = plugins.find(({ slug }) => slug === refPlugin);
-  if (!plugin) {
-    throwIsNotPresentError(`Plugin ${refPlugin}`, "report");
-  }
-  const groupWithAudits = plugin.groups?.find(({ slug }) => slug === refSlug);
-  if (!groupWithAudits) {
-    throwIsNotPresentError(`Group ${refSlug}`, plugin.slug);
+function getSortableGroupByRef({ plugin, slug, weight }, plugins) {
+  const groupPlugin = plugins.find((p) => p.slug === plugin);
+  if (!groupPlugin) {
+    throwIsNotPresentError(`Plugin ${plugin}`, "report");
   }
-  const groupAudits = groupWithAudits.refs.reduce(
-    (acc, ref) => {
-      const audit = getAuditByRef(
-        { ...ref, plugin: refPlugin, type: "audit" },
-        plugins
-      );
-      return [...acc, audit];
-    },
-    []
+  const group = groupPlugin.groups?.find(
+    ({ slug: groupSlug }) => groupSlug === slug
   );
-  const audits = [...groupAudits].sort(compareCategoryAudits);
+  if (!group) {
+    throwIsNotPresentError(`Group ${slug}`, groupPlugin.slug);
+  }
+  const sortedAudits = getSortedGroupAudits(group, groupPlugin.slug, plugins);
+  const sortedAuditRefs = [...group.refs].sort((a, b) => {
+    const aIndex = sortedAudits.findIndex((ref) => ref.slug === a.slug);
+    const bIndex = sortedAudits.findIndex((ref) => ref.slug === b.slug);
+    return aIndex - bIndex;
+  });
   return {
-    ...groupWithAudits,
-    audits
+    ...group,
+    refs: sortedAuditRefs,
+    plugin,
+    weight
   };
 }
-function compareCategoryAudits(a, b) {
+function getSortedGroupAudits(group, plugin, plugins) {
+  return group.refs.map(
+    (ref) => getSortableAuditByRef(
+      {
+        plugin,
+        slug: ref.slug,
+        weight: ref.weight,
+        type: "audit"
+      },
+      plugins
+    )
+  ).sort(compareCategoryAuditsAndGroups);
+}
+function compareCategoryAuditsAndGroups(a, b) {
   if (a.weight !== b.weight) {
     return b.weight - a.weight;
   }
   if (a.score !== b.score) {
     return a.score - b.score;
   }
-  if (a.value !== b.value) {
+  if ("value" in a && "value" in b && a.value !== b.value) {
     return b.value - a.value;
   }
   return a.title.localeCompare(b.title);
@@ -998,6 +1010,18 @@ function executeProcess(cfg) {
   });
 }
 
+// packages/utils/src/lib/filter.ts
+function filterItemRefsBy(items, refFilterFn) {
+  return items.map((item) => ({
+    ...item,
+    refs: item.refs.filter(refFilterFn)
+  })).filter((item) => item.refs.length);
+}
+
+// packages/utils/src/lib/git.ts
+import { isAbsolute, join as join3, relative } from "node:path";
+import { simpleGit } from "simple-git";
+
 // packages/utils/src/lib/transform.ts
 import { platform } from "node:os";
 function toArray(val) {
@@ -1087,32 +1111,7 @@ function toOrdinal(value) {
   return `${value}th`;
 }
 
-// packages/utils/src/lib/filter-by-slug.ts
-function filterGroupsByAuditSlug(groups, auditSlugs) {
-  const slugs = toArray(auditSlugs);
-  if (slugs.length === 0) {
-    return groups;
-  }
-  return groups.map((group) => ({
-    ...group,
-    refs: filterSlug(group.refs, slugs)
-  })).filter((group) => group.refs.length);
-}
-function filterAuditsBySlug(list, auditSlugs) {
-  const slugs = toArray(auditSlugs);
-  if (slugs.length === 0) {
-    return list;
-  }
-  return filterSlug(list, slugs);
-}
-function filterSlug(refs, slugOrSlugs) {
-  const slugs = toArray(slugOrSlugs);
-  return refs.filter(({ slug }) => slugs.includes(slug));
-}
-
 // packages/utils/src/lib/git.ts
-import { isAbsolute, join as join3, relative } from "node:path";
-import { simpleGit } from "simple-git";
 async function getLatestCommit(git = simpleGit()) {
   const log = await git.log({
     maxCount: 1,
@@ -1135,7 +1134,7 @@ async function toGitPath(path, git = simpleGit()) {
 function validateCommitData(commitData, options = {}) {
   if (!commitData) {
     const msg = "no commit data available";
-    if (options?.throwError) {
+    if (options.throwError) {
       throw new Error(msg);
     } else {
       console.warn(msg);
@@ -1329,12 +1328,24 @@ function reportToCategoriesSection(report) {
     const categoryDocs = getDocsAndDescription(category);
     const categoryMDItems = category.refs.reduce((refAcc, ref) => {
       if (ref.type === "group") {
-        const group = getGroupWithAudits(ref.slug, ref.plugin, plugins);
-        const mdGroupItem = groupItemToCategorySection(group, plugins);
+        const group = getSortableGroupByRef(ref, plugins);
+        const groupAudits = group.refs.map(
+          (groupRef) => getSortableAuditByRef(
+            { ...groupRef, plugin: group.plugin, type: "audit" },
+            plugins
+          )
+        );
+        const pluginTitle = getPluginNameFromSlug(ref.plugin, plugins);
+        const mdGroupItem = groupItemToCategorySection(
+          group,
+          groupAudits,
+          pluginTitle
+        );
         return refAcc + mdGroupItem + NEW_LINE;
       } else {
-        const audit = getAuditByRef(ref, plugins);
-        const mdAuditItem = auditItemToCategorySection(audit, plugins);
+        const audit = getSortableAuditByRef(ref, plugins);
+        const pluginTitle = getPluginNameFromSlug(ref.plugin, plugins);
+        const mdAuditItem = auditItemToCategorySection(audit, pluginTitle);
         return refAcc + mdAuditItem + NEW_LINE;
       }
     }, "");
@@ -1342,8 +1353,7 @@ function reportToCategoriesSection(report) {
   }, "");
   return h2("\u{1F3F7} Categories") + NEW_LINE + categoryDetails;
 }
-function auditItemToCategorySection(audit, plugins) {
-  const pluginTitle = getPluginNameFromSlug(audit.plugin, plugins);
+function auditItemToCategorySection(audit, pluginTitle) {
   const auditTitle = link2(
     `#${slugify(audit.title)}-${slugify(pluginTitle)}`,
     audit.title
@@ -1354,13 +1364,12 @@ function auditItemToCategorySection(audit, plugins) {
     )} ${auditTitle} (_${pluginTitle}_) - ${getAuditResult(audit)}`
   );
 }
-function groupItemToCategorySection(group, plugins) {
-  const pluginTitle = getPluginNameFromSlug(group.plugin, plugins);
-  const groupScore = Number(formatReportScore(group?.score || 0));
+function groupItemToCategorySection(group, groupAudits, pluginTitle) {
+  const groupScore = Number(formatReportScore(group.score || 0));
   const groupTitle = li(
     `${getRoundScoreMarker(groupScore)} ${group.title} (_${pluginTitle}_)`
   );
-  const groupAudits = group.audits.reduce((acc, audit) => {
+  const auditTitles = groupAudits.reduce((acc, audit) => {
     const auditTitle = link2(
       `#${slugify(audit.title)}-${slugify(pluginTitle)}`,
       audit.title
@@ -1371,13 +1380,13 @@ function groupItemToCategorySection(group, plugins) {
       )}`
     )}${NEW_LINE}`;
   }, "");
-  return groupTitle + NEW_LINE + groupAudits;
+  return groupTitle + NEW_LINE + auditTitles;
 }
 function reportToAuditsSection(report) {
   const auditsSection = report.plugins.reduce((pluginAcc, plugin) => {
     const auditsData = plugin.audits.reduce((auditAcc, audit) => {
       const auditTitle = `${audit.title} (${getPluginNameFromSlug(
-        audit.plugin,
+        plugin.slug,
         report.plugins
       )})`;
       return auditAcc + h3(auditTitle) + NEW_LINE + NEW_LINE + reportToDetailsSection(audit) + NEW_LINE + NEW_LINE + getDocsAndDescription(audit);
@@ -1554,29 +1563,30 @@ var GroupRefInvalidError = class extends Error {
 function scoreReport(report) {
   const allScoredAuditsAndGroups = /* @__PURE__ */ new Map();
   const scoredPlugins = report.plugins.map((plugin) => {
-    const { slug, audits, groups } = plugin;
-    const updatedAudits = audits.map((audit) => ({ ...audit, plugin: slug }));
-    updatedAudits.forEach((audit) => {
-      allScoredAuditsAndGroups.set(`${slug}-${audit.slug}-audit`, audit);
+    const { groups, ...pluginProps } = plugin;
+    plugin.audits.forEach((audit) => {
+      allScoredAuditsAndGroups.set(`${plugin.slug}-${audit.slug}-audit`, audit);
     });
     function groupScoreFn(ref) {
       const score = allScoredAuditsAndGroups.get(
-        `${slug}-${ref.slug}-audit`
+        `${plugin.slug}-${ref.slug}-audit`
       )?.score;
       if (score == null) {
-        throw new GroupRefInvalidError(ref.slug, slug);
+        throw new GroupRefInvalidError(ref.slug, plugin.slug);
       }
       return score;
     }
     const scoredGroups = groups?.map((group) => ({
       ...group,
-      score: calculateScore(group.refs, groupScoreFn),
-      plugin: slug
+      score: calculateScore(group.refs, groupScoreFn)
     })) ?? [];
     scoredGroups.forEach((group) => {
-      allScoredAuditsAndGroups.set(`${slug}-${group.slug}-group`, group);
+      allScoredAuditsAndGroups.set(`${plugin.slug}-${group.slug}-group`, group);
     });
-    return { ...plugin, audits: updatedAudits, groups: scoredGroups };
+    return {
+      ...pluginProps,
+      ...scoredGroups.length > 0 && { groups: scoredGroups }
+    };
   });
   function catScoreFn(ref) {
     const key = `${ref.plugin}-${ref.slug}-${ref.type}`;
@@ -1637,26 +1647,22 @@ function sortReport(report) {
       (acc, ref) => ({
         ...acc,
         ...ref.type === "group" ? {
-          groups: [
-            ...acc.groups,
-            getGroupWithAudits(ref.slug, ref.plugin, plugins)
-          ]
+          groups: [...acc.groups, getSortableGroupByRef(ref, plugins)]
         } : {
-          audits: [...acc.audits, getAuditByRef(ref, plugins)]
+          audits: [...acc.audits, getSortableAuditByRef(ref, plugins)]
         }
       }),
       { groups: [], audits: [] }
     );
-    const sortedAuditsAndGroups = [
-      ...groups,
-      ...[...audits].sort(compareCategoryAudits)
-    ];
+    const sortedAuditsAndGroups = [...audits, ...groups].sort(
+      compareCategoryAuditsAndGroups
+    );
     const sortedRefs = [...category.refs].sort((a, b) => {
       const aIndex = sortedAuditsAndGroups.findIndex(
-        (ref) => ref.slug === a.slug
+        (ref) => ref.slug === a.slug && ref.plugin === a.plugin
       );
       const bIndex = sortedAuditsAndGroups.findIndex(
-        (ref) => ref.slug === b.slug
+        (ref) => ref.slug === b.slug && ref.plugin === b.plugin
       );
       return aIndex - bIndex;
     });
@@ -1720,8 +1726,7 @@ export {
   exists,
   factorOf,
   fileExists,
-  filterAuditsBySlug,
-  filterGroupsByAuditSlug,
+  filterItemRefsBy,
   findLineNumberInText,
   formatBytes,
   formatDuration,

package/package.json

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

package/src/index.d.ts

@@ -1,7 +1,7 @@
 export { exists } from '@code-pushup/models';
 export { ProcessConfig, ProcessError, ProcessObserver, ProcessResult, executeProcess, } from './lib/execute-process';
 export { CrawlFileSystemOptions, FileResult, MultipleFileResults, crawlFileSystem, directoryExists, ensureDirectoryExists, fileExists, findLineNumberInText, importEsmModule, logMultipleFileResults, pluginWorkDir, readJsonFile, readTextFile, removeDirectoryIfExists, } from './lib/file-system';
-export { filterAuditsBySlug, filterGroupsByAuditSlug, } from './lib/filter-by-slug';
+export { filterItemRefsBy } from './lib/filter';
 export { formatBytes, formatDuration, pluralize, pluralizeToken, slugify, truncateDescription, truncateIssueMessage, truncateText, truncateTitle, } from './lib/formatting';
 export { formatGitPath, getGitRoot, getLatestCommit, toGitPath, validateCommitData, } from './lib/git';
 export { groupByStatus } from './lib/group-by-status';
@@ -9,11 +9,12 @@ export { isPromiseFulfilledResult, isPromiseRejectedResult, } from './lib/guards
 export { logMultipleResults } from './lib/log-results';
 export { link } from './lib/logging';
 export { ProgressBar, getProgressBar } from './lib/progress';
-export { TERMINAL_WIDTH } from './lib/reports/constants';
+export { CODE_PUSHUP_DOMAIN, FOOTER_PREFIX, README_LINK, TERMINAL_WIDTH, } from './lib/reports/constants';
 export { generateMdReport } from './lib/reports/generate-md-report';
 export { generateStdoutSummary } from './lib/reports/generate-stdout-summary';
-export { ScoredReport, scoreReport } from './lib/reports/scoring';
+export { scoreReport } from './lib/reports/scoring';
 export { sortReport } from './lib/reports/sorting';
-export { CODE_PUSHUP_DOMAIN, FOOTER_PREFIX, README_LINK, calcDuration, compareIssueSeverity, loadReport, } from './lib/reports/utils';
+export { ScoredReport } from './lib/reports/types';
+export { calcDuration, compareIssueSeverity, loadReport, } from './lib/reports/utils';
 export { CliArgsObject, capitalize, countOccurrences, distinct, factorOf, objectToCliArgs, objectToEntries, objectToKeys, toArray, toNumberPrecision, toOrdinal, toUnixNewlines, toUnixPath, } from './lib/transform';
 export { verboseUtils } from './lib/verbose-utils';

package/src/lib/filter.d.ts

@@ -0,0 +1,5 @@
+export declare function filterItemRefsBy<T extends {
+    refs: object[];
+}>(items: T[], refFilterFn: (item: T['refs'][number]) => boolean): (T & {
+    refs: object[];
+})[];

package/src/lib/reports/constants.d.ts

@@ -4,3 +4,12 @@ export declare const SCORE_COLOR_RANGE: {
     GREEN_MIN: number;
     YELLOW_MIN: number;
 };
+export declare const FOOTER_PREFIX = "Made with \u2764 by";
+export declare const CODE_PUSHUP_DOMAIN = "code-pushup.dev";
+export declare const README_LINK = "https://github.com/flowup/quality-metrics-cli#readme";
+export declare const reportHeadlineText = "Code PushUp Report";
+export declare const reportOverviewTableHeaders: string[];
+export declare const reportRawOverviewTableHeaders: string[];
+export declare const reportMetaTableHeaders: string[];
+export declare const pluginMetaTableHeaders: string[];
+export declare const detailsTableHeaders: string[];

package/src/lib/reports/generate-md-report.d.ts

@@ -1,3 +1,3 @@
 import { CommitData } from '../git';
-import { ScoredReport } from './scoring';
+import { ScoredReport } from './types';
 export declare function generateMdReport(report: ScoredReport, commitData: CommitData | null): string;

package/src/lib/reports/generate-stdout-summary.d.ts

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

package/src/lib/reports/scoring.d.ts

@@ -1,27 +1,5 @@
-import { AuditReport, CategoryConfig, Group, PluginReport, Report } from '@code-pushup/models';
-export type EnrichedAuditReport = AuditReport & {
-    plugin: string;
-};
-export type WeighedAuditReport = EnrichedAuditReport & {
-    weight: number;
-};
-export type EnrichedScoredGroupWithAudits = EnrichedScoredGroup & {
-    audits: AuditReport[];
-};
-export type ScoredCategoryConfig = CategoryConfig & {
-    score: number;
-};
-export type EnrichedScoredGroup = Group & {
-    plugin: string;
-    score: number;
-};
-export type ScoredReport = Omit<Report, 'plugins' | 'categories'> & {
-    plugins: (Omit<PluginReport, 'audits' | 'groups'> & {
-        audits: EnrichedAuditReport[];
-        groups: EnrichedScoredGroup[];
-    })[];
-    categories: ScoredCategoryConfig[];
-};
+import { Report } from '@code-pushup/models';
+import { ScoredReport } from './types';
 export declare class GroupRefInvalidError extends Error {
     constructor(auditSlug: string, pluginSlug: string);
 }

package/src/lib/reports/sorting.d.ts

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

package/src/lib/reports/types.d.ts

@@ -0,0 +1,21 @@
+import { AuditReport, CategoryConfig, Group, PluginReport, Report } from '@code-pushup/models';
+export type ScoredCategoryConfig = CategoryConfig & {
+    score: number;
+};
+export type ScoredGroup = Group & {
+    score: number;
+};
+export type ScoredReport = Omit<Report, 'plugins' | 'categories'> & {
+    plugins: (Omit<PluginReport, 'groups'> & {
+        groups?: ScoredGroup[];
+    })[];
+    categories: ScoredCategoryConfig[];
+};
+export type SortableGroup = ScoredGroup & {
+    weight: number;
+    plugin: string;
+};
+export type SortableAuditReport = AuditReport & {
+    weight: number;
+    plugin: string;
+};

package/src/lib/reports/utils.d.ts

@@ -1,14 +1,5 @@
-import { CategoryRef, IssueSeverity as CliIssueSeverity, Format, Issue, PersistConfig, Report } from '@code-pushup/models';
-import { EnrichedAuditReport, EnrichedScoredGroupWithAudits, ScoredReport, WeighedAuditReport } from './scoring';
-export declare const FOOTER_PREFIX = "Made with \u2764 by";
-export declare const CODE_PUSHUP_DOMAIN = "code-pushup.dev";
-export declare const README_LINK = "https://github.com/flowup/quality-metrics-cli#readme";
-export declare const reportHeadlineText = "Code PushUp Report";
-export declare const reportOverviewTableHeaders: string[];
-export declare const reportRawOverviewTableHeaders: string[];
-export declare const reportMetaTableHeaders: string[];
-export declare const pluginMetaTableHeaders: string[];
-export declare const detailsTableHeaders: string[];
+import { AuditReport, CategoryRef, IssueSeverity as CliIssueSeverity, Format, Group, Issue, PersistConfig, Report } from '@code-pushup/models';
+import { ScoredReport, SortableAuditReport, SortableGroup } from './types';
 export declare function formatReportScore(score: number): string;
 export declare function getRoundScoreMarker(score: number): string;
 export declare function getSquaredScoreMarker(score: number): string;
@@ -16,10 +7,11 @@ export declare function getSeverityIcon(severity: 'info' | 'warning' | 'error'):
 export declare function calcDuration(start: number, stop?: number): number;
 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 compareCategoryAudits(a: WeighedAuditReport, b: WeighedAuditReport): number;
-export declare function compareAudits(a: EnrichedAuditReport, b: EnrichedAuditReport): number;
+export declare function getSortableAuditByRef({ slug, weight, plugin }: CategoryRef, plugins: ScoredReport['plugins']): SortableAuditReport;
+export declare function getSortableGroupByRef({ plugin, slug, weight }: CategoryRef, plugins: ScoredReport['plugins']): SortableGroup;
+export declare function getSortedGroupAudits(group: Group, plugin: string, plugins: ScoredReport['plugins']): SortableAuditReport[];
+export declare function compareCategoryAuditsAndGroups(a: SortableAuditReport | SortableGroup, b: SortableAuditReport | SortableGroup): number;
+export declare function compareAudits(a: AuditReport, b: AuditReport): 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<Omit<PersistConfig, 'format'>> & {

package/src/lib/filter-by-slug.d.ts

@@ -1,6 +0,0 @@
-import { Audit, Group } from '@code-pushup/models';
-export declare function filterGroupsByAuditSlug(groups: Group[], auditSlugs: string | string[]): Group[];
-export declare function filterAuditsBySlug(list: Audit[], auditSlugs: string[] | string): Audit[];
-export declare function filterSlug<T extends {
-    slug: string;
-}>(refs: T[], slugOrSlugs: string | string[]): T[];