@code-pushup/core 0.55.0 → 0.57.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/core",
-  "version": "0.55.0",
+  "version": "0.57.0",
   "license": "MIT",
   "description": "Core business logic for the used by the Code PushUp CLI",
   "homepage": "https://github.com/code-pushup/cli/tree/main/packages/core#readme",
@@ -38,12 +38,11 @@
     "access": "public"
   },
   "type": "module",
-  "main": "./index.js",
-  "types": "./src/index.d.ts",
   "dependencies": {
-    "@code-pushup/models": "0.55.0",
-    "@code-pushup/utils": "0.55.0",
-    "ansis": "^3.3.0"
+    "@code-pushup/models": "0.57.0",
+    "@code-pushup/utils": "0.57.0",
+    "ansis": "^3.3.0",
+    "zod-validation-error": "^3.4.0"
   },
   "peerDependencies": {
     "@code-pushup/portal-client": "^0.9.0"
@@ -52,5 +51,8 @@
     "@code-pushup/portal-client": {
       "optional": true
     }
-  }
-}
+  },
+  "module": "./src/index.js",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts"
+}

package/src/index.d.ts

@@ -1,11 +1,11 @@
-export { type CollectAndPersistReportsOptions, collectAndPersistReports, } from './lib/collect-and-persist';
-export { compareReportFiles, compareReports } from './lib/compare';
-export { type CollectOptions, collect } from './lib/implementation/collect';
-export type { ReportsToCompare } from './lib/implementation/compare-scorables';
-export { PluginOutputMissingAuditError, executePlugin, executePlugins, } from './lib/implementation/execute-plugin';
-export { PersistDirError, PersistError, persistReport, } from './lib/implementation/persist';
-export { history, type HistoryOptions, type HistoryOnlyOptions, } from './lib/history';
-export { ConfigPathError, autoloadRc, readRcByPath, } from './lib/implementation/read-rc-file';
-export type { GlobalOptions } from './lib/types';
-export { type UploadOptions, upload } from './lib/upload';
-export { mergeDiffs } from './lib/merge-diffs';
+export { type CollectAndPersistReportsOptions, collectAndPersistReports, } from './lib/collect-and-persist.js';
+export { compareReportFiles, compareReports } from './lib/compare.js';
+export { type CollectOptions, collect } from './lib/implementation/collect.js';
+export type { ReportsToCompare } from './lib/implementation/compare-scorables.js';
+export { PluginOutputMissingAuditError, executePlugin, executePlugins, } from './lib/implementation/execute-plugin.js';
+export { PersistDirError, PersistError, persistReport, } from './lib/implementation/persist.js';
+export { history, type HistoryOptions, type HistoryOnlyOptions, } from './lib/history.js';
+export { ConfigPathError, autoloadRc, readRcByPath, } from './lib/implementation/read-rc-file.js';
+export type { GlobalOptions } from './lib/types.js';
+export { type UploadOptions, upload } from './lib/upload.js';
+export { mergeDiffs } from './lib/merge-diffs.js';

package/src/index.js

@@ -0,0 +1,10 @@
+export { collectAndPersistReports, } from './lib/collect-and-persist.js';
+export { compareReportFiles, compareReports } from './lib/compare.js';
+export { collect } from './lib/implementation/collect.js';
+export { PluginOutputMissingAuditError, executePlugin, executePlugins, } from './lib/implementation/execute-plugin.js';
+export { PersistDirError, PersistError, persistReport, } from './lib/implementation/persist.js';
+export { history, } from './lib/history.js';
+export { ConfigPathError, autoloadRc, readRcByPath, } from './lib/implementation/read-rc-file.js';
+export { upload } from './lib/upload.js';
+export { mergeDiffs } from './lib/merge-diffs.js';
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/core/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,wBAAwB,GACzB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACtE,OAAO,EAAuB,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAE/E,OAAO,EACL,6BAA6B,EAC7B,aAAa,EACb,cAAc,GACf,MAAM,wCAAwC,CAAC;AAChD,OAAO,EACL,eAAe,EACf,YAAY,EACZ,aAAa,GACd,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,OAAO,GAGR,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,eAAe,EACf,UAAU,EACV,YAAY,GACb,MAAM,sCAAsC,CAAC;AAE9C,OAAO,EAAsB,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC"}

package/src/lib/collect-and-persist.d.ts

@@ -1,5 +1,5 @@
 import { type CoreConfig, type PersistConfig } from '@code-pushup/models';
-import type { GlobalOptions } from './types';
+import type { GlobalOptions } from './types.js';
 export type CollectAndPersistReportsOptions = Pick<CoreConfig, 'plugins' | 'categories'> & {
     persist: Required<PersistConfig>;
 } & Partial<GlobalOptions>;

package/src/lib/collect-and-persist.js

@@ -0,0 +1,21 @@
+import { pluginReportSchema, } from '@code-pushup/models';
+import { logStdoutSummary, scoreReport, sortReport, verboseUtils, } from '@code-pushup/utils';
+import { collect } from './implementation/collect.js';
+import { logPersistedResults, persistReport, } from './implementation/persist.js';
+export async function collectAndPersistReports(options) {
+    const { exec } = verboseUtils(options.verbose);
+    const report = await collect(options);
+    const sortedScoredReport = sortReport(scoreReport(report));
+    const persistResults = await persistReport(report, sortedScoredReport, options.persist);
+    // terminal output
+    logStdoutSummary(sortedScoredReport, options.verbose);
+    exec(() => {
+        logPersistedResults(persistResults);
+    });
+    // validate report and throw if invalid
+    report.plugins.forEach(plugin => {
+        // Running checks after persisting helps while debugging as you can check the invalid output after the error is thrown
+        pluginReportSchema.parse(plugin);
+    });
+}
+//# sourceMappingURL=collect-and-persist.js.map

