@code-pushup/core 0.10.7 → 0.11.1

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";
@@ -1518,76 +1518,15 @@ var verboseUtils = (verbose) => ({
   exec: getExecVerbose(verbose)
 });
 
-// packages/core/src/lib/implementation/persist.ts
-var PersistDirError = class extends Error {
-  constructor(outputDir) {
-    super(`outPath: ${outputDir} is no directory.`);
-  }
-};
-var PersistError = class extends Error {
-  constructor(reportPath) {
-    super(`fileName: ${reportPath} could not be saved.`);
-  }
-};
-async function persistReport(report, options) {
-  const { outputDir, filename, format } = options;
-  const sortedScoredReport = sortReport(scoreReport(report));
-  console.info(generateStdoutSummary(sortedScoredReport));
-  const results = await Promise.all(
-    format.map(async (reportType) => {
-      switch (reportType) {
-        case "json":
-          return {
-            format: "json",
-            content: JSON.stringify(report, null, 2)
-          };
-        case "md":
-          const commitData = await getLatestCommit();
-          validateCommitData(commitData);
-          return {
-            format: "md",
-            content: generateMdReport(sortedScoredReport, commitData)
-          };
-      }
-    })
-  );
-  if (!await directoryExists(outputDir)) {
-    try {
-      await mkdir2(outputDir, { recursive: true });
-    } catch (error) {
-      console.warn(error);
-      throw new PersistDirError(outputDir);
-    }
-  }
-  return Promise.allSettled(
-    results.map(
-      (result) => persistResult(
-        join2(outputDir, `${filename}.${result.format}`),
-        result.content
-      )
-    )
-  );
-}
-function validateCommitData(commitData) {
-  if (!commitData) {
-    console.warn("no commit data available");
-  }
-}
-async function persistResult(reportPath, content) {
-  return writeFile(reportPath, content).then(() => stat2(reportPath)).then((stats) => [reportPath, stats.size]).catch((error) => {
-    console.warn(error);
-    throw new PersistError(reportPath);
-  });
-}
-function logPersistedResults(persistResults) {
-  logMultipleFileResults(persistResults, "Generated reports");
-}
+// packages/core/package.json
+var name = "@code-pushup/core";
+var version = "0.11.1";
 
 // packages/core/src/lib/implementation/execute-plugin.ts
 import chalk4 from "chalk";
 
 // packages/core/src/lib/implementation/runner.ts
-import { join as join3 } from "node:path";
+import { join as join2 } from "node:path";
 async function executeRunnerConfig(cfg, onProgress) {
   const { args, command, outputFile, outputTransform } = cfg;
   const { duration, date } = await executeProcess({
@@ -1595,7 +1534,7 @@ async function executeRunnerConfig(cfg, onProgress) {
     args,
     observer: { onStdout: onProgress }
   });
-  const outputs = await readJsonFile(join3(process.cwd(), outputFile));
+  const outputs = await readJsonFile(join2(process.cwd(), outputFile));
   const audits = outputTransform ? await outputTransform(outputs) : outputs;
   return {
     duration,
@@ -1693,10 +1632,6 @@ function auditOutputsCorrelateWithPluginOutput(auditOutputs, pluginConfigAudits)
   });
 }
 
-// packages/core/package.json
-var name = "@code-pushup/core";
-var version = "0.10.7";
-
 // packages/core/src/lib/implementation/collect.ts
 async function collect(options) {
   const { plugins, categories } = options;
@@ -1713,6 +1648,132 @@ async function collect(options) {
   };
 }
 
