@code-pushup/utils 0.56.0 → 0.57.0

package/src/lib/reports/formatting.js

@@ -0,0 +1,105 @@
+import { MarkdownDocument, md, } from 'build-md';
+import path from 'node:path';
+import { HIERARCHY } from '../text-formats/index.js';
+import { columnsToStringArray, getColumnAlignments, rowToStringArray, } from '../text-formats/table.js';
+import { getEnvironmentType, getGitHubBaseUrl, getGitLabBaseUrl, } from './environment-type.js';
+export function tableSection(tableData, options) {
+    if (tableData.rows.length === 0) {
+        return null;
+    }
+    const { level = HIERARCHY.level_4 } = options ?? {};
+    const columns = columnsToStringArray(tableData);
+    const alignments = getColumnAlignments(tableData);
+    const rows = rowToStringArray(tableData);
+    return new MarkdownDocument().heading(level, tableData.title).table(columns.map((heading, i) => {
+        const alignment = alignments[i];
+        if (alignment) {
+            return { heading, alignment };
+        }
+        return heading;
+    }), rows);
+}
+// @TODO extract `Pick<AuditReport, 'docsUrl' | 'description'>` to a reusable schema and type
+export function metaDescription(audit) {
+    const docsUrl = audit.docsUrl;
+    const description = audit.description?.trim();
+    if (docsUrl) {
+        const docsLink = md.link(docsUrl, '📖 Docs');
+        if (!description) {
+            return docsLink;
+        }
+        const parsedDescription = description.endsWith('```')
+            ? `${description}\n\n`
+            : `${description} `;
+        return md `${parsedDescription}${docsLink}`;
+    }
+    if (description && description.trim().length > 0) {
+        return description;
+    }
+    return '';
+}
+/**
+ * Link to local source for IDE
+ * @param source
+ * @param reportLocation
+ *
+ * @example
+ * linkToLocalSourceInIde({ file: 'src/index.ts' }, { outputDir: '.code-pushup' }) // [`src/index.ts`](../src/index.ts)
+ */
+export function linkToLocalSourceForIde(source, options) {
+    const { file, position } = source;
+    const { outputDir } = options ?? {};
+    // NOT linkable
+    if (!outputDir) {
+        return md.code(file);
+    }
+    return md.link(formatFileLink(file, position, outputDir), md.code(file));
+}
+export function formatSourceLine(position) {
+    if (!position) {
+        return '';
+    }
+    const { startLine, endLine } = position;
+    return endLine && startLine !== endLine
+        ? `${startLine}-${endLine}`
+        : `${startLine}`;
+}
+export function formatGitHubLink(file, position) {
+    const baseUrl = getGitHubBaseUrl();
+    if (!position) {
+        return `${baseUrl}/${file}`;
+    }
+    const { startLine, endLine, startColumn, endColumn } = position;
+    const start = startColumn ? `L${startLine}C${startColumn}` : `L${startLine}`;
+    const end = endLine
+        ? endColumn
+            ? `L${endLine}C${endColumn}`
+            : `L${endLine}`
+        : '';
+    const lineRange = end && start !== end ? `${start}-${end}` : start;
+    return `${baseUrl}/${file}#${lineRange}`;
+}
+export function formatGitLabLink(file, position) {
+    const baseUrl = getGitLabBaseUrl();
+    if (!position) {
+        return `${baseUrl}/${file}`;
+    }
+    const { startLine, endLine } = position;
+    const lineRange = endLine && startLine !== endLine ? `${startLine}-${endLine}` : startLine;
+    return `${baseUrl}/${file}#L${lineRange}`;
+}
+export function formatFileLink(file, position, outputDir) {
+    const relativePath = path.posix.relative(outputDir, file);
+    const env = getEnvironmentType();
+    switch (env) {
+        case 'vscode':
+            return position ? `${relativePath}#L${position.startLine}` : relativePath;
+        case 'github':
+            return formatGitHubLink(file, position);
+        case 'gitlab':
+            return formatGitLabLink(file, position);
+        default:
+            return relativePath;
+    }
+}
+//# sourceMappingURL=formatting.js.map