package/src/lib/collect-and-persist.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collect-and-persist.js","sourceRoot":"","sources":["../../../../../packages/core/src/lib/collect-and-persist.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,kBAAkB,GACnB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,gBAAgB,EAChB,WAAW,EACX,UAAU,EACV,YAAY,GACb,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,OAAO,EAAE,MAAM,6BAA6B,CAAC;AACtD,OAAO,EACL,mBAAmB,EACnB,aAAa,GACd,MAAM,6BAA6B,CAAC;AAQrC,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,OAAwC;IAExC,MAAM,EAAE,IAAI,EAAE,GAAG,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAE/C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IACtC,MAAM,kBAAkB,GAAG,UAAU,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IAC3D,MAAM,cAAc,GAAG,MAAM,aAAa,CACxC,MAAM,EACN,kBAAkB,EAClB,OAAO,CAAC,OAAO,CAChB,CAAC;IAEF,kBAAkB;IAClB,gBAAgB,CAAC,kBAAkB,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAEtD,IAAI,CAAC,GAAG,EAAE;QACR,mBAAmB,CAAC,cAAc,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IAEH,uCAAuC;IACvC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QAC9B,sHAAsH;QACtH,kBAAkB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC"}

package/src/lib/compare.js

@@ -0,0 +1,96 @@
+import { writeFile } from 'node:fs/promises';
+import { createRequire } from 'node:module';
+import path from 'node:path';
+import { reportSchema, } from '@code-pushup/models';
+import { calcDuration, ensureDirectoryExists, generateMdReportsDiff, readJsonFile, scoreReport, ui, } from '@code-pushup/utils';
+import { compareAudits, compareCategories, compareGroups, } from './implementation/compare-scorables.js';
+import { loadPortalClient } from './load-portal-client.js';
+export async function compareReportFiles(inputPaths, persistConfig, uploadConfig, label) {
+    const { outputDir, filename, format } = persistConfig;
+    const [reportBefore, reportAfter] = await Promise.all([
+        readJsonFile(inputPaths.before),
+        readJsonFile(inputPaths.after),
+    ]);
+    const reports = {
+        before: reportSchema.parse(reportBefore),
+        after: reportSchema.parse(reportAfter),
+    };
+    const diff = compareReports(reports);
+    if (label) {
+        // eslint-disable-next-line functional/immutable-data
+        diff.label = label;
+    }
+    if (uploadConfig && diff.commits) {
+        // eslint-disable-next-line functional/immutable-data
+        diff.portalUrl = await fetchPortalComparisonLink(uploadConfig, diff.commits);
+    }
+    return Promise.all(format.map(async (fmt) => {
+        const outputPath = path.join(outputDir, `${filename}-diff.${fmt}`);
+        const content = reportsDiffToFileContent(diff, fmt);
+        await ensureDirectoryExists(outputDir);
+        await writeFile(outputPath, content);
+        return outputPath;
+    }));
+}
+export function compareReports(reports) {
+    const start = performance.now();
+    const date = new Date().toISOString();
+    const commits = reports.before.commit != null && reports.after.commit != null
+        ? { before: reports.before.commit, after: reports.after.commit }
+        : null;
+    const scoredReports = {
+        before: scoreReport(reports.before),
+        after: scoreReport(reports.after),
+    };
+    const categories = compareCategories(scoredReports);
+    const groups = compareGroups(scoredReports);
+    const audits = compareAudits(scoredReports);
+    const duration = calcDuration(start);
+    const packageJson = createRequire(import.meta.url)('../../package.json');
+    return {
+        commits,
+        categories,
+        groups,
+        audits,
+        packageName: packageJson.name,
+        version: packageJson.version,
+        date,
+        duration,
+    };
+}
+function reportsDiffToFileContent(reportsDiff, format) {
+    switch (format) {
+        case 'json':
+            return JSON.stringify(reportsDiff, null, 2);
+        case 'md':
+            return generateMdReportsDiff(reportsDiff);
+    }
+}
+async function fetchPortalComparisonLink(uploadConfig, commits) {
+    const { server, apiKey, organization, project } = uploadConfig;
+    const portalClient = await loadPortalClient();
+    if (!portalClient) {
+        return;
+    }
+    const { PortalOperationError, getPortalComparisonLink } = portalClient;
+    try {
+        return await getPortalComparisonLink({
+            server,
+            apiKey,
+            parameters: {
+                organization,
+                project,
+                before: commits.before.hash,
+                after: commits.after.hash,
+            },
+        });
+    }
+    catch (error) {
+        if (error instanceof PortalOperationError) {
+            ui().logger.warning(`Failed to fetch portal comparison link - ${error.message}`);
+            return undefined;
+        }
+        throw error;
+    }
+}
+//# sourceMappingURL=compare.js.map