+// packages/core/src/lib/implementation/persist.ts
+import { mkdir as mkdir2, stat as stat2, writeFile } from "node:fs/promises";
+import { join as join3 } from "node:path";
+var PersistDirError = class extends Error {
+  constructor(outputDir) {
+    super(`outPath: ${outputDir} is no directory.`);
+  }
+};
+var PersistError = class extends Error {
+  constructor(reportPath) {
+    super(`fileName: ${reportPath} could not be saved.`);
+  }
+};
+async function persistReport(report, options) {
+  const { outputDir, filename, format } = options;
+  const sortedScoredReport = sortReport(scoreReport(report));
+  console.info(generateStdoutSummary(sortedScoredReport));
+  const results = await Promise.all(
+    format.map(async (reportType) => {
+      switch (reportType) {
+        case "json":
+          return {
+            format: "json",
+            content: JSON.stringify(report, null, 2)
+          };
+        case "md":
+          const commitData = await getLatestCommit();
+          validateCommitData(commitData);
+          return {
+            format: "md",
+            content: generateMdReport(sortedScoredReport, commitData)
+          };
+      }
+    })
+  );
+  if (!await directoryExists(outputDir)) {
+    try {
+      await mkdir2(outputDir, { recursive: true });
+    } catch (error) {
+      console.warn(error);
+      throw new PersistDirError(outputDir);
+    }
+  }
+  return Promise.allSettled(
+    results.map(
+      (result) => persistResult(
+        join3(outputDir, `${filename}.${result.format}`),
+        result.content
+      )
+    )
+  );
+}
+function validateCommitData(commitData) {
+  if (!commitData) {
+    console.warn("no commit data available");
+  }
+}
+async function persistResult(reportPath, content) {
+  return writeFile(reportPath, content).then(() => stat2(reportPath)).then((stats) => [reportPath, stats.size]).catch((error) => {
+    console.warn(error);
+    throw new PersistError(reportPath);
+  });
+}
+function logPersistedResults(persistResults) {
+  logMultipleFileResults(persistResults, "Generated reports");
+}
+
+// packages/core/src/lib/normalize.ts
+var normalizePersistConfig = (cfg) => ({
+  outputDir: PERSIST_OUTPUT_DIR,
+  filename: PERSIST_FILENAME,
+  format: PERSIST_FORMAT,
+  ...cfg
+});
+
+// packages/core/src/lib/collect-and-persist.ts
+async function collectAndPersistReports(options) {
+  const { exec } = verboseUtils(options.verbose);
+  const report = await collect(options);
+  const persist = normalizePersistConfig(options.persist);
+  const persistResults = await persistReport(report, persist);
+  exec(() => {
+    logPersistedResults(persistResults);
+  });
+  report.plugins.forEach((plugin) => {
+    pluginReportSchema.parse(plugin);
+  });
+}
+
+// packages/core/src/lib/implementation/read-rc-file.ts
+import { join as join4 } from "node:path";
+var ConfigPathError = class extends Error {
+  constructor(configPath) {
+    super(`Provided path '${configPath}' is not valid.`);
+  }
+};
+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);
+  }
+  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}`));
+}
+
 // packages/core/src/lib/upload.ts
 import { uploadToPortal } from "@code-pushup/portal-client";
 
@@ -1802,14 +1863,6 @@ function transformSeverity(severity) {
   }
 }
 
-// packages/core/src/lib/normalize.ts
-var normalizePersistConfig = (cfg) => ({
-  outputDir: PERSIST_OUTPUT_DIR,
-  filename: PERSIST_FILENAME,
-  format: PERSIST_FORMAT,
-  ...cfg
-});
-
 // packages/core/src/lib/upload.ts
 async function upload(options, uploadFn = uploadToPortal) {
   const persist = normalizePersistConfig(options.persist);
@@ -1833,43 +1886,17 @@ async function upload(options, uploadFn = uploadToPortal) {
   };
   return uploadFn({ apiKey, server, data, timeout });
 }
-
-// packages/core/src/lib/collect-and-persist.ts
-async function collectAndPersistReports(options) {
-  const { exec } = verboseUtils(options.verbose);
-  const report = await collect(options);
-  const persist = normalizePersistConfig(options.persist);
-  const persistResults = await persistReport(report, persist);
-  exec(() => {
-    logPersistedResults(persistResults);
-  });
-  report.plugins.forEach((plugin) => {
-    pluginReportSchema.parse(plugin);
-  });
-}
-
-// 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 }));
-}
 export {
   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.7",
+  "version": "0.11.1",
   "license": "MIT",
   "dependencies": {
     "@code-pushup/models": "*",

package/src/index.d.ts

@@ -1,7 +1,7 @@
-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 { CollectAndPersistReportsOptions, collectAndPersistReports, } from './lib/collect-and-persist';
+export { CollectOptions, collect } from './lib/implementation/collect';
+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';
 export { GlobalOptions } from './lib/types';
-export { collectAndPersistReports, CollectAndPersistReportsOptions, } from './lib/collect-and-persist';
-export { readCodePushupConfig, ConfigPathError, } from './lib/implementation/read-code-pushup-config';
+export { UploadOptions, upload } from './lib/upload';

package/src/lib/implementation/{read-code-pushup-config.d.ts → read-rc-file.d.ts}

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