package/src/lib/reports/formatting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatting.js","sourceRoot":"","sources":["../../../../../../packages/utils/src/lib/reports/formatting.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,gBAAgB,EAChB,EAAE,GACH,MAAM,UAAU,CAAC;AAClB,OAAO,IAAI,MAAM,WAAW,CAAC;AAM7B,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EACL,oBAAoB,EACpB,mBAAmB,EACnB,gBAAgB,GACjB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,kBAAkB,EAClB,gBAAgB,EAChB,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAG/B,MAAM,UAAU,YAAY,CAC1B,SAAgB,EAChB,OAEC;IAED,IAAI,SAAS,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IACD,MAAM,EAAE,KAAK,GAAG,SAAS,CAAC,OAAO,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IACpD,MAAM,OAAO,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC;IAChD,MAAM,UAAU,GAAG,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAClD,MAAM,IAAI,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;IACzC,OAAO,IAAI,gBAAgB,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,KAAK,CACjE,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE;QACzB,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAChC,IAAI,SAAS,EAAE,CAAC;YACd,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;QAChC,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC,EACF,IAAI,CACL,CAAC;AACJ,CAAC;AAED,6FAA6F;AAC7F,MAAM,UAAU,eAAe,CAC7B,KAAmD;IAEnD,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;IAC9B,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC;IAC9C,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,QAAQ,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;QAC7C,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,MAAM,iBAAiB,GAAG,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC;YACnD,CAAC,CAAC,GAAG,WAAW,MAAM;YACtB,CAAC,CAAC,GAAG,WAAW,GAAG,CAAC;QACtB,OAAO,EAAE,CAAA,GAAG,iBAAiB,GAAG,QAAQ,EAAE,CAAC;IAC7C,CAAC;IACD,IAAI,WAAW,IAAI,WAAW,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjD,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,uBAAuB,CACrC,MAA0B,EAC1B,OAA4C;IAE5C,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;IAClC,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAEpC,eAAe;IACf,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IAED,OAAO,EAAE,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,QAAwC;IAExC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC;IACxC,OAAO,OAAO,IAAI,SAAS,KAAK,OAAO;QACrC,CAAC,CAAC,GAAG,SAAS,IAAI,OAAO,EAAE;QAC3B,CAAC,CAAC,GAAG,SAAS,EAAE,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,IAAY,EACZ,QAAwC;IAExC,MAAM,OAAO,GAAG,gBAAgB,EAAE,CAAC;IACnC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,GAAG,OAAO,IAAI,IAAI,EAAE,CAAC;IAC9B,CAAC;IACD,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,QAAQ,CAAC;IAChE,MAAM,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,SAAS,IAAI,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,SAAS,EAAE,CAAC;IAC7E,MAAM,GAAG,GAAG,OAAO;QACjB,CAAC,CAAC,SAAS;YACT,CAAC,CAAC,IAAI,OAAO,IAAI,SAAS,EAAE;YAC5B,CAAC,CAAC,IAAI,OAAO,EAAE;QACjB,CAAC,CAAC,EAAE,CAAC;IACP,MAAM,SAAS,GAAG,GAAG,IAAI,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IACnE,OAAO,GAAG,OAAO,IAAI,IAAI,IAAI,SAAS,EAAE,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,IAAY,EACZ,QAAwC;IAExC,MAAM,OAAO,GAAG,gBAAgB,EAAE,CAAC;IACnC,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,GAAG,OAAO,IAAI,IAAI,EAAE,CAAC;IAC9B,CAAC;IACD,MAAM,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,QAAQ,CAAC;IACxC,MAAM,SAAS,GACb,OAAO,IAAI,SAAS,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,SAAS,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3E,OAAO,GAAG,OAAO,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,IAAY,EACZ,QAAwC,EACxC,SAAiB;IAEjB,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;IAC1D,MAAM,GAAG,GAAG,kBAAkB,EAAE,CAAC;IAEjC,QAAQ,GAAG,EAAE,CAAC;QACZ,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC,CAAC,CAAC,GAAG,YAAY,KAAK,QAAQ,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC;QAC5E,KAAK,QAAQ;YACX,OAAO,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC1C,KAAK,QAAQ;YACX,OAAO,gBAAgB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAC1C;YACE,OAAO,YAAY,CAAC;IACxB,CAAC;AACH,CAAC"}

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

@@ -1,6 +1,6 @@
 import { type InlineText, MarkdownDocument } from 'build-md';
 import type { AuditReport } from '@code-pushup/models';
-import type { ScoredGroup, ScoredReport } from './types';
+import type { ScoredGroup, ScoredReport } from './types.js';
 export declare function categoriesOverviewSection(report: Required<Pick<ScoredReport, 'plugins' | 'categories'>>): MarkdownDocument;
 export declare function categoriesDetailsSection(report: Required<Pick<ScoredReport, 'plugins' | 'categories'>>): MarkdownDocument;
 export declare function categoryRef({ title, score, value, displayValue }: AuditReport, pluginTitle: string): InlineText;

package/src/lib/reports/generate-md-report-categoy-section.js

@@ -0,0 +1,63 @@
+import { MarkdownDocument, md } from 'build-md';
+import { slugify } from '../formatting.js';
+import { HIERARCHY } from '../text-formats/index.js';
+import { metaDescription } from './formatting.js';
+import { getSortableAuditByRef, getSortableGroupByRef } from './sorting.js';
+import { countCategoryAudits, formatReportScore, getPluginNameFromSlug, scoreMarker, targetScoreIcon, } from './utils.js';
+export function categoriesOverviewSection(report) {
+    const { categories, plugins } = report;
+    return new MarkdownDocument().table([
+        { heading: '🏷 Category', alignment: 'left' },
+        { heading: '⭐ Score', alignment: 'center' },
+        { heading: '🛡 Audits', alignment: 'center' },
+    ], categories.map(({ title, refs, score, isBinary }) => [
+        // @TODO refactor `isBinary: boolean` to `targetScore: number` #713
+        // The heading "ID" is inferred from the heading text in Markdown.
+        md.link(`#${slugify(title)}`, title),
+        md `${scoreMarker(score)} ${md.bold(formatReportScore(score))}${binaryIconSuffix(score, isBinary)}`,
+        countCategoryAudits(refs, plugins).toString(),
+    ]));
+}
+export function categoriesDetailsSection(report) {
+    const { categories, plugins } = report;
+    return new MarkdownDocument()
+        .heading(HIERARCHY.level_2, '🏷 Categories')
+        .$foreach(categories, (doc, category) => doc
+        .heading(HIERARCHY.level_3, category.title)
+        .paragraph(metaDescription(category))
+        .paragraph(md `${scoreMarker(category.score)} Score: ${md.bold(formatReportScore(category.score))}${binaryIconSuffix(category.score, category.isBinary)}`)
+        .list(category.refs.map(ref => {
+        // Add group details
+        if (ref.type === 'group') {
+            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);
+            return categoryGroupItem(group, groupAudits, pluginTitle);
+        }
+        // Add audit details
+        else {
+            const audit = getSortableAuditByRef(ref, plugins);
+            const pluginTitle = getPluginNameFromSlug(ref.plugin, plugins);
+            return categoryRef(audit, pluginTitle);
+        }
+    })));
+}
+export function categoryRef({ title, score, value, displayValue }, pluginTitle) {
+    const auditTitleAsLink = md.link(`#${slugify(title)}-${slugify(pluginTitle)}`, title);
+    const marker = scoreMarker(score, 'square');
+    return md `${marker} ${auditTitleAsLink} (${md.italic(pluginTitle)}) - ${md.bold((displayValue || value).toString())}`;
+}
+export function categoryGroupItem({ score = 0, title }, groupAudits, pluginTitle) {
+    const groupTitle = md `${scoreMarker(score)} ${title} (${md.italic(pluginTitle)})`;
+    const auditsList = md.list(groupAudits.map(({ title: auditTitle, score: auditScore, value, displayValue }) => {
+        const auditTitleLink = md.link(`#${slugify(auditTitle)}-${slugify(pluginTitle)}`, auditTitle);
+        const marker = scoreMarker(auditScore, 'square');
+        return md `${marker} ${auditTitleLink} - ${md.bold(String(displayValue ?? value))}`;
+    }));
+    return md `${groupTitle}${auditsList}`;
+}
+export function binaryIconSuffix(score, isBinary) {
+    // @TODO refactor `isBinary: boolean` to `targetScore: number` #713
+    return targetScoreIcon(score, isBinary ? 1 : undefined, { prefix: ' ' });
+}
+//# sourceMappingURL=generate-md-report-categoy-section.js.map