package/src/lib/compare.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compare.js","sourceRoot":"","sources":["../../../../../packages/core/src/lib/compare.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAML,YAAY,GACb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAEL,YAAY,EACZ,qBAAqB,EACrB,qBAAqB,EACrB,YAAY,EACZ,WAAW,EACX,EAAE,GACH,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAEL,aAAa,EACb,iBAAiB,EACjB,aAAa,GACd,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAE3D,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,UAAwB,EACxB,aAAsC,EACtC,YAAsC,EACtC,KAAc;IAEd,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,aAAa,CAAC;IAEtD,MAAM,CAAC,YAAY,EAAE,WAAW,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACpD,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC;QAC/B,YAAY,CAAC,UAAU,CAAC,KAAK,CAAC;KAC/B,CAAC,CAAC;IACH,MAAM,OAAO,GAAiB;QAC5B,MAAM,EAAE,YAAY,CAAC,KAAK,CAAC,YAAY,CAAC;QACxC,KAAK,EAAE,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC;KACvC,CAAC;IAEF,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IACrC,IAAI,KAAK,EAAE,CAAC;QACV,qDAAqD;QACrD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IACD,IAAI,YAAY,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjC,qDAAqD;QACrD,IAAI,CAAC,SAAS,GAAG,MAAM,yBAAyB,CAC9C,YAAY,EACZ,IAAI,CAAC,OAAO,CACb,CAAC;IACJ,CAAC;IAED,OAAO,OAAO,CAAC,GAAG,CAChB,MAAM,CAAC,GAAG,CAAC,KAAK,EAAC,GAAG,EAAC,EAAE;QACrB,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,QAAQ,SAAS,GAAG,EAAE,CAAC,CAAC;QACnE,MAAM,OAAO,GAAG,wBAAwB,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QACpD,MAAM,qBAAqB,CAAC,SAAS,CAAC,CAAC;QACvC,MAAM,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACrC,OAAO,UAAU,CAAC;IACpB,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,OAAqB;IAClD,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAChC,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IAEtC,MAAM,OAAO,GACX,OAAO,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,IAAI,IAAI;QAC3D,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE;QAChE,CAAC,CAAC,IAAI,CAAC;IAEX,MAAM,aAAa,GAAqB;QACtC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC;QACnC,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,KAAK,CAAC;KAClC,CAAC;IAEF,MAAM,UAAU,GAAG,iBAAiB,CAAC,aAAa,CAAC,CAAC;IACpD,MAAM,MAAM,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,aAAa,CAAC,aAAa,CAAC,CAAC;IAE5C,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC;IAErC,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAChD,oBAAoB,CACkB,CAAC;IAEzC,OAAO;QACL,OAAO;QACP,UAAU;QACV,MAAM;QACN,MAAM;QACN,WAAW,EAAE,WAAW,CAAC,IAAI;QAC7B,OAAO,EAAE,WAAW,CAAC,OAAO;QAC5B,IAAI;QACJ,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,SAAS,wBAAwB,CAC/B,WAAwB,EACxB,MAAc;IAEd,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,MAAM;YACT,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;QAC9C,KAAK,IAAI;YACP,OAAO,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;AACH,CAAC;AAED,KAAK,UAAU,yBAAyB,CACtC,YAA0B,EAC1B,OAA4C;IAE5C,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC;IAC/D,MAAM,YAAY,GAAG,MAAM,gBAAgB,EAAE,CAAC;IAC9C,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO;IACT,CAAC;IACD,MAAM,EAAE,oBAAoB,EAAE,uBAAuB,EAAE,GAAG,YAAY,CAAC;IACvE,IAAI,CAAC;QACH,OAAO,MAAM,uBAAuB,CAAC;YACnC,MAAM;YACN,MAAM;YACN,UAAU,EAAE;gBACV,YAAY;gBACZ,OAAO;gBACP,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI;gBAC3B,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI;aAC1B;SACF,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,oBAAoB,EAAE,CAAC;YAC1C,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CACjB,4CAA4C,KAAK,CAAC,OAAO,EAAE,CAC5D,CAAC;YACF,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}

package/src/lib/history.d.ts

@@ -1,5 +1,5 @@
 import type { CoreConfig, PersistConfig, UploadConfig } from '@code-pushup/models';
