@code-pushup/cli 0.10.6 → 0.11.0

package/README.md

@@ -40,10 +40,6 @@ _If you're looking for programmatic usage, then refer to the underlying [@code-p
 
    ```js
    export default {
-     persist: {
-       outputDir: '.code-pushup',
-       format: ['json', 'md'],
-     },
      plugins: [
        // ...
      ],
@@ -154,7 +150,10 @@ Each example is fully tested to demonstrate best practices for plugin testing as
 | ---------------- | --------- | ----------------------- | ---------------------------------------------------------------------- |
 | **`--progress`** | `boolean` | `true`                  | Show progress bar in stdout.                                           |
 | **`--verbose`**  | `boolean` | `false`                 | When true creates more verbose output. This is helpful when debugging. |
-| **`--config`**   | `string`  | `code-pushup.config.js` | Path to the config file, e.g. code-pushup.config.js                    |
+| **`--config`**   | `string`  | `code-pushup.config.ts` | Path to the config file, e.g. code-pushup.config.(ts\|mjs\|js)         |
+
+> [!NOTE]  
+> By default, the CLI loads `code-pushup.config.(ts|mjs|js)` if no config path is provided with `--config`.
 
 ### Common Command Options
 

package/index.js

@@ -6,16 +6,6 @@ import { hideBin } from "yargs/helpers";
 // packages/cli/src/lib/autorun/autorun-command.ts
 import chalk5 from "chalk";
 
-// 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";
 
@@ -502,6 +492,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);
@@ -564,6 +558,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";
@@ -1372,24 +1372,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) => {
@@ -1439,6 +1421,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) {
@@ -1515,6 +1527,8 @@ var verboseUtils = (verbose) => ({
 });
 
 // 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.`);
@@ -1691,7 +1705,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(options2) {
@@ -1844,29 +1858,80 @@ async function collectAndPersistReports(options2) {
   });
 }
 
-// packages/core/src/lib/implementation/read-code-pushup-config.ts
+// 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 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);
   }
-  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}`));
 }
 
 // packages/cli/src/lib/constants.ts
 var CLI_NAME = "Code PushUp CLI";
 var CLI_SCRIPT_NAME = "code-pushup";
 
+// packages/cli/src/lib/implementation/global.utils.ts
+function filterKebabCaseKeys(obj) {
+  return Object.entries(obj).filter(([key]) => !key.includes("-")).reduce(
+    (acc, [key, value]) => typeof value === "string" || typeof value === "object" && Array.isArray(obj[key]) ? { ...acc, [key]: value } : typeof value === "object" && !Array.isArray(value) && value != null ? {
+      ...acc,
+      [key]: filterKebabCaseKeys(value)
+    } : { ...acc, [key]: value },
+    {}
+  );
+}
+function logErrorBeforeThrow(fn) {
+  return async (...args) => {
+    try {
+      return await fn(...args);
+    } catch (error) {
+      console.error(error);
+      await new Promise((resolve) => process.stdout.write("", resolve));
+      throw error;
+    }
+  };
+}
+function coerceArray(param = []) {
+  return [
+    ...new Set(toArray(param).flatMap((f) => f.split(",")) || [])
+  ];
+}
+
 // packages/cli/src/lib/implementation/only-plugins.options.ts
 var onlyPluginsOption = {
   describe: "List of plugins to run. If not set all plugins are run.",
   type: "array",
   default: [],
-  coerce: (arg) => arg.flatMap((v) => v.split(","))
+  coerce: coerceArray
 };
 function yargsOnlyPluginsOptionsDefinition() {
   return {
@@ -1921,28 +1986,6 @@ function yargsCollectCommandObject() {
   };
 }
 
-// packages/cli/src/lib/implementation/global.utils.ts
-function filterKebabCaseKeys(obj) {
-  return Object.entries(obj).filter(([key]) => !key.includes("-")).reduce(
-    (acc, [key, value]) => typeof value === "string" || typeof value === "object" && Array.isArray(obj[key]) ? { ...acc, [key]: value } : typeof value === "object" && !Array.isArray(value) && value != null ? {
-      ...acc,
-      [key]: filterKebabCaseKeys(value)
-    } : { ...acc, [key]: value },
-    {}
-  );
-}
-function logErrorBeforeThrow(fn) {
-  return async (...args) => {
-    try {
-      return await fn(...args);
-    } catch (error) {
-      console.error(error);
-      await new Promise((resolve) => process.stdout.write("", resolve));
-      throw error;
-    }
-  };
-}
-
 // packages/cli/src/lib/print-config/print-config-command.ts
 function yargsConfigCommandObject() {
   const command = "print-config";
@@ -2000,12 +2043,12 @@ async function coreConfigMiddleware(processArgs) {
     upload: cliUpload,
     ...remainingCliOptions
   } = args;
-  const rcOptions = await readCodePushupConfig(config);
+  const importedRc = config ? await readRcByPath(config) : await autoloadRc();
   const {
     persist: rcPersist,
     upload: rcUpload,
     ...remainingRcConfig
-  } = rcOptions;
+  } = importedRc;
   const parsedProcessArgs = {
     config,
     ...remainingRcConfig,
@@ -2149,9 +2192,8 @@ function yargsGlobalOptionsDefinition() {
       default: false
     },
     config: {
-      describe: "Path the the config file, e.g. code-pushup.config.js",
-      type: "string",
-      default: "code-pushup.config.js"
+      describe: "Path the the config file, e.g. code-pushup.config.ts. By default it loads code-pushup.config.(ts|mjs|js).",
+      type: "string"
     }
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/cli",
-  "version": "0.10.6",
+  "version": "0.11.0",
   "license": "MIT",
   "bin": {
     "code-pushup": "index.js"