package/src/lib/reports/generate-md-report-categoy-section.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-md-report-categoy-section.js","sourceRoot":"","sources":["../../../../../../packages/utils/src/lib/reports/generate-md-report-categoy-section.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,gBAAgB,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AAEjE,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AAE5E,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,qBAAqB,EACrB,WAAW,EACX,eAAe,GAChB,MAAM,YAAY,CAAC;AAEpB,MAAM,UAAU,yBAAyB,CACvC,MAA8D;IAE9D,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IACvC,OAAO,IAAI,gBAAgB,EAAE,CAAC,KAAK,CACjC;QACE,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,EAAE;QAC7C,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE;QAC3C,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE;KAC9C,EACD,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QACnD,mEAAmE;QACnE,kEAAkE;QAClE,EAAE,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,CAAC;QACpC,EAAE,CAAA,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,CAChC,iBAAiB,CAAC,KAAK,CAAC,CACzB,GAAG,gBAAgB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE;QACvC,mBAAmB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,QAAQ,EAAE;KAC9C,CAAC,CACH,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,MAA8D;IAE9D,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAEvC,OAAO,IAAI,gBAAgB,EAAE;SAC1B,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,eAAe,CAAC;SAC3C,QAAQ,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE,CACtC,GAAG;SACA,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC;SAC1C,SAAS,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC;SACpC,SAAS,CACR,EAAE,CAAA,GAAG,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,IAAI,CAChD,iBAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAClC,GAAG,gBAAgB,CAAC,QAAQ,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAC1D;SACA,IAAI,CACH,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QACtB,oBAAoB;QACpB,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YACzB,MAAM,KAAK,GAAG,qBAAqB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAClD,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAC5C,qBAAqB,CACnB,EAAE,GAAG,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,EACpD,OAAO,CACR,CACF,CAAC;YACF,MAAM,WAAW,GAAG,qBAAqB,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC/D,OAAO,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;QAC5D,CAAC;QACD,oBAAoB;aACf,CAAC;YACJ,MAAM,KAAK,GAAG,qBAAqB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;YAClD,MAAM,WAAW,GAAG,qBAAqB,CAAC,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC/D,OAAO,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;QACzC,CAAC;IACH,CAAC,CAAC,CACH,CACJ,CAAC;AACN,CAAC;AAED,MAAM,UAAU,WAAW,CACzB,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,YAAY,EAAe,EAClD,WAAmB;IAEnB,MAAM,gBAAgB,GAAG,EAAE,CAAC,IAAI,CAC9B,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,WAAW,CAAC,EAAE,EAC5C,KAAK,CACN,CAAC;IACF,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC5C,OAAO,EAAE,CAAA,GAAG,MAAM,IAAI,gBAAgB,KAAK,EAAE,CAAC,MAAM,CAClD,WAAW,CACZ,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,YAAY,IAAI,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,EAAE,CAAC;AACxD,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,EAAe,EACjC,WAA0B,EAC1B,WAAmB;IAEnB,MAAM,UAAU,GAAG,EAAE,CAAA,GAAG,WAAW,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC,MAAM,CAC/D,WAAW,CACZ,GAAG,CAAC;IAEL,MAAM,UAAU,GAAG,EAAE,CAAC,IAAI,CACxB,WAAW,CAAC,GAAG,CACb,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE;QAChE,MAAM,cAAc,GAAG,EAAE,CAAC,IAAI,CAC5B,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,WAAW,CAAC,EAAE,EACjD,UAAU,CACX,CAAC;QACF,MAAM,MAAM,GAAG,WAAW,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACjD,OAAO,EAAE,CAAA,GAAG,MAAM,IAAI,cAAc,MAAM,EAAE,CAAC,IAAI,CAC/C,MAAM,CAAC,YAAY,IAAI,KAAK,CAAC,CAC9B,EAAE,CAAC;IACN,CAAC,CACF,CACF,CAAC;IAEF,OAAO,EAAE,CAAA,GAAG,UAAU,GAAG,UAAU,EAAE,CAAC;AACxC,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,KAAa,EACb,QAA6B;IAE7B,mEAAmE;IACnE,OAAO,eAAe,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;AAC3E,CAAC"}

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

@@ -1,6 +1,6 @@
 import { type InlineText, MarkdownDocument } from 'build-md';
 import type { AuditReport, Issue, Report } from '@code-pushup/models';
-import type { MdReportOptions, ScoredReport } from './types';
+import type { MdReportOptions, ScoredReport } from './types.js';
 export declare function auditDetailsAuditValue({ score, value, displayValue, }: AuditReport): InlineText;
 export declare function generateMdReport(report: ScoredReport, options?: MdReportOptions): string;
 export declare function auditDetailsIssues(issues?: Issue[], options?: MdReportOptions): MarkdownDocument | null;

package/src/lib/reports/generate-md-report.js

