@code-pushup/utils 0.25.6 → 0.26.0

package/index.js

@@ -312,23 +312,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')"
@@ -345,7 +364,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),
@@ -373,14 +392,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()
   },
@@ -388,8 +407,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(
@@ -400,13 +419,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
 });
@@ -432,22 +451,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 */
@@ -470,7 +489,7 @@ function refineCoreConfig(schema) {
 }
 
 // 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({
@@ -478,9 +497,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 ?? []),
@@ -514,10 +533,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" }
   )
@@ -1115,9 +1135,12 @@ function toOrdinal(value) {
 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");
@@ -1131,18 +1154,6 @@ async function toGitPath(path, git = simpleGit()) {
   const gitRoot = await getGitRoot(git);
   return formatGitPath(path, gitRoot);
 }
-function validateCommitData(commitData, options = {}) {
-  if (!commitData) {
-    const msg = "no commit data available";
-    if (options.throwError) {
-      throw new Error(msg);
-    } else {
-      console.warn(msg);
-      return false;
-    }
-  }
-  return true;
-}
 
 // packages/utils/src/lib/group-by-status.ts
 function groupByStatus(results) {
@@ -1290,7 +1301,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
@@ -1299,7 +1310,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")}`
   );
 }
@@ -1423,10 +1434,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, plugins, categories } = report;
-  const commitInfo = commitData ? `${commitData.message} (${commitData.hash.slice(0, 7)})` : "N/A";
+  const { duration, version, commit, plugins, categories } = report;
+  const commitInfo = commit ? `${commit.message} (${commit.hash.slice(0, 7)})` : "N/A";
   const reportMetaTable = [
     reportMetaTableHeaders,
     [
@@ -1766,6 +1777,5 @@ export {
   truncateIssueMessage,
   truncateText,
   truncateTitle,
-  validateCommitData,
   verboseUtils
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.25.6",
+  "version": "0.26.0",
   "dependencies": {
     "@code-pushup/models": "*",
     "bundle-require": "^4.0.1",

package/src/index.d.ts

@@ -3,7 +3,7 @@ export { ProcessConfig, ProcessError, ProcessObserver, ProcessResult, executePro
 export { CrawlFileSystemOptions, FileResult, MultipleFileResults, crawlFileSystem, directoryExists, ensureDirectoryExists, fileExists, findLineNumberInText, importEsmModule, logMultipleFileResults, pluginWorkDir, readJsonFile, readTextFile, removeDirectoryIfExists, } from './lib/file-system';
 export { filterItemRefsBy } from './lib/filter';
 export { formatBytes, formatDuration, pluralize, pluralizeToken, slugify, truncateDescription, truncateIssueMessage, truncateText, truncateTitle, } from './lib/formatting';
-export { formatGitPath, getGitRoot, getLatestCommit, toGitPath, validateCommitData, } from './lib/git';
+export { formatGitPath, getGitRoot, getLatestCommit, toGitPath, } from './lib/git';
 export { groupByStatus } from './lib/group-by-status';
 export { isPromiseFulfilledResult, isPromiseRejectedResult, } from './lib/guards';
 export { logMultipleResults } from './lib/log-results';

package/src/lib/git.d.ts

@@ -1,21 +1,8 @@
-export type CommitData = {
-    hash: string;
-    message: string;
-    author: string;
-    date: string;
-};
-export declare function getLatestCommit(git?: import("simple-git").SimpleGit): Promise<({
-    hash: string;
-    message: string;
-    author: string;
-    date: string;
-} & import("simple-git").ListLogLine) | null>;
+import { Commit } from '@code-pushup/models';
+export declare function getLatestCommit(git?: import("simple-git").SimpleGit): Promise<Commit | null>;
 export declare function getGitRoot(git?: import("simple-git").SimpleGit): Promise<string>;
 export declare function formatGitPath(path: string, gitRoot: string): string;
 export declare function toGitPath(path: string, git?: import("simple-git").SimpleGit): Promise<string>;
-export declare function validateCommitData(commitData: CommitData | null, options?: {
-    throwError?: true;
-}): commitData is CommitData;
 export declare function guardAgainstLocalChanges(git?: import("simple-git").SimpleGit): Promise<void>;
 export declare function getCurrentBranchOrTag(git?: import("simple-git").SimpleGit): Promise<string>;
 export declare function safeCheckout(branchOrHash: string, options?: {

package/src/lib/reports/generate-md-report.d.ts

@@ -1,3 +1,2 @@
-import { CommitData } from '../git';
 import { ScoredReport } from './types';
-export declare function generateMdReport(report: ScoredReport, commitData: CommitData | null): string;
+export declare function generateMdReport(report: ScoredReport): string;