@code-pushup/core 0.26.1 → 0.28.0

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@code-pushup/core",
-  "version": "0.26.1",
+  "version": "0.28.0",
   "license": "MIT",
   "dependencies": {
     "@code-pushup/models": "*",
     "@code-pushup/utils": "*",
     "@code-pushup/portal-client": "^0.6.1",
-    "chalk": "^5.3.0"
+    "chalk": "^5.3.0",
+    "simple-git": "^3.20.0"
   },
   "type": "module",
   "main": "./index.js",

package/src/index.d.ts

@@ -1,5 +1,7 @@
 export { CollectAndPersistReportsOptions, collectAndPersistReports, } from './lib/collect-and-persist';
+export { compareReportFiles, compareReports } from './lib/compare';
 export { CollectOptions, collect } from './lib/implementation/collect';
+export { ReportsToCompare } from './lib/implementation/compare-scorables';
 export { PluginOutputMissingAuditError, executePlugin, executePlugins, } from './lib/implementation/execute-plugin';
 export { PersistDirError, PersistError, persistReport, } from './lib/implementation/persist';
 export { ConfigPathError, autoloadRc, readRcByPath, } from './lib/implementation/read-rc-file';

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

@@ -2,5 +2,5 @@ import { CoreConfig, PersistConfig } from '@code-pushup/models';
 import { GlobalOptions } from './types';
 export type CollectAndPersistReportsOptions = Required<Pick<CoreConfig, 'plugins' | 'categories'>> & {
     persist: Required<PersistConfig>;
-} & GlobalOptions;
+} & Partial<GlobalOptions>;
 export declare function collectAndPersistReports(options: CollectAndPersistReportsOptions): Promise<void>;

package/src/lib/compare.d.ts

@@ -0,0 +1,4 @@
+import { type PersistConfig, Report, ReportsDiff } from '@code-pushup/models';
+import { Diff } from '@code-pushup/utils';
+export declare function compareReportFiles(inputPaths: Diff<string>, persistConfig: Required<PersistConfig>): Promise<string[]>;
+export declare function compareReports(reports: Diff<Report>): ReportsDiff;

package/src/lib/history.d.ts

@@ -0,0 +1,15 @@
+import { LogOptions, LogResult } from 'simple-git';
+import { CoreConfig, PersistConfig, UploadConfig } from '@code-pushup/models';
+import { GlobalOptions } from './types';
+export type HistoryOnlyOptions = {
+    targetBranch?: string;
+    skipUploads?: boolean;
+    forceCleanStatus?: boolean;
+};
+export type HistoryOptions = Required<Pick<CoreConfig, 'plugins' | 'categories'>> & {
+    persist: Required<PersistConfig>;
+    upload?: Required<UploadConfig>;
+} & HistoryOnlyOptions & Partial<GlobalOptions>;
+export declare function history(config: HistoryOptions, commits: string[]): Promise<string[]>;
+export declare function getHashes(options: LogOptions, git?: import("simple-git").SimpleGit): Promise<string[]>;
+export declare function prepareHashes(logs: LogResult): string[];

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

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

package/src/lib/implementation/compare-scorables.d.ts

@@ -0,0 +1,6 @@
+import { ReportsDiff } from '@code-pushup/models';
+import { Diff, ScoredReport } from '@code-pushup/utils';
+export type ReportsToCompare = Diff<ScoredReport>;
+export declare function compareCategories(reports: ReportsToCompare): ReportsDiff['categories'];
+export declare function compareGroups(reports: ReportsToCompare): ReportsDiff['groups'];
+export declare function compareAudits(reports: ReportsToCompare): ReportsDiff['audits'];

package/src/lib/implementation/execute-plugin.d.ts

@@ -50,5 +50,5 @@ export declare function executePlugin(pluginConfig: PluginConfig, onProgress?: O
  *
  */
 export declare function executePlugins(plugins: PluginConfig[], options?: {
-    progress: boolean;
+    progress?: boolean;
 }): Promise<PluginReport[]>;

package/src/lib/upload.d.ts

@@ -5,7 +5,7 @@ export type UploadOptions = {
     upload?: UploadConfig;
 } & {
     persist: Required<PersistConfig>;
-} & GlobalOptions;
+} & Partial<GlobalOptions>;
 /**
  * Uploads collected audits to the portal
  * @param options