@code-pushup/cli 0.10.7 → 0.11.1

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";
@@ -1526,76 +1526,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, options2) {
-  const { outputDir, filename, format } = options2;
-  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({
@@ -1603,7 +1542,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,
@@ -1701,10 +1640,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(options2) {
   const { plugins, categories } = options2;
@@ -1721,6 +1656,132 @@ async function collect(options2) {
   };
 }
 
+// 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, options2) {
+  const { outputDir, filename, format } = options2;
+  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(options2) {
+  const { exec } = verboseUtils(options2.verbose);
+  const report = await collect(options2);
+  const persist = normalizePersistConfig(options2.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";
 
@@ -1810,14 +1871,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(options2, uploadFn = uploadToPortal) {
   const persist = normalizePersistConfig(options2.persist);
@@ -1842,43 +1895,43 @@ async function upload(options2, uploadFn = uploadToPortal) {
   return uploadFn({ apiKey, server, data, timeout });
 }
 
-// packages/core/src/lib/collect-and-persist.ts
-async function collectAndPersistReports(options2) {
-  const { exec } = verboseUtils(options2.verbose);
-  const report = await collect(options2);
-  const persist = normalizePersistConfig(options2.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 }));
-}
-
 // 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 {
@@ -1933,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";
@@ -2012,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,
@@ -2161,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.7",
+  "version": "0.11.1",
   "license": "MIT",
   "bin": {
     "code-pushup": "index.js"