@code-pushup/cli 0.25.6 → 0.26.0

package/index.js

@@ -320,23 +320,42 @@ function getDuplicateSlugCategories(categories) {
   return hasDuplicateStrings(categories.map(({ slug }) => slug));
 }
 
+// packages/models/src/lib/commit.ts
+import { z as z6 } from "zod";
+var commitSchema = z6.object(
+  {
+    hash: z6.string({ description: "Commit SHA (full)" }).regex(
+      /^[\da-f]{40}$/,
+      "Commit SHA should be a 40-character hexadecimal string"
+    ),
+    message: z6.string({ description: "Commit message" }),
+    date: z6.coerce.date({
+      description: "Date and time when commit was authored"
+    }),
+    author: z6.string({
+      description: "Commit author name"
+    }).trim()
+  },
+  { description: "Git commit" }
+);
+
 // packages/models/src/lib/core-config.ts
-import { z as z11 } from "zod";
+import { z as z12 } from "zod";
 
 // packages/models/src/lib/persist-config.ts
-import { z as z6 } from "zod";
-var formatSchema = z6.enum(["json", "md"]);
-var persistConfigSchema = z6.object({
+import { z as z7 } from "zod";
+var formatSchema = z7.enum(["json", "md"]);
+var persistConfigSchema = z7.object({
   outputDir: filePathSchema.describe("Artifacts folder").optional(),
   filename: fileNameSchema.describe("Artifacts file name (without extension)").optional(),
-  format: z6.array(formatSchema).optional()
+  format: z7.array(formatSchema).optional()
 });
 
 // packages/models/src/lib/plugin-config.ts
-import { z as z9 } from "zod";
+import { z as z10 } from "zod";
 
 // packages/models/src/lib/group.ts
-import { z as z7 } from "zod";
+import { z as z8 } from "zod";
 var groupRefSchema = weightedRefSchema(
   "Weighted reference to a group",
   "Reference slug to a group within this plugin (e.g. 'max-lines')"
@@ -353,7 +372,7 @@ var groupSchema = scorableSchema(
   getDuplicateRefsInGroups,
   duplicateRefsInGroupsErrorMsg
 ).merge(groupMetaSchema);
-var groupsSchema = z7.array(groupSchema, {
+var groupsSchema = z8.array(groupSchema, {
   description: "List of groups"
 }).optional().refine(
   (groups) => !getDuplicateSlugsInGroups(groups),
@@ -381,14 +400,14 @@ function getDuplicateSlugsInGroups(groups) {
 }
 
 // packages/models/src/lib/runner-config.ts
-import { z as z8 } from "zod";
-var outputTransformSchema = z8.function().args(z8.unknown()).returns(z8.union([auditOutputsSchema, z8.promise(auditOutputsSchema)]));
-var runnerConfigSchema = z8.object(
+import { z as z9 } from "zod";
+var outputTransformSchema = z9.function().args(z9.unknown()).returns(z9.union([auditOutputsSchema, z9.promise(auditOutputsSchema)]));
+var runnerConfigSchema = z9.object(
   {
-    command: z8.string({
+    command: z9.string({
       description: "Shell command to execute"
     }),
-    args: z8.array(z8.string({ description: "Command arguments" })).optional(),
+    args: z9.array(z9.string({ description: "Command arguments" })).optional(),
     outputFile: filePathSchema.describe("Output path"),
     outputTransform: outputTransformSchema.optional()
   },
@@ -396,8 +415,8 @@ var runnerConfigSchema = z8.object(
     description: "How to execute runner"
   }
 );
-var onProgressSchema = z8.function().args(z8.unknown()).returns(z8.void());
-var runnerFunctionSchema = z8.function().args(onProgressSchema.optional()).returns(z8.union([auditOutputsSchema, z8.promise(auditOutputsSchema)]));
+var onProgressSchema = z9.function().args(z9.unknown()).returns(z9.void());
+var runnerFunctionSchema = z9.function().args(onProgressSchema.optional()).returns(z9.union([auditOutputsSchema, z9.promise(auditOutputsSchema)]));
 
 // packages/models/src/lib/plugin-config.ts
 var pluginMetaSchema = packageVersionSchema().merge(
@@ -408,13 +427,13 @@ var pluginMetaSchema = packageVersionSchema().merge(
     description: "Plugin metadata"
   })
 ).merge(
-  z9.object({
+  z10.object({
     slug: slugSchema.describe("Unique plugin slug within core config"),
     icon: materialIconSchema
   })
 );
-var pluginDataSchema = z9.object({
-  runner: z9.union([runnerConfigSchema, runnerFunctionSchema]),
+var pluginDataSchema = z10.object({
+  runner: z10.union([runnerConfigSchema, runnerFunctionSchema]),
   audits: pluginAuditsSchema,
   groups: groupsSchema
 });
@@ -440,22 +459,22 @@ function getMissingRefsFromGroups(pluginCfg) {
 }
 
 // packages/models/src/lib/upload-config.ts
-import { z as z10 } from "zod";
-var uploadConfigSchema = z10.object({
+import { z as z11 } from "zod";
+var uploadConfigSchema = z11.object({
   server: urlSchema.describe("URL of deployed portal API"),
-  apiKey: z10.string({
+  apiKey: z11.string({
     description: "API key with write access to portal (use `process.env` for security)"
   }),
   organization: slugSchema.describe(
     "Organization slug from Code PushUp portal"
   ),
   project: slugSchema.describe("Project slug from Code PushUp portal"),
-  timeout: z10.number({ description: "Request timeout in minutes (default is 5)" }).positive().int().optional()
+  timeout: z11.number({ description: "Request timeout in minutes (default is 5)" }).positive().int().optional()
 });
 
 // packages/models/src/lib/core-config.ts
-var unrefinedCoreConfigSchema = z11.object({
-  plugins: z11.array(pluginConfigSchema, {
+var unrefinedCoreConfigSchema = z12.object({
+  plugins: z12.array(pluginConfigSchema, {
     description: "List of plugins to be used (official, community-provided, or custom)"
   }).min(1),
   /** portal configuration for persisting results */
@@ -487,7 +506,7 @@ var PERSIST_FORMAT = ["json"];
 var PERSIST_FILENAME = "report";
 
 // packages/models/src/lib/report.ts
-import { z as z12 } from "zod";
+import { z as z13 } from "zod";
 var auditReportSchema = auditSchema.merge(auditOutputSchema);
 var pluginReportSchema = pluginMetaSchema.merge(
   executionMetaSchema({
@@ -495,9 +514,9 @@ var pluginReportSchema = pluginMetaSchema.merge(
     descriptionDuration: "Duration of the plugin run in ms"
   })
 ).merge(
-  z12.object({
-    audits: z12.array(auditReportSchema).min(1),
-    groups: z12.array(groupSchema).optional()
+  z13.object({
+    audits: z13.array(auditReportSchema).min(1),
+    groups: z13.array(groupSchema).optional()
   })
 ).refine(
   (pluginReport) => !getMissingRefsFromGroups2(pluginReport.audits, pluginReport.groups ?? []),
@@ -531,10 +550,11 @@ var reportSchema = packageVersionSchema({
     descriptionDuration: "Duration of the collect run in ms"
   })
 ).merge(
-  z12.object(
+  z13.object(
     {
-      categories: z12.array(categoryConfigSchema),
-      plugins: z12.array(pluginReportSchema).min(1)
+      categories: z13.array(categoryConfigSchema),
+      plugins: z13.array(pluginReportSchema).min(1),
+      commit: commitSchema.describe("Git commit for which report was collected").nullable()
     },
     { description: "Collect output data" }
   )
@@ -983,9 +1003,12 @@ function toUnixPath(path) {
 async function getLatestCommit(git = simpleGit()) {
   const log = await git.log({
     maxCount: 1,
-    format: { hash: "%H", message: "%s", author: "%an", date: "%ad" }
+    format: { hash: "%H", message: "%s", author: "%an", date: "%aI" }
   });
-  return log.latest;
+  if (!log.latest) {
+    return null;
+  }
+  return commitSchema.parse(log.latest);
 }
 function getGitRoot(git = simpleGit()) {
   return git.revparse("--show-toplevel");
@@ -995,18 +1018,6 @@ function formatGitPath(path, gitRoot) {
   const relativePath = relative(gitRoot, absolutePath);
   return toUnixPath(relativePath);
 }
-function validateCommitData(commitData, options2 = {}) {
-  if (!commitData) {
-    const msg = "no commit data available";
-    if (options2.throwError) {
-      throw new Error(msg);
-    } else {
-      console.warn(msg);
-      return false;
-    }
-  }
-  return true;
-}
 
 // packages/utils/src/lib/group-by-status.ts
 function groupByStatus(results) {
@@ -1154,7 +1165,7 @@ function tableHtml(data) {
 }
 
 // packages/utils/src/lib/reports/generate-md-report.ts
-function generateMdReport(report, commitData) {
+function generateMdReport(report) {
   const printCategories = report.categories.length > 0;
   return (
     // header section
@@ -1163,7 +1174,7 @@ function generateMdReport(report, commitData) {
     (printCategories ? reportToOverviewSection(report) + NEW_LINE + NEW_LINE : "") + // categories section
     (printCategories ? reportToCategoriesSection(report) + NEW_LINE + NEW_LINE : "") + // audits section
     reportToAuditsSection(report) + NEW_LINE + NEW_LINE + // about section
-    reportToAboutSection(report, commitData) + NEW_LINE + NEW_LINE + // footer section
+    reportToAboutSection(report) + NEW_LINE + NEW_LINE + // footer section
     `${FOOTER_PREFIX} ${link2(README_LINK, "Code PushUp")}`
   );
 }
@@ -1287,10 +1298,10 @@ function reportToDetailsSection(audit) {
   const detailsTable = `<h4>Issues</h4>${tableHtml(detailsTableData)}`;
   return details(detailsTitle, detailsTable);
 }
-function reportToAboutSection(report, commitData) {
+function reportToAboutSection(report) {
   const date = formatDate(/* @__PURE__ */ new Date());
-  const { duration, version: version2, plugins, categories } = report;
-  const commitInfo = commitData ? `${commitData.message} (${commitData.hash.slice(0, 7)})` : "N/A";
+  const { duration, version: version2, commit, plugins, categories } = report;
+  const commitInfo = commit ? `${commit.message} (${commit.hash.slice(0, 7)})` : "N/A";
   const reportMetaTable = [
     reportMetaTableHeaders,
     [
@@ -1575,7 +1586,7 @@ var verboseUtils = (verbose = false) => ({
 
 // packages/core/package.json
 var name = "@code-pushup/core";
-var version = "0.25.6";
+var version = "0.26.0";
 
 // packages/core/src/lib/implementation/execute-plugin.ts
 import chalk5 from "chalk";
@@ -1718,8 +1729,10 @@ async function collect(options2) {
   const { plugins, categories } = options2;
   const date = (/* @__PURE__ */ new Date()).toISOString();
   const start = performance.now();
+  const commit = await getLatestCommit();
   const pluginOutputs = await executePlugins(plugins, options2);
   return {
+    commit,
     packageName: name,
     version,
     date,
@@ -1746,24 +1759,20 @@ 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)
-          };
-      }
-    })
-  );
+  const results = format.map((reportType) => {
+    switch (reportType) {
+      case "json":
+        return {
+          format: "json",
+          content: JSON.stringify(report, null, 2)
+        };
+      case "md":
+        return {
+          format: "md",
+          content: generateMdReport(sortedScoredReport)
+        };
+    }
+  });
   if (!await directoryExists(outputDir)) {
     try {
       await mkdir2(outputDir, { recursive: true });
@@ -1960,14 +1969,13 @@ async function upload(options2, uploadFn = uploadToPortal) {
     ...options2.persist,
     format: "json"
   });
-  const commitData = await getLatestCommit();
-  if (!commitData) {
-    throw new Error("no commit data available");
+  if (!report.commit) {
+    throw new Error("Commit must be linked in order to upload report");
   }
   const data = {
     organization,
     project,
-    commit: commitData.hash,
+    commit: report.commit.hash,
     ...reportToGQL(report)
   };
   return uploadFn({ apiKey, server, data, timeout });
@@ -2088,10 +2096,7 @@ function yargsAutorunCommandObject() {
       }
       if (options2.upload) {
         const { url } = await upload(options2);
-        const commitData = await getLatestCommit();
-        if (validateCommitData(commitData, { throwError: true })) {
-          uploadSuccessfulLog(url);
-        }
+        uploadSuccessfulLog(url);
       } else {
         ui().logger.warning("Upload skipped because configuration is not set.");
         renderIntegratePortalHint();
@@ -2177,10 +2182,7 @@ function yargsUploadCommandObject() {
         throw new Error("Upload configuration not set");
       }
       const { url } = await upload(options2);
-      const commitData = await getLatestCommit();
-      if (validateCommitData(commitData, { throwError: true })) {
-        uploadSuccessfulLog(url);
-      }
+      uploadSuccessfulLog(url);
     }
   };
 }

package/package.json

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