-import type { GlobalOptions } from './types';
+import type { GlobalOptions } from './types.js';
 export type HistoryOnlyOptions = {
     targetBranch?: string;
     skipUploads?: boolean;

package/src/lib/history.js

@@ -0,0 +1,38 @@
+import { getCurrentBranchOrTag, safeCheckout, ui } from '@code-pushup/utils';
+import { collectAndPersistReports } from './collect-and-persist.js';
+import { upload } from './upload.js';
+export async function history(config, commits) {
+    const initialBranch = await getCurrentBranchOrTag();
+    const { skipUploads = false, forceCleanStatus, persist } = config;
+    const reports = [];
+    // eslint-disable-next-line functional/no-loop-statements
+    for (const commit of commits) {
+        ui().logger.info(`Collect ${commit}`);
+        await safeCheckout(commit, forceCleanStatus);
+        const currentConfig = {
+            ...config,
+            persist: {
+                ...persist,
+                format: ['json'],
+                filename: `${commit}-report`,
+            },
+        };
+        await collectAndPersistReports(currentConfig);
+        if (skipUploads) {
+            ui().logger.info('Upload is skipped because skipUploads is set to true.');
+        }
+        else {
+            if (currentConfig.upload) {
+                await upload(currentConfig);
+            }
+            else {
+                ui().logger.info('Upload is skipped because upload config is undefined.');
+            }
+        }
+        // eslint-disable-next-line functional/immutable-data
+        reports.push(currentConfig.persist.filename);
+    }
+    await safeCheckout(initialBranch, forceCleanStatus);
+    return reports;
+}
+//# sourceMappingURL=history.js.map

package/src/lib/history.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"history.js","sourceRoot":"","sources":["../../../../../packages/core/src/lib/history.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,qBAAqB,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,oBAAoB,CAAC;AAC7E,OAAO,EAAE,wBAAwB,EAAE,MAAM,0BAA0B,CAAC;AAEpE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAarC,MAAM,CAAC,KAAK,UAAU,OAAO,CAC3B,MAAsB,EACtB,OAAiB;IAEjB,MAAM,aAAa,GAAW,MAAM,qBAAqB,EAAE,CAAC;IAE5D,MAAM,EAAE,WAAW,GAAG,KAAK,EAAE,gBAAgB,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IAElE,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,yDAAyD;IACzD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,MAAM,EAAE,CAAC,CAAC;QACtC,MAAM,YAAY,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QAE7C,MAAM,aAAa,GAAmB;YACpC,GAAG,MAAM;YACT,OAAO,EAAE;gBACP,GAAG,OAAO;gBACV,MAAM,EAAE,CAAC,MAAM,CAAC;gBAChB,QAAQ,EAAE,GAAG,MAAM,SAAS;aAC7B;SACF,CAAC;QAEF,MAAM,wBAAwB,CAAC,aAAa,CAAC,CAAC;QAE9C,IAAI,WAAW,EAAE,CAAC;YAChB,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,uDAAuD,CAAC,CAAC;QAC5E,CAAC;aAAM,CAAC;YACN,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;gBACzB,MAAM,MAAM,CAAC,aAAa,CAAC,CAAC;YAC9B,CAAC;iBAAM,CAAC;gBACN,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CACd,uDAAuD,CACxD,CAAC;YACJ,CAAC;QACH,CAAC;QAED,qDAAqD;QACrD,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED,MAAM,YAAY,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IAEpD,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/src/lib/implementation/collect.d.ts

@@ -1,5 +1,5 @@
 import type { CoreConfig, Report } from '@code-pushup/models';
-import type { GlobalOptions } from '../types';
+import type { GlobalOptions } from '../types.js';
 export type CollectOptions = Pick<CoreConfig, 'plugins' | 'categories'> & Partial<GlobalOptions>;
 /**
  * Run audits, collect plugin output and aggregate it into a JSON object

package/src/lib/implementation/collect.js

@@ -0,0 +1,25 @@
+import { createRequire } from 'node:module';
+import { calcDuration, getLatestCommit } from '@code-pushup/utils';
+import { executePlugins } from './execute-plugin.js';
+/**
+ * Run audits, collect plugin output and aggregate it into a JSON object
+ * @param options
+ */
+export async function collect(options) {
+    const { plugins, categories } = options;
+    const date = new Date().toISOString();
+    const start = performance.now();
+    const commit = await getLatestCommit();
+    const pluginOutputs = await executePlugins(plugins, options);
+    const packageJson = createRequire(import.meta.url)('../../../package.json');
+    return {
+        commit,
+        packageName: packageJson.name,
+        version: packageJson.version,
+        date,
+        duration: calcDuration(start),
+        categories,
+        plugins: pluginOutputs,
+    };
+}
+//# sourceMappingURL=collect.js.map

package/src/lib/implementation/collect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collect.js","sourceRoot":"","sources":["../../../../../../packages/core/src/lib/implementation/collect.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEnE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAKrD;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,OAAuB;IACnD,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;IACxC,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACtC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAChC,MAAM,MAAM,GAAG,MAAM,eAAe,EAAE,CAAC;IACvC,MAAM,aAAa,GAAG,MAAM,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC7D,MAAM,WAAW,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAChD,uBAAuB,CACkB,CAAC;IAC5C,OAAO;QACL,MAAM;QACN,WAAW,EAAE,WAAW,CAAC,IAAI;QAC7B,OAAO,EAAE,WAAW,CAAC,OAAO;QAC5B,IAAI;QACJ,QAAQ,EAAE,YAAY,CAAC,KAAK,CAAC;QAC7B,UAAU;QACV,OAAO,EAAE,aAAa;KACvB,CAAC;AACJ,CAAC"}

package/src/lib/implementation/compare-scorables.js

@@ -0,0 +1,117 @@
+import { comparePairs, listAuditsFromAllPlugins, listGroupsFromAllPlugins, matchArrayItemsByKey, } from '@code-pushup/utils';
+export function compareCategories(reports) {
+    const { pairs, added, removed } = matchArrayItemsByKey({
+        before: reports.before.categories ?? [],
+        after: reports.after.categories ?? [],
+        key: 'slug',
+    });
+    const { changed, unchanged } = comparePairs(pairs, ({ before, after }) => before.score === after.score);
+    return {
+        changed: changed.map(categoryPairToDiff),
+        unchanged: unchanged.map(categoryToResult),
+        added: added.map(categoryToResult),
+        removed: removed.map(categoryToResult),
+    };
+}
+export function compareGroups(reports) {
+    const { pairs, added, removed } = matchArrayItemsByKey({
+        before: listGroupsFromAllPlugins(reports.before),
+        after: listGroupsFromAllPlugins(reports.after),
+        key: ({ plugin, group }) => `${plugin.slug}/${group.slug}`,
+    });
+    const { changed, unchanged } = comparePairs(pairs, ({ before, after }) => before.group.score === after.group.score);
+    return {
+        changed: changed.map(pluginGroupPairToDiff),
+        unchanged: unchanged.map(pluginGroupToResult),
+        added: added.map(pluginGroupToResult),
+        removed: removed.map(pluginGroupToResult),
+    };
+}
+export function compareAudits(reports) {
+    const { pairs, added, removed } = matchArrayItemsByKey({
+        before: listAuditsFromAllPlugins(reports.before),
+        after: listAuditsFromAllPlugins(reports.after),
+        key: ({ plugin, audit }) => `${plugin.slug}/${audit.slug}`,
+    });
+    const { changed, unchanged } = comparePairs(pairs, ({ before, after }) => before.audit.value === after.audit.value &&
+        before.audit.score === after.audit.score);
+    return {
+        changed: changed.map(pluginAuditPairToDiff),
+        unchanged: unchanged.map(pluginAuditToResult),
+        added: added.map(pluginAuditToResult),
+        removed: removed.map(pluginAuditToResult),
+    };
+}
+function categoryToResult(category) {
+    return {
+        ...selectMeta(category),
+        score: category.score,
+    };
+}
+function categoryPairToDiff({ before, after, }) {
+    return {
+        ...selectMeta(after),
+        scores: {
+            before: before.score,
+            after: after.score,
+            diff: after.score - before.score,
+        },
+    };
+}
+function pluginGroupToResult({ group, plugin }) {
+    return {
+        ...selectMeta(group),
+        plugin: selectMeta(plugin),
+        score: group.score,
+    };
+}
+function pluginGroupPairToDiff({ before, after, }) {
+    return {
+        ...selectMeta(after.group),
+        plugin: selectMeta(after.plugin),
+        scores: {
+            before: before.group.score,
+            after: after.group.score,
+            diff: after.group.score - before.group.score,
+        },
+    };
+}
+function pluginAuditToResult({ audit, plugin }) {
+    return {
+        ...selectMeta(audit),
+        plugin: selectMeta(plugin),
+        score: audit.score,
+        value: audit.value,
+        displayValue: audit.displayValue,
+    };
+}
+function pluginAuditPairToDiff({ before, after, }) {
+    return {
+        ...selectMeta(after.audit),
+        plugin: selectMeta(after.plugin),
+        scores: {
+            before: before.audit.score,
+            after: after.audit.score,
+            diff: after.audit.score - before.audit.score,
+        },
+        values: {
+            before: before.audit.value,
+            after: after.audit.value,
+            diff: after.audit.value - before.audit.value,
+        },
+        displayValues: {
+            before: before.audit.displayValue,
+            after: after.audit.displayValue,
+        },
+    };
+}
+function selectMeta(meta) {
+    return {
+        slug: meta.slug,
+        title: meta.title,
+        ...(meta.docsUrl && {
+            docsUrl: meta.docsUrl,
+        }),
+    };
+}
+//# sourceMappingURL=compare-scorables.js.map

package/src/lib/implementation/compare-scorables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compare-scorables.js","sourceRoot":"","sources":["../../../../../../packages/core/src/lib/implementation/compare-scorables.ts"],"names":[],"mappings":"AAWA,OAAO,EAKL,YAAY,EACZ,wBAAwB,EACxB,wBAAwB,EACxB,oBAAoB,GACrB,MAAM,oBAAoB,CAAC;AAI5B,MAAM,UAAU,iBAAiB,CAC/B,OAAyB;IAEzB,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,oBAAoB,CAAC;QACrD,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE;QACvC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,UAAU,IAAI,EAAE;QACrC,GAAG,EAAE,MAAM;KACZ,CAAC,CAAC;IACH,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,YAAY,CACzC,KAAK,EACL,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CACpD,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC;QACxC,SAAS,EAAE,SAAS,CAAC,GAAG,CAAC,gBAAgB,CAAC;QAC1C,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,gBAAgB,CAAC;QAClC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC;KACvC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,OAAyB;IAEzB,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,oBAAoB,CAAC;QACrD,MAAM,EAAE,wBAAwB,CAAC,OAAO,CAAC,MAAM,CAAC;QAChD,KAAK,EAAE,wBAAwB,CAAC,OAAO,CAAC,KAAK,CAAC;QAC9C,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE;KAC3D,CAAC,CAAC;IACH,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,YAAY,CACzC,KAAK,EACL,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CAAC,KAAK,CAChE,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;QAC3C,SAAS,EAAE,SAAS,CAAC,GAAG,CAAC,mBAAmB,CAAC;QAC7C,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,mBAAmB,CAAC;QACrC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;KAC1C,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,OAAyB;IAEzB,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,oBAAoB,CAAC;QACrD,MAAM,EAAE,wBAAwB,CAAC,OAAO,CAAC,MAAM,CAAC;QAChD,KAAK,EAAE,wBAAwB,CAAC,OAAO,CAAC,KAAK,CAAC;QAC9C,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE;KAC3D,CAAC,CAAC;IACH,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,YAAY,CACzC,KAAK,EACL,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,CACpB,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CAAC,KAAK;QACxC,MAAM,CAAC,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CAAC,KAAK,CAC3C,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;QAC3C,SAAS,EAAE,SAAS,CAAC,GAAG,CAAC,mBAAmB,CAAC;QAC7C,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,mBAAmB,CAAC;QACrC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC;KAC1C,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,QAA8B;IACtD,OAAO;QACL,GAAG,UAAU,CAAC,QAAQ,CAAC;QACvB,KAAK,EAAE,QAAQ,CAAC,KAAK;KACtB,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,EAC1B,MAAM,EACN,KAAK,GACsB;IAC3B,OAAO;QACL,GAAG,UAAU,CAAC,KAAK,CAAC;QACpB,MAAM,EAAE;YACN,MAAM,EAAE,MAAM,CAAC,KAAK;YACpB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,IAAI,EAAE,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK;SACjC;KACF,CAAC;AACJ,CAAC;AAOD,SAAS,mBAAmB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAe;IACzD,OAAO;QACL,GAAG,UAAU,CAAC,KAAK,CAAC;QACpB,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC;QAC1B,KAAK,EAAE,KAAK,CAAC,KAAK;KACnB,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,EAC7B,MAAM,EACN,KAAK,GACa;IAClB,OAAO;QACL,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC;QAC1B,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC;QAChC,MAAM,EAAE;YACN,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK;YAC1B,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK;YACxB,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK;SAC7C;KACF,CAAC;AACJ,CAAC;AAOD,SAAS,mBAAmB,CAAC,EAAE,KAAK,EAAE,MAAM,EAAe;IACzD,OAAO;QACL,GAAG,UAAU,CAAC,KAAK,CAAC;QACpB,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC;QAC1B,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,YAAY,EAAE,KAAK,CAAC,YAAY;KACjC,CAAC;AACJ,CAAC;AAED,SAAS,qBAAqB,CAAC,EAC7B,MAAM,EACN,KAAK,GACa;IAClB,OAAO;QACL,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC;QAC1B,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC;QAChC,MAAM,EAAE;YACN,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK;YAC1B,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK;YACxB,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK;SAC7C;QACD,MAAM,EAAE;YACN,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK;YAC1B,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK;YACxB,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK;SAC7C;QACD,aAAa,EAAE;YACb,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,YAAY;YACjC,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,YAAY;SAChC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,UAAU,CAEjB,IAAO;IACP,OAAO;QACL,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,KAAK,EAAE,IAAI,CAAC,KAAK;QACjB,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI;YAClB,OAAO,EAAE,IAAI,CAAC,OAAO;SACtB,CAAC;KACH,CAAC;AACJ,CAAC"}

package/src/lib/implementation/execute-plugin.js

@@ -0,0 +1,126 @@
+import { bold } from 'ansis';
+import { auditOutputsSchema, } from '@code-pushup/models';
+import { getProgressBar, groupByStatus, logMultipleResults, pluralizeToken, } from '@code-pushup/utils';
+import { normalizeAuditOutputs } from '../normalize.js';
+import { executeRunnerConfig, executeRunnerFunction } from './runner.js';
+/**
+ * Error thrown when plugin output is invalid.
+ */
+export class PluginOutputMissingAuditError extends Error {
+    constructor(auditSlug) {
+        super(`Audit metadata not present in plugin config. Missing slug: ${bold(auditSlug)}`);
+    }
+}
+/**
+ * Execute a plugin.
+ *
+ * @public
+ * @param pluginConfig - {@link ProcessConfig} object with runner and meta
+ * @param onProgress - progress handler {@link OnProgress}
+ * @returns {Promise<AuditOutput[]>} - audit outputs from plugin runner
+ * @throws {PluginOutputMissingAuditError} - if plugin runner output is invalid
+ *
+ * @example
+ * // plugin execution
+ * const pluginCfg = pluginConfigSchema.parse({...});
+ * const output = await executePlugin(pluginCfg);
+ *
+ *  @example
+ *  // error handling
+ *  try {
+ *  await executePlugin(pluginCfg);
+ *  } catch (e) {
+ *  console.error(e.message);
+ *  }
+ */
+export async function executePlugin(pluginConfig, onProgress) {
+    const { runner, audits: pluginConfigAudits, description, docsUrl, groups, ...pluginMeta } = pluginConfig;
+    // execute plugin runner
+    const runnerResult = typeof runner === 'object'
+        ? await executeRunnerConfig(runner, onProgress)
+        : await executeRunnerFunction(runner, onProgress);
+    const { audits: unvalidatedAuditOutputs, ...executionMeta } = runnerResult;
+    // validate auditOutputs
+    const result = auditOutputsSchema.safeParse(unvalidatedAuditOutputs);
+    if (!result.success) {
+        throw new Error(`Audit output is invalid: ${result.error.message}`);
+    }
+    const auditOutputs = result.data;
+    auditOutputsCorrelateWithPluginOutput(auditOutputs, pluginConfigAudits);
+    const normalizedAuditOutputs = await normalizeAuditOutputs(auditOutputs);
+    // enrich `AuditOutputs` to `AuditReport`
+    const auditReports = normalizedAuditOutputs.map((auditOutput) => ({
+        ...auditOutput,
+        ...pluginConfigAudits.find(audit => audit.slug === auditOutput.slug),
+    }));
+    // create plugin report
+    return {
+        ...pluginMeta,
+        ...executionMeta,
+        audits: auditReports,
+        ...(description && { description }),
+        ...(docsUrl && { docsUrl }),
+        ...(groups && { groups }),
+    };
+}
+const wrapProgress = async (pluginCfg, steps, progressBar) => {
+    progressBar?.updateTitle(`Executing ${bold(pluginCfg.title)}`);
+    try {
+        const pluginReport = await executePlugin(pluginCfg);
+        progressBar?.incrementInSteps(steps);
+        return pluginReport;
+    }
+    catch (error) {
+        progressBar?.incrementInSteps(steps);
+        throw new Error(error instanceof Error
+            ? `- Plugin ${bold(pluginCfg.title)} (${bold(pluginCfg.slug)}) produced the following error:\n  - ${error.message}`
+            : String(error));
+    }
+};
+/**
+ * Execute multiple plugins and aggregates their output.
+ * @public
+ * @param plugins array of {@link PluginConfig} objects
+ * @param {Object} [options] execution options
+ * @param {boolean} options.progress show progress bar
+ * @returns {Promise<PluginReport[]>} plugin report
+ *
+ * @example
+ * // plugin execution
+ * const plugins = [pluginConfigSchema.parse({...})];
+ *
+ * @example
+ * // error handling
+ * try {
+ * await executePlugins(plugins);
+ * } catch (e) {
+ * console.error(e.message); // Plugin output is invalid
+ * }
+ *
+ */
+export async function executePlugins(plugins, options) {
+    const { progress = false } = options ?? {};
+    const progressBar = progress ? getProgressBar('Run plugins') : null;
+    const pluginsResult = plugins.map(pluginCfg => wrapProgress(pluginCfg, plugins.length, progressBar));
+    const errorsTransform = ({ reason }) => String(reason);
+    const results = await Promise.allSettled(pluginsResult);
+    progressBar?.endProgress('Done running plugins');
+    logMultipleResults(results, 'Plugins', undefined, errorsTransform);
+    const { fulfilled, rejected } = groupByStatus(results);
+    if (rejected.length > 0) {
+        const errorMessages = rejected
+            .map(({ reason }) => String(reason))
+            .join('\n');
+        throw new Error(`Executing ${pluralizeToken('plugin', rejected.length)} failed.\n\n${errorMessages}\n\n`);
+    }
+    return fulfilled.map(result => result.value);
+}
+function auditOutputsCorrelateWithPluginOutput(auditOutputs, pluginConfigAudits) {
+    auditOutputs.forEach(auditOutput => {
+        const auditMetadata = pluginConfigAudits.find(audit => audit.slug === auditOutput.slug);
+        if (!auditMetadata) {
+            throw new PluginOutputMissingAuditError(auditOutput.slug);
+        }
+    });
+}
+//# sourceMappingURL=execute-plugin.js.map

package/src/lib/implementation/execute-plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"execute-plugin.js","sourceRoot":"","sources":["../../../../../../packages/core/src/lib/implementation/execute-plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAC7B,OAAO,EAQL,kBAAkB,GACnB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAEL,cAAc,EACd,aAAa,EACb,kBAAkB,EAClB,cAAc,GACf,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AAEzE;;GAEG;AACH,MAAM,OAAO,6BAA8B,SAAQ,KAAK;IACtD,YAAY,SAAiB;QAC3B,KAAK,CACH,8DAA8D,IAAI,CAChE,SAAS,CACV,EAAE,CACJ,CAAC;IACJ,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,YAA0B,EAC1B,UAAuB;IAEvB,MAAM,EACJ,MAAM,EACN,MAAM,EAAE,kBAAkB,EAC1B,WAAW,EACX,OAAO,EACP,MAAM,EACN,GAAG,UAAU,EACd,GAAG,YAAY,CAAC;IAEjB,wBAAwB;IACxB,MAAM,YAAY,GAChB,OAAO,MAAM,KAAK,QAAQ;QACxB,CAAC,CAAC,MAAM,mBAAmB,CAAC,MAAM,EAAE,UAAU,CAAC;QAC/C,CAAC,CAAC,MAAM,qBAAqB,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IACtD,MAAM,EAAE,MAAM,EAAE,uBAAuB,EAAE,GAAG,aAAa,EAAE,GAAG,YAAY,CAAC;IAE3E,wBAAwB;IACxB,MAAM,MAAM,GAAG,kBAAkB,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC;IACrE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,4BAA4B,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACtE,CAAC;IACD,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC;IACjC,qCAAqC,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAAC;IAExE,MAAM,sBAAsB,GAAG,MAAM,qBAAqB,CAAC,YAAY,CAAC,CAAC;IAEzE,yCAAyC;IACzC,MAAM,YAAY,GAAkB,sBAAsB,CAAC,GAAG,CAC5D,CAAC,WAAwB,EAAE,EAAE,CAAC,CAAC;QAC7B,GAAG,WAAW;QACd,GAAI,kBAAkB,CAAC,IAAI,CACzB,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,CAC/B;KACZ,CAAC,CACH,CAAC;IAEF,uBAAuB;IACvB,OAAO;QACL,GAAG,UAAU;QACb,GAAG,aAAa;QAChB,MAAM,EAAE,YAAY;QACpB,GAAG,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,CAAC;QACnC,GAAG,CAAC,OAAO,IAAI,EAAE,OAAO,EAAE,CAAC;QAC3B,GAAG,CAAC,MAAM,IAAI,EAAE,MAAM,EAAE,CAAC;KAC1B,CAAC;AACJ,CAAC;AAED,MAAM,YAAY,GAAG,KAAK,EACxB,SAAuB,EACvB,KAAa,EACb,WAA+B,EAC/B,EAAE;IACF,WAAW,EAAE,WAAW,CAAC,aAAa,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC/D,IAAI,CAAC;QACH,MAAM,YAAY,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,CAAC;QACpD,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACrC,OAAO,YAAY,CAAC;IACtB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,WAAW,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACrC,MAAM,IAAI,KAAK,CACb,KAAK,YAAY,KAAK;YACpB,CAAC,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,KAAK,IAAI,CACxC,SAAS,CAAC,IAAI,CACf,wCAAwC,KAAK,CAAC,OAAO,EAAE;YAC1D,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAClB,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAAuB,EACvB,OAAgC;IAEhC,MAAM,EAAE,QAAQ,GAAG,KAAK,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAE3C,MAAM,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAEpE,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAC5C,YAAY,CAAC,SAAS,EAAE,OAAO,CAAC,MAAM,EAAE,WAAW,CAAC,CACrD,CAAC;IAEF,MAAM,eAAe,GAAG,CAAC,EAAE,MAAM,EAAyB,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC9E,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;IAExD,WAAW,EAAE,WAAW,CAAC,sBAAsB,CAAC,CAAC;IAEjD,kBAAkB,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;IAEnE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;IACvD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,aAAa,GAAG,QAAQ;aAC3B,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;aACnC,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,MAAM,IAAI,KAAK,CACb,aAAa,cAAc,CACzB,QAAQ,EACR,QAAQ,CAAC,MAAM,CAChB,eAAe,aAAa,MAAM,CACpC,CAAC;IACJ,CAAC;IAED,OAAO,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,qCAAqC,CAC5C,YAA0B,EAC1B,kBAA0C;IAE1C,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QACjC,MAAM,aAAa,GAAG,kBAAkB,CAAC,IAAI,CAC3C,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW,CAAC,IAAI,CACzC,CAAC;QACF,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,6BAA6B,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC"}

package/src/lib/implementation/persist.js

@@ -0,0 +1,56 @@
+import { mkdir, stat, writeFile } from 'node:fs/promises';
+import path from 'node:path';
+import { directoryExists, generateMdReport, logMultipleFileResults, ui, } from '@code-pushup/utils';
+export class PersistDirError extends Error {
+    constructor(outputDir) {
+        super(`outPath: ${outputDir} is no directory.`);
+    }
+}
+export class PersistError extends Error {
+    constructor(reportPath) {
+        super(`fileName: ${reportPath} could not be saved.`);
+    }
+}
+export async function persistReport(report, sortedScoredReport, options) {
+    const { outputDir, filename, format } = options;
+    // collect physical format outputs
+    const results = format.map(reportType => {
+        switch (reportType) {
+            case 'json':
+                return {
+                    format: 'json',
+                    content: JSON.stringify(report, null, 2),
+                };
+            case 'md':
+                return {
+                    format: 'md',
+                    content: generateMdReport(sortedScoredReport, { outputDir }),
+                };
+        }
+    });
+    if (!(await directoryExists(outputDir))) {
+        try {
+            await mkdir(outputDir, { recursive: true });
+        }
+        catch (error) {
+            ui().logger.warning(error.toString());
+            throw new PersistDirError(outputDir);
+        }
+    }
+    // write relevant format outputs to file system
+    return Promise.allSettled(results.map(result => persistResult(path.join(outputDir, `${filename}.${result.format}`), result.content)));
+}
+async function persistResult(reportPath, content) {
+    return (writeFile(reportPath, content)
+        // return reportPath instead of void
+        .then(() => stat(reportPath))
+        .then(stats => [reportPath, stats.size])
+        .catch(error => {
+        ui().logger.warning(error.toString());
+        throw new PersistError(reportPath);
+    }));
+}
+export function logPersistedResults(persistResults) {
+    logMultipleFileResults(persistResults, 'Generated reports');
+}
+//# sourceMappingURL=persist.js.map

package/src/lib/implementation/persist.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"persist.js","sourceRoot":"","sources":["../../../../../../packages/core/src/lib/implementation/persist.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAGL,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,EAAE,GACH,MAAM,oBAAoB,CAAC;AAE5B,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxC,YAAY,SAAiB;QAC3B,KAAK,CAAC,YAAY,SAAS,mBAAmB,CAAC,CAAC;IAClD,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,YAAY,UAAkB;QAC5B,KAAK,CAAC,aAAa,UAAU,sBAAsB,CAAC,CAAC;IACvD,CAAC;CACF;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,MAAc,EACd,kBAAgC,EAChC,OAAgC;IAEhC,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAEhD,kCAAkC;IAClC,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;QACtC,QAAQ,UAAU,EAAE,CAAC;YACnB,KAAK,MAAM;gBACT,OAAO;oBACL,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;iBACzC,CAAC;YACJ,KAAK,IAAI;gBACP,OAAO;oBACL,MAAM,EAAE,IAAI;oBACZ,OAAO,EAAE,gBAAgB,CAAC,kBAAkB,EAAE,EAAE,SAAS,EAAE,CAAC;iBAC7D,CAAC;QACN,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,CAAC,MAAM,eAAe,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC;YACH,MAAM,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAE,KAAe,CAAC,QAAQ,EAAE,CAAC,CAAC;YACjD,MAAM,IAAI,eAAe,CAAC,SAAS,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAED,+CAA+C;IAC/C,OAAO,OAAO,CAAC,UAAU,CACvB,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CACnB,aAAa,CACX,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC,EACpD,MAAM,CAAC,OAAO,CACf,CACF,CACF,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,UAAkB,EAAE,OAAe;IAC9D,OAAO,CACL,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC;QAC5B,oCAAoC;SACnC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAC5B,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAU,CAAC;SAChD,KAAK,CAAC,KAAK,CAAC,EAAE;QACb,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAE,KAAe,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjD,MAAM,IAAI,YAAY,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC,CAAC,CACL,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,cAAmC;IACrE,sBAAsB,CAAC,cAAc,EAAE,mBAAmB,CAAC,CAAC;AAC9D,CAAC"}

package/src/lib/implementation/read-rc-file.d.ts

@@ -2,5 +2,8 @@ import { type CoreConfig } from '@code-pushup/models';
 export declare class ConfigPathError extends Error {
     constructor(configPath: string);
 }
+export declare class ConfigValidationError extends Error {
+    constructor(configPath: string, message: string);
+}
 export declare function readRcByPath(filepath: string, tsconfig?: string): Promise<CoreConfig>;
 export declare function autoloadRc(tsconfig?: string): Promise<CoreConfig>;