@@ -0,0 +1,116 @@
+import { MarkdownDocument, md } from 'build-md';
+import { formatDate, formatDuration } from '../formatting.js';
+import { HIERARCHY } from '../text-formats/index.js';
+import { FOOTER_PREFIX, README_LINK, REPORT_HEADLINE_TEXT, } from './constants.js';
+import { formatSourceLine, linkToLocalSourceForIde, metaDescription, tableSection, } from './formatting.js';
+import { categoriesDetailsSection, categoriesOverviewSection, } from './generate-md-report-categoy-section.js';
+import { formatReportScore, scoreMarker, severityMarker } from './utils.js';
+export function auditDetailsAuditValue({ score, value, displayValue, }) {
+    return md `${scoreMarker(score, 'square')} ${md.bold(String(displayValue ?? value))} (score: ${formatReportScore(score)})`;
+}
+function hasCategories(report) {
+    return !!report.categories && report.categories.length > 0;
+}
+export function generateMdReport(report, options) {
+    return new MarkdownDocument()
+        .heading(HIERARCHY.level_1, REPORT_HEADLINE_TEXT)
+        .$concat(...(hasCategories(report)
+        ? [categoriesOverviewSection(report), categoriesDetailsSection(report)]
+        : []), auditsSection(report, options), aboutSection(report))
+        .rule()
+        .paragraph(md `${FOOTER_PREFIX} ${md.link(README_LINK, 'Code PushUp')}`)
+        .toString();
+}
+export function auditDetailsIssues(issues = [], options) {
+    if (issues.length === 0) {
+        return null;
+    }
+    return new MarkdownDocument().heading(HIERARCHY.level_4, 'Issues').table([
+        { heading: 'Severity', alignment: 'center' },
+        { heading: 'Message', alignment: 'left' },
+        { heading: 'Source file', alignment: 'left' },
+        { heading: 'Line(s)', alignment: 'center' },
+    ], issues.map(({ severity: level, message, source }) => {
+        const severity = md `${severityMarker(level)} ${md.italic(level)}`;
+        if (!source) {
+            return [severity, message];
+        }
+        const file = linkToLocalSourceForIde(source, options);
+        if (!source.position) {
+            return [severity, message, file];
+        }
+        const line = formatSourceLine(source.position);
+        return [severity, message, file, line];
+    }));
+}
+export function auditDetails(audit, options) {
+    const { table, issues = [] } = audit.details ?? {};
+    const detailsValue = auditDetailsAuditValue(audit);
+    // undefined details OR empty details (undefined issues OR empty issues AND empty table)
+    if (issues.length === 0 && !table?.rows.length) {
+        return new MarkdownDocument().paragraph(detailsValue);
+    }
+    const tableSectionContent = table && tableSection(table);
+    const issuesSectionContent = issues.length > 0 && auditDetailsIssues(issues, options);
+    return new MarkdownDocument().details(detailsValue, new MarkdownDocument().$concat(tableSectionContent, issuesSectionContent));
+}
+export function auditsSection({ plugins }, options) {
+    return new MarkdownDocument()
+        .heading(HIERARCHY.level_2, '🛡️ Audits')
+        .$foreach(plugins.flatMap(plugin => plugin.audits.map(audit => ({ ...audit, plugin }))), (doc, { plugin, ...audit }) => {
+        const auditTitle = `${audit.title} (${plugin.title})`;
+        const detailsContent = auditDetails(audit, options);
+        const descriptionContent = metaDescription(audit);
+        return doc
+            .heading(HIERARCHY.level_3, auditTitle)
+            .$concat(detailsContent)
+            .paragraph(descriptionContent);
+    });
+}
+export function aboutSection(report) {
+    const { date, plugins } = report;
+    return new MarkdownDocument()
+        .heading(HIERARCHY.level_2, 'About')
+        .paragraph(md `Report was created by ${md.link(README_LINK, 'Code PushUp')} on ${formatDate(new Date(date))}.`)
+        .table(...pluginMetaTable({ plugins }))
+        .table(...reportMetaTable(report));
+}
+export function pluginMetaTable({ plugins, }) {
+    return [
+        [
+            { heading: 'Plugin', alignment: 'left' },
+            { heading: 'Audits', alignment: 'center' },
+            { heading: 'Version', alignment: 'center' },
+            { heading: 'Duration', alignment: 'right' },
+        ],
+        plugins.map(({ title, audits, version = '', duration }) => [
+            title,
+            audits.length.toString(),
+            version && md.code(version),
+            formatDuration(duration),
+        ]),
+    ];
+}
+export function reportMetaTable({ commit, version, duration, plugins, categories, }) {
+    return [
+        [
+            { heading: 'Commit', alignment: 'left' },
+            { heading: 'Version', alignment: 'center' },
+            { heading: 'Duration', alignment: 'right' },
+            { heading: 'Plugins', alignment: 'center' },
+            { heading: 'Categories', alignment: 'center' },
+            { heading: 'Audits', alignment: 'center' },
+        ],
+        [
+            [
+                commit ? `${commit.message} (${commit.hash})` : 'N/A',
+                md.code(version),
+                formatDuration(duration),
+                plugins.length.toString(),
+                (categories?.length ?? 0).toString(),
+                plugins.reduce((acc, { audits }) => acc + audits.length, 0).toString(),
+            ],
+        ],
+    ];
+}
+//# sourceMappingURL=generate-md-report.js.map

