@code-pushup/core 0.10.6 → 0.11.0

package/index.js

@@ -1,13 +1,3 @@
-// packages/core/src/lib/implementation/persist.ts
-import { mkdir as mkdir2, stat as stat2, writeFile } from "node:fs/promises";
-import { join as join2 } from "node:path";
-
-// packages/utils/src/lib/execute-process.ts
-import { spawn } from "node:child_process";
-
-// packages/utils/src/lib/reports/utils.ts
-import { join } from "node:path";
-
 // packages/models/src/lib/audit.ts
 import { z as z2 } from "zod";
 
@@ -494,6 +484,10 @@ var PERSIST_OUTPUT_DIR = ".code-pushup";
 var PERSIST_FORMAT = ["json"];
 var PERSIST_FILENAME = "report";
 
+// packages/models/src/lib/implementation/configuration.ts
+var CONFIG_FILE_NAME = "code-pushup.config";
+var SUPPORTED_CONFIG_FILE_FORMATS = ["ts", "mjs", "js"];
+
 // packages/models/src/lib/report.ts
 import { z as z12 } from "zod";
 var auditReportSchema = auditSchema.merge(auditOutputSchema);
@@ -556,6 +550,12 @@ var reportSchema = packageVersionSchema({
   })
 );
 
+// packages/utils/src/lib/execute-process.ts
+import { spawn } from "node:child_process";
+
+// packages/utils/src/lib/reports/utils.ts
+import { join } from "node:path";
+
 // packages/utils/src/lib/file-system.ts
 import { bundleRequire } from "bundle-require";
 import chalk from "chalk";
@@ -1364,24 +1364,6 @@ function deepClone(obj) {
 }
 
 // packages/utils/src/lib/reports/scoring.ts