package/src/lib/reports/generate-md-report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-md-report.js","sourceRoot":"","sources":["../../../../../../packages/utils/src/lib/reports/generate-md-report.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,gBAAgB,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AAEjE,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EACL,aAAa,EACb,WAAW,EACX,oBAAoB,GACrB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACL,gBAAgB,EAChB,uBAAuB,EACvB,eAAe,EACf,YAAY,GACb,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,wBAAwB,EACxB,yBAAyB,GAC1B,MAAM,yCAAyC,CAAC;AAEjD,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAE5E,MAAM,UAAU,sBAAsB,CAAC,EACrC,KAAK,EACL,KAAK,EACL,YAAY,GACA;IACZ,OAAO,EAAE,CAAA,GAAG,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,IAAI,CACjD,MAAM,CAAC,YAAY,IAAI,KAAK,CAAC,CAC9B,YAAY,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC;AAC3C,CAAC;AAED,SAAS,aAAa,CACpB,MAAoB;IAEpB,OAAO,CAAC,CAAC,MAAM,CAAC,UAAU,IAAI,MAAM,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC;AAC7D,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,MAAoB,EACpB,OAAyB;IAEzB,OAAO,IAAI,gBAAgB,EAAE;SAC1B,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,oBAAoB,CAAC;SAChD,OAAO,CACN,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC;QACvB,CAAC,CAAC,CAAC,yBAAyB,CAAC,MAAM,CAAC,EAAE,wBAAwB,CAAC,MAAM,CAAC,CAAC;QACvE,CAAC,CAAC,EAAE,CAAC,EACP,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9B,YAAY,CAAC,MAAM,CAAC,CACrB;SACA,IAAI,EAAE;SACN,SAAS,CAAC,EAAE,CAAA,GAAG,aAAa,IAAI,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,EAAE,CAAC;SACtE,QAAQ,EAAE,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,SAAkB,EAAE,EACpB,OAAyB;IAEzB,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,IAAI,gBAAgB,EAAE,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,KAAK,CACtE;QACE,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE;QAC5C,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE;QACzC,EAAE,OAAO,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,EAAE;QAC7C,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE;KAC5C,EACD,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAS,EAAE,EAAE;QACzD,MAAM,QAAQ,GAAG,EAAE,CAAA,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QAElE,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC7B,CAAC;QACD,MAAM,IAAI,GAAG,uBAAuB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACtD,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACrB,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QACnC,CAAC;QACD,MAAM,IAAI,GAAG,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC/C,OAAO,CAAC,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACzC,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,KAAkB,EAClB,OAAyB;IAEzB,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC;IACnD,MAAM,YAAY,GAAG,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAEnD,wFAAwF;IACxF,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,EAAE,CAAC;QAC/C,OAAO,IAAI,gBAAgB,EAAE,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IACxD,CAAC;IAED,MAAM,mBAAmB,GAAG,KAAK,IAAI,YAAY,CAAC,KAAK,CAAC,CAAC;IACzD,MAAM,oBAAoB,GACxB,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,kBAAkB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE3D,OAAO,IAAI,gBAAgB,EAAE,CAAC,OAAO,CACnC,YAAY,EACZ,IAAI,gBAAgB,EAAE,CAAC,OAAO,CAAC,mBAAmB,EAAE,oBAAoB,CAAC,CAC1E,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,EAAE,OAAO,EAAiC,EAC1C,OAAyB;IAEzB,OAAO,IAAI,gBAAgB,EAAE;SAC1B,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,YAAY,CAAC;SACxC,QAAQ,CACP,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CACvB,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CACnD,EACD,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,EAAE,EAAE;QAC5B,MAAM,UAAU,GAAG,GAAG,KAAK,CAAC,KAAK,KAAK,MAAM,CAAC,KAAK,GAAG,CAAC;QACtD,MAAM,cAAc,GAAG,YAAY,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACpD,MAAM,kBAAkB,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAElD,OAAO,GAAG;aACP,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC;aACtC,OAAO,CAAC,cAAc,CAAC;aACvB,SAAS,CAAC,kBAAkB,CAAC,CAAC;IACnC,CAAC,CACF,CAAC;AACN,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,MAAyC;IAEzC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IACjC,OAAO,IAAI,gBAAgB,EAAE;SAC1B,OAAO,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC;SACnC,SAAS,CACR,EAAE,CAAA,yBAAyB,EAAE,CAAC,IAAI,CAChC,WAAW,EACX,aAAa,CACd,OAAO,UAAU,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CACtC;SACA,KAAK,CAAC,GAAG,eAAe,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;SACtC,KAAK,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,EAC9B,OAAO,GACiB;IACxB,OAAO;QACL;YACE,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE;YACxC,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE;YAC1C,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE;YAC3C,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE;SAC5C;QACD,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAG,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;YACzD,KAAK;YACL,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE;YACxB,OAAO,IAAI,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;YAC3B,cAAc,CAAC,QAAQ,CAAC;SACzB,CAAC;KACH,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,EAC9B,MAAM,EACN,OAAO,EACP,QAAQ,EACR,OAAO,EACP,UAAU,GAIX;IACC,OAAO;QACL;YACE,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE;YACxC,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE;YAC3C,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE;YAC3C,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE;YAC3C,EAAE,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE;YAC9C,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE;SAC3C;QACD;YACE;gBACE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,OAAO,KAAK,MAAM,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK;gBACrD,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC;gBAChB,cAAc,CAAC,QAAQ,CAAC;gBACxB,OAAO,CAAC,MAAM,CAAC,QAAQ,EAAE;gBACzB,CAAC,UAAU,EAAE,MAAM,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE;gBACpC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE;aACvE;SACF;KACF,CAAC;AACJ,CAAC"}

package/src/lib/reports/generate-md-reports-diff-utils.d.ts

@@ -1,6 +1,6 @@
 import { type InlineText, MarkdownDocument } from 'build-md';
 import type { ReportsDiff } from '@code-pushup/models';
-import type { DiffOutcome } from './types';
+import type { DiffOutcome } from './types.js';
 export declare function summarizeUnchanged(token: string, { changed, unchanged }: {
     changed: unknown[];
     unchanged: unknown[];

package/src/lib/reports/generate-md-reports-diff-utils.js

@@ -0,0 +1,117 @@
+import { MarkdownDocument, md } from 'build-md';
+import { pluralize, pluralizeToken } from '../formatting.js';
+import { objectToEntries } from '../transform.js';
+// to prevent exceeding Markdown comment character limit
+const MAX_ROWS = 100;
+export function summarizeUnchanged(token, { changed, unchanged }) {
+    const pluralizedCount = changed.length > 0
+        ? pluralizeToken(`other ${token}`, unchanged.length)
+        : `All of ${pluralizeToken(token, unchanged.length)}`;
+    const pluralizedVerb = unchanged.length === 1 ? 'is' : 'are';
+    return `${pluralizedCount} ${pluralizedVerb} unchanged.`;
+}
+export function summarizeDiffOutcomes(outcomes, token) {
+    return objectToEntries(countDiffOutcomes(outcomes))
+        .filter((entry) => entry[0] !== 'unchanged' && entry[1] > 0)
+        .map(([outcome, count]) => {
+        const formattedCount = `<strong>${count}</strong> ${pluralize(token, count)}`;
+        switch (outcome) {
+            case 'positive':
+                return `👍 ${formattedCount} improved`;
+            case 'negative':
+                return `👎 ${formattedCount} regressed`;
+            case 'mixed':
+                return `${formattedCount} changed without impacting score`;
+        }
+    })
+        .join(', ');
+}
+export function createGroupsOrAuditsDetails(token, { changed, unchanged }, ...[columns, rows]) {
+    if (changed.length === 0) {
+        return new MarkdownDocument().paragraph(summarizeUnchanged(token, { changed, unchanged }));
+    }
+    return new MarkdownDocument()
+        .table(columns, rows.slice(0, MAX_ROWS))
+        .paragraph(changed.length > MAX_ROWS &&
+        md.italic(`Only the ${MAX_ROWS} most affected ${pluralize(token)} are listed above for brevity.`))
+        .paragraph(unchanged.length > 0 && summarizeUnchanged(token, { changed, unchanged }));
+}
+export function formatTitle({ title, docsUrl, }) {
+    if (docsUrl) {
+        return md.link(docsUrl, title);
+    }
+    return title;
+}
+export function formatPortalLink(portalUrl) {
+    return (portalUrl &&
+        md.link(portalUrl, '🕵️ See full comparison in Code PushUp portal 🔍'));
+}
+export function sortChanges(changes) {
+    return changes.toSorted((a, b) => Math.abs(b.scores.diff) - Math.abs(a.scores.diff) ||
+        Math.abs(b.values?.diff ?? 0) - Math.abs(a.values?.diff ?? 0));
+}
+export function getDiffChanges(diff) {
+    return [
+        ...diff.categories.changed,
+        ...diff.groups.changed,
+        ...diff.audits.changed,
+    ];
+}
+export function changesToDiffOutcomes(changes) {
+    return changes.map((change) => {
+        if (change.scores.diff > 0) {
+            return 'positive';
+        }
+        if (change.scores.diff < 0) {
+            return 'negative';
+        }
+        if (change.values != null && change.values.diff !== 0) {
+            return 'mixed';
+        }
+        return 'unchanged';
+    });
+}
+export function mergeDiffOutcomes(outcomes) {
+    if (outcomes.every(outcome => outcome === 'unchanged')) {
+        return 'unchanged';
+    }
+    if (outcomes.includes('positive') && !outcomes.includes('negative')) {
+        return 'positive';
+    }
+    if (outcomes.includes('negative') && !outcomes.includes('positive')) {
+        return 'negative';
+    }
+    return 'mixed';
+}
+function countDiffOutcomes(outcomes) {
+    return {
+        positive: outcomes.filter(outcome => outcome === 'positive').length,
+        negative: outcomes.filter(outcome => outcome === 'negative').length,
+        mixed: outcomes.filter(outcome => outcome === 'mixed').length,
+        unchanged: outcomes.filter(outcome => outcome === 'unchanged').length,
+    };
+}
+export function formatReportOutcome(outcome, commits) {
+    const outcomeTexts = {
+        positive: md `🥳 Code PushUp report has ${md.bold('improved')}`,
+        negative: md `😟 Code PushUp report has ${md.bold('regressed')}`,
+        mixed: md `🤨 Code PushUp report has both ${md.bold('improvements and regressions')}`,
+        unchanged: md `😐 Code PushUp report is ${md.bold('unchanged')}`,
+    };
+    if (commits) {
+        const commitsText = `compared target commit ${commits.after.hash} with source commit ${commits.before.hash}`;
+        return md `${outcomeTexts[outcome]} – ${commitsText}.`;
+    }
+    return md `${outcomeTexts[outcome]}.`;
+}
+export function compareDiffsBy(type, a, b) {
+    return (sumScoreChanges(b[type].changed) - sumScoreChanges(a[type].changed) ||
+        sumConfigChanges(b[type]) - sumConfigChanges(a[type]));
+}
+function sumScoreChanges(changes) {
+    return changes.reduce((acc, { scores }) => acc + Math.abs(scores.diff), 0);
+}
+function sumConfigChanges({ added, removed, }) {
+    return added.length + removed.length;
+}
+//# sourceMappingURL=generate-md-reports-diff-utils.js.map

package/src/lib/reports/generate-md-reports-diff-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-md-reports-diff-utils.js","sourceRoot":"","sources":["../../../../../../packages/utils/src/lib/reports/generate-md-reports-diff-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,gBAAgB,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AAEjE,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAGlD,wDAAwD;AACxD,MAAM,QAAQ,GAAG,GAAG,CAAC;AAErB,MAAM,UAAU,kBAAkB,CAChC,KAAa,EACb,EAAE,OAAO,EAAE,SAAS,EAAgD;IAEpE,MAAM,eAAe,GACnB,OAAO,CAAC,MAAM,GAAG,CAAC;QAChB,CAAC,CAAC,cAAc,CAAC,SAAS,KAAK,EAAE,EAAE,SAAS,CAAC,MAAM,CAAC;QACpD,CAAC,CAAC,UAAU,cAAc,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;IAC1D,MAAM,cAAc,GAAG,SAAS,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;IAC7D,OAAO,GAAG,eAAe,IAAI,cAAc,aAAa,CAAC;AAC3D,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,QAAuB,EACvB,KAAa;IAEb,OAAO,eAAe,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;SAChD,MAAM,CACL,CAAC,KAAK,EAAwD,EAAE,CAC9D,KAAK,CAAC,CAAC,CAAC,KAAK,WAAW,IAAI,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAC3C;SACA,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,EAAU,EAAE;QAChC,MAAM,cAAc,GAAG,WAAW,KAAK,aAAa,SAAS,CAC3D,KAAK,EACL,KAAK,CACN,EAAE,CAAC;QACJ,QAAQ,OAAO,EAAE,CAAC;YAChB,KAAK,UAAU;gBACb,OAAO,MAAM,cAAc,WAAW,CAAC;YACzC,KAAK,UAAU;gBACb,OAAO,MAAM,cAAc,YAAY,CAAC;YAC1C,KAAK,OAAO;gBACV,OAAO,GAAG,cAAc,kCAAkC,CAAC;QAC/D,CAAC;IACH,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,2BAA2B,CACzC,KAAQ,EACR,EAAE,OAAO,EAAE,SAAS,EAAwB,EAC5C,GAAG,CAAC,OAAO,EAAE,IAAI,CAAwC;IAEzD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,gBAAgB,EAAE,CAAC,SAAS,CACrC,kBAAkB,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAClD,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,gBAAgB,EAAE;SAC1B,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;SACvC,SAAS,CACR,OAAO,CAAC,MAAM,GAAG,QAAQ;QACvB,EAAE,CAAC,MAAM,CACP,YAAY,QAAQ,kBAAkB,SAAS,CAC7C,KAAK,CACN,gCAAgC,CAClC,CACJ;SACA,SAAS,CACR,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,kBAAkB,CAAC,KAAK,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAC1E,CAAC;AACN,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,EAC1B,KAAK,EACL,OAAO,GAIR;IACC,IAAI,OAAO,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,SAA6B;IAE7B,OAAO,CACL,SAAS;QACT,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,kDAAkD,CAAC,CACvE,CAAC;AACJ,CAAC;AAOD,MAAM,UAAU,WAAW,CAAmB,OAAY;IACxD,OAAO,OAAO,CAAC,QAAQ,CACrB,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACP,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;QACjD,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,IAAI,CAAC,CAAC,CAChE,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,IAAiB;IAC9C,OAAO;QACL,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO;QAC1B,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO;QACtB,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO;KACvB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,OAAiB;IACrD,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAe,EAAE;QACzC,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAC3B,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YAC3B,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,IAAI,MAAM,CAAC,MAAM,IAAI,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;YACtD,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,QAAuB;IACvD,IAAI,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,KAAK,WAAW,CAAC,EAAE,CAAC;QACvD,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,IAAI,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QACpE,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,IAAI,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;QACpE,OAAO,UAAU,CAAC;IACpB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,iBAAiB,CACxB,QAAuB;IAEvB,OAAO;QACL,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,MAAM;QACnE,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,KAAK,UAAU,CAAC,CAAC,MAAM;QACnE,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,KAAK,OAAO,CAAC,CAAC,MAAM;QAC7D,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,KAAK,WAAW,CAAC,CAAC,MAAM;KACtE,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,OAAoB,EACpB,OAAgC;IAEhC,MAAM,YAAY,GAAG;QACnB,QAAQ,EAAE,EAAE,CAAA,6BAA6B,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;QAC9D,QAAQ,EAAE,EAAE,CAAA,6BAA6B,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;QAC/D,KAAK,EAAE,EAAE,CAAA,kCAAkC,EAAE,CAAC,IAAI,CAChD,8BAA8B,CAC/B,EAAE;QACH,SAAS,EAAE,EAAE,CAAA,4BAA4B,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;KAChE,CAAC;IAEF,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,WAAW,GAAG,0BAA0B,OAAO,CAAC,KAAK,CAAC,IAAI,uBAAuB,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAC7G,OAAO,EAAE,CAAA,GAAG,YAAY,CAAC,OAAO,CAAC,MAAM,WAAW,GAAG,CAAC;IACxD,CAAC;IAED,OAAO,EAAE,CAAA,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,IAAO,EACP,CAAc,EACd,CAAc;IAEd,OAAO,CACL,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;QACnE,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CACtD,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,OAAiB;IACxC,OAAO,OAAO,CAAC,MAAM,CACnB,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAChD,CAAC,CACF,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,EACxB,KAAK,EACL,OAAO,GAIR;IACC,OAAO,KAAK,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;AACvC,CAAC"}

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

@@ -1,5 +1,5 @@
 import type { ReportsDiff } from '@code-pushup/models';
-import type { WithRequired } from '../types';
+import type { WithRequired } from '../types.js';
 export declare function generateMdReportsDiff(diff: ReportsDiff): string;
 export type LabeledDiff = WithRequired<ReportsDiff, 'label'>;
 export declare function generateMdReportsDiffForMonorepo(diffs: LabeledDiff[]): string;

package/src/lib/reports/generate-md-reports-diff.js

@@ -0,0 +1,158 @@
+import { MarkdownDocument, md, } from 'build-md';
+import { HIERARCHY } from '../text-formats/index.js';
+import { toArray } from '../transform.js';
+import { changesToDiffOutcomes, compareDiffsBy, createGroupsOrAuditsDetails, formatPortalLink, formatReportOutcome, formatTitle, getDiffChanges, mergeDiffOutcomes, sortChanges, summarizeDiffOutcomes, summarizeUnchanged, } from './generate-md-reports-diff-utils.js';
+import { formatScoreChange, formatScoreWithColor, formatValueChange, scoreMarker, } from './utils.js';
+export function generateMdReportsDiff(diff) {
+    return new MarkdownDocument()
+        .$concat(createDiffHeaderSection(diff), createDiffCategoriesSection(diff), createDiffDetailsSection(diff))
+        .toString();
+}
+export function generateMdReportsDiffForMonorepo(diffs) {
+    const diffsWithOutcomes = diffs
+        .map(diff => ({
+        ...diff,
+        outcome: mergeDiffOutcomes(changesToDiffOutcomes(getDiffChanges(diff))),
+    }))
+        .sort((a, b) => compareDiffsBy('categories', a, b) ||
+        compareDiffsBy('groups', a, b) ||
+        compareDiffsBy('audits', a, b) ||
+        a.label.localeCompare(b.label));
+    const unchanged = diffsWithOutcomes.filter(({ outcome }) => outcome === 'unchanged');
+    const changed = diffsWithOutcomes.filter(diff => !unchanged.includes(diff));
+    return new MarkdownDocument()
+        .$concat(createDiffHeaderSection(diffs), ...changed.map(createDiffProjectSection))
+        .$if(unchanged.length > 0, doc => doc
+        .rule()
+        .paragraph(summarizeUnchanged('project', { unchanged, changed })))
+        .toString();
+}
+function createDiffHeaderSection(diff) {
+    const outcome = mergeDiffOutcomes(changesToDiffOutcomes(toArray(diff).flatMap(getDiffChanges)));
+    // TODO: what if array contains different commit pairs?
+    const commits = Array.isArray(diff) ? diff[0]?.commits : diff.commits;
+    const portalUrl = Array.isArray(diff) ? undefined : diff.portalUrl;
+    return new MarkdownDocument()
+        .heading(HIERARCHY.level_1, 'Code PushUp')
+        .paragraph(formatReportOutcome(outcome, commits))
+        .paragraph(formatPortalLink(portalUrl));
+}
+function createDiffProjectSection(diff) {
+    return new MarkdownDocument()
+        .heading(HIERARCHY.level_2, md `💼 Project ${md.code(diff.label)}`)
+        .paragraph(formatReportOutcome(diff.outcome))
+        .paragraph(formatPortalLink(diff.portalUrl))
+        .$concat(createDiffCategoriesSection(diff, {
+        skipHeading: true,
+        skipUnchanged: true,
+    }), createDiffDetailsSection(diff, HIERARCHY.level_3));
+}
+function createDiffCategoriesSection(diff, options) {
+    const { changed, unchanged, added } = diff.categories;
+    const { skipHeading, skipUnchanged } = options ?? {};
+    const categoriesCount = changed.length + unchanged.length + added.length;
+    const hasChanges = unchanged.length < categoriesCount;
+    if (categoriesCount === 0) {
+        return null;
+    }
+    const [columns, rows] = createCategoriesTable(diff, {
+        hasChanges,
+        skipUnchanged,
+    });
+    return new MarkdownDocument()
+        .heading(HIERARCHY.level_2, !skipHeading && '🏷️ Categories')
+        .table(columns, rows)
+        .paragraph(added.length > 0 && md.italic(String.raw `(\*) New category.`))
+        .paragraph(skipUnchanged &&
+        unchanged.length > 0 &&
+        summarizeUnchanged('category', { changed, unchanged }));
+}
+function createCategoriesTable(diff, options) {
+    const { changed, unchanged, added } = diff.categories;
+    const { hasChanges, skipUnchanged } = options;
+    const rows = [
+        ...sortChanges(changed).map(category => [
+            formatTitle(category),
+            formatScoreWithColor(category.scores.before, {
+                skipBold: true,
+            }),
+            formatScoreWithColor(category.scores.after),
+            formatScoreChange(category.scores.diff),
+        ]),
+        ...added.map(category => [
+            formatTitle(category),
+            md.italic(String.raw `n/a (\*)`),
+            formatScoreWithColor(category.score),
+            md.italic(String.raw `n/a (\*)`),
+        ]),
+        ...(skipUnchanged
+            ? []
+            : unchanged.map(category => [
+                formatTitle(category),
+                formatScoreWithColor(category.score, { skipBold: true }),
+                formatScoreWithColor(category.score),
+                '–',
+            ])),
+    ];
+    if (rows.length === 0) {
+        return [[], []];
+    }
+    const columns = [
+        { heading: '🏷️ Category', alignment: 'left' },
+        {
+            heading: hasChanges ? '⭐ Previous score' : '⭐ Score',
+            alignment: 'center',
+        },
+        { heading: '⭐ Current score', alignment: 'center' },
+        { heading: '🔄 Score change', alignment: 'center' },
+    ];
+    return [
+        hasChanges ? columns : columns.slice(0, 2),
+        rows.map(row => (hasChanges ? row : row.slice(0, 2))),
+    ];
+}
+function createDiffDetailsSection(diff, level = HIERARCHY.level_2) {
+    if (diff.groups.changed.length + diff.audits.changed.length === 0) {
+        return null;
+    }
+    const summary = ['group', 'audit']
+        .map(token => summarizeDiffOutcomes(changesToDiffOutcomes(diff[`${token}s`].changed), token))
+        .filter(Boolean)
+        .join(', ');
+    const details = new MarkdownDocument().$concat(createDiffGroupsSection(diff, level), createDiffAuditsSection(diff, level));
+    return new MarkdownDocument().details(summary, details);
+}
+function createDiffGroupsSection(diff, level) {
+    if (diff.groups.changed.length + diff.groups.unchanged.length === 0) {
+        return null;
+    }
+    return new MarkdownDocument().heading(level, '🗃️ Groups').$concat(createGroupsOrAuditsDetails('group', diff.groups, [
+        { heading: '🔌 Plugin', alignment: 'left' },
+        { heading: '🗃️ Group', alignment: 'left' },
+        { heading: '⭐ Previous score', alignment: 'center' },
+        { heading: '⭐ Current score', alignment: 'center' },
+        { heading: '🔄 Score change', alignment: 'center' },
+    ], sortChanges(diff.groups.changed).map(group => [
+        formatTitle(group.plugin),
+        formatTitle(group),
+        formatScoreWithColor(group.scores.before, { skipBold: true }),
+        formatScoreWithColor(group.scores.after),
+        formatScoreChange(group.scores.diff),
+    ])));
+}
+function createDiffAuditsSection(diff, level) {
+    return new MarkdownDocument().heading(level, '🛡️ Audits').$concat(createGroupsOrAuditsDetails('audit', diff.audits, [
+        { heading: '🔌 Plugin', alignment: 'left' },
+        { heading: '🛡️ Audit', alignment: 'left' },
+        { heading: '📏 Previous value', alignment: 'center' },
+        { heading: '📏 Current value', alignment: 'center' },
+        { heading: '🔄 Value change', alignment: 'center' },
+    ], sortChanges(diff.audits.changed).map(audit => [
+        formatTitle(audit.plugin),
+        formatTitle(audit),
+        `${scoreMarker(audit.scores.before, 'square')} ${audit.displayValues.before || audit.values.before.toString()}`,
+        md `${scoreMarker(audit.scores.after, 'square')} ${md.bold(audit.displayValues.after || audit.values.after.toString())}`,
+        formatValueChange(audit),
+    ])));
+}
+//# sourceMappingURL=generate-md-reports-diff.js.map