-function calculateScore(refs, scoreFn) {
-  const { numerator, denominator } = refs.reduce(
-    (acc, ref) => {
-      const score = scoreFn(ref);
-      return {
-        numerator: acc.numerator + score * ref.weight,
-        denominator: acc.denominator + ref.weight
-      };
-    },
-    { numerator: 0, denominator: 0 }
-  );
-  if (!numerator && !denominator) {
-    throw new Error(
-      "0 division for score. This can be caused by refs only weighted with 0 or empty refs"
-    );
-  }
-  return numerator / denominator;
-}
 function scoreReport(report) {
   const allScoredAuditsAndGroups = /* @__PURE__ */ new Map();
   const scoredPlugins = report.plugins.map((plugin) => {
@@ -1431,6 +1413,36 @@ function scoreReport(report) {
     categories: scoredCategories
   };
 }
+function calculateScore(refs, scoreFn) {
+  const validatedRefs = parseScoringParameters(refs, scoreFn);
+  const { numerator, denominator } = validatedRefs.reduce(
+    (acc, ref) => ({
+      numerator: acc.numerator + ref.score * ref.weight,
+      denominator: acc.denominator + ref.weight
+    }),
+    { numerator: 0, denominator: 0 }
+  );
+  return numerator / denominator;
+}
+function parseScoringParameters(refs, scoreFn) {
+  if (refs.length === 0) {
+    throw new Error("Reference array cannot be empty.");
+  }
+  if (refs.some((ref) => ref.weight < 0)) {
+    throw new Error("Weight cannot be negative.");
+  }
+  if (refs.every((ref) => ref.weight === 0)) {
+    throw new Error("All references cannot have zero weight.");
+  }
+  const scoredRefs = refs.map((ref) => ({
+    weight: ref.weight,
+    score: scoreFn(ref)
+  }));
+  if (scoredRefs.some((ref) => ref.score < 0 || ref.score > 1)) {
+    throw new Error("All scores must be in range 0-1.");
+  }
+  return scoredRefs;
+}
 
 // packages/utils/src/lib/reports/sorting.ts
 function sortReport(report) {
@@ -1506,7 +1518,22 @@ var verboseUtils = (verbose) => ({
   exec: getExecVerbose(verbose)
 });
 
+// packages/core/src/lib/implementation/read-code-pushup-config.ts
+var ConfigPathError = class extends Error {
+  constructor(configPath) {
+    super(`Provided path '${configPath}' is not valid.`);
+  }
+};
+async function readCodePushupConfig(filepath) {
+  if (!await fileExists(filepath)) {
+    throw new ConfigPathError(filepath);
+  }
+  return coreConfigSchema.parse(await importEsmModule({ filepath }));
+}
+
 // packages/core/src/lib/implementation/persist.ts
+import { mkdir as mkdir2, stat as stat2, writeFile } from "node:fs/promises";
+import { join as join2 } from "node:path";
 var PersistDirError = class extends Error {
   constructor(outputDir) {
     super(`outPath: ${outputDir} is no directory.`);
@@ -1683,7 +1710,7 @@ function auditOutputsCorrelateWithPluginOutput(auditOutputs, pluginConfigAudits)
 
 // packages/core/package.json
 var name = "@code-pushup/core";
-var version = "0.10.6";
+var version = "0.11.0";
 
 // packages/core/src/lib/implementation/collect.ts
 async function collect(options) {
@@ -1836,28 +1863,54 @@ async function collectAndPersistReports(options) {
   });
 }
 
-// packages/core/src/lib/implementation/read-code-pushup-config.ts
-var ConfigPathError = class extends Error {
+// packages/core/src/lib/implementation/read-rc-file.ts
+import { join as join4 } from "node:path";
+var ConfigPathError2 = class extends Error {
   constructor(configPath) {
     super(`Provided path '${configPath}' is not valid.`);
   }
 };
-async function readCodePushupConfig(filepath) {
+async function readRcByPath(filepath) {
+  if (filepath.length === 0) {
+    throw new Error("The path to the configuration file is empty.");
+  }
   if (!await fileExists(filepath)) {
-    throw new ConfigPathError(filepath);
+    throw new ConfigPathError2(filepath);
   }
-  return coreConfigSchema.parse(await importEsmModule({ filepath }));
+  const cfg = await importEsmModule({ filepath });
+  return coreConfigSchema.parse(cfg);
+}
+async function autoloadRc() {
+  let ext = "";
+  for (const extension of SUPPORTED_CONFIG_FILE_FORMATS) {
+    const path = `${CONFIG_FILE_NAME}.${extension}`;
+    const exists2 = await fileExists(path);
+    if (exists2) {
+      ext = extension;
+      break;
+    }
+  }
+  if (!ext) {
+    throw new Error(
+      `No file ${CONFIG_FILE_NAME}.(${SUPPORTED_CONFIG_FILE_FORMATS.join(
+        "|"
+      )}) present in ${process.cwd()}`
+    );
+  }
+  return readRcByPath(join4(process.cwd(), `${CONFIG_FILE_NAME}.${ext}`));
 }
 export {
-  ConfigPathError,
+  ConfigPathError2 as ConfigPathError,
   PersistDirError,
   PersistError,
   PluginOutputMissingAuditError,
+  autoloadRc,
   collect,
   collectAndPersistReports,
   executePlugin,
   executePlugins,
   persistReport,
   readCodePushupConfig,
+  readRcByPath,
   upload
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/core",
-  "version": "0.10.6",
+  "version": "0.11.0",
   "license": "MIT",
   "dependencies": {
     "@code-pushup/models": "*",

package/src/index.d.ts

@@ -1,7 +1,8 @@
+export { readCodePushupConfig } from './lib/implementation/read-code-pushup-config';
 export { persistReport, PersistError, PersistDirError, } from './lib/implementation/persist';
 export { executePlugin, executePlugins, PluginOutputMissingAuditError, } from './lib/implementation/execute-plugin';
 export { collect, CollectOptions } from './lib/implementation/collect';
 export { upload, UploadOptions } from './lib/upload';
 export { GlobalOptions } from './lib/types';
 export { collectAndPersistReports, CollectAndPersistReportsOptions, } from './lib/collect-and-persist';
-export { readCodePushupConfig, ConfigPathError, } from './lib/implementation/read-code-pushup-config';
+export { autoloadRc, readRcByPath, ConfigPathError, } from './lib/implementation/read-rc-file';

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

@@ -0,0 +1,6 @@
+import { CoreConfig } from '@code-pushup/models';
+export declare class ConfigPathError extends Error {
+    constructor(configPath: string);
+}
+export declare function readRcByPath(filepath: string): Promise<CoreConfig>;
+export declare function autoloadRc(): Promise<CoreConfig>;