@code-pushup/core 0.18.1 → 0.20.0

package/index.js

@@ -75,25 +75,15 @@ function executionMetaSchema(options = {
     duration: z.number({ description: options.descriptionDuration })
   });
 }
-function slugSchema(description = "Unique ID (human-readable, URL-safe)") {
-  return z.string({ description }).regex(slugRegex, {
-    message: "The slug has to follow the pattern [0-9a-z] followed by multiple optional groups of -[0-9a-z]. e.g. my-slug"
-  }).max(MAX_SLUG_LENGTH, {
-    message: `slug can be max ${MAX_SLUG_LENGTH} characters long`
-  });
-}
-function descriptionSchema(description = "Description (markdown)") {
-  return z.string({ description }).max(MAX_DESCRIPTION_LENGTH).optional();
-}
-function docsUrlSchema(description = "Documentation site") {
-  return urlSchema(description).optional().or(z.string().max(0));
-}
-function urlSchema(description) {
-  return z.string({ description }).url();
-}
-function titleSchema(description = "Descriptive name") {
-  return z.string({ description }).max(MAX_TITLE_LENGTH);
-}
+var slugSchema = z.string({ description: "Unique ID (human-readable, URL-safe)" }).regex(slugRegex, {
+  message: "The slug has to follow the pattern [0-9a-z] followed by multiple optional groups of -[0-9a-z]. e.g. my-slug"
+}).max(MAX_SLUG_LENGTH, {
+  message: `slug can be max ${MAX_SLUG_LENGTH} characters long`
+});
+var descriptionSchema = z.string({ description: "Description (markdown)" }).max(MAX_DESCRIPTION_LENGTH).optional();
+var urlSchema = z.string().url();
+var docsUrlSchema = urlSchema.optional().or(z.literal("")).describe("Documentation site");
+var titleSchema = z.string({ description: "Descriptive name" }).max(MAX_TITLE_LENGTH);
 function metaSchema(options) {
   const {
     descriptionDescription,
@@ -103,24 +93,19 @@ function metaSchema(options) {
   } = options ?? {};
   return z.object(
     {
-      title: titleSchema(titleDescription),
-      description: descriptionSchema(descriptionDescription),
-      docsUrl: docsUrlSchema(docsUrlDescription)
+      title: titleDescription ? titleSchema.describe(titleDescription) : titleSchema,
+      description: descriptionDescription ? descriptionSchema.describe(descriptionDescription) : descriptionSchema,
+      docsUrl: docsUrlDescription ? docsUrlSchema.describe(docsUrlDescription) : docsUrlSchema
     },
     { description }
   );
 }
-function filePathSchema(description) {
-  return z.string({ description }).trim().min(1, { message: "path is invalid" });
-}
-function fileNameSchema(description) {
-  return z.string({ description }).trim().regex(filenameRegex, {
-    message: `The filename has to be valid`
-  }).min(1, { message: "file name is invalid" });
-}
-function positiveIntSchema(description) {
-  return z.number({ description }).int().nonnegative();
-}
+var filePathSchema = z.string().trim().min(1, { message: "path is invalid" });
+var fileNameSchema = z.string().trim().regex(filenameRegex, {
+  message: `The filename has to be valid`
+}).min(1, { message: "file name is invalid" });
+var positiveIntSchema = z.number().int().positive();
+var nonnegativeIntSchema = z.number().int().nonnegative();
 function packageVersionSchema(options) {
   const { versionDescription = "NPM version of the package", required } = options ?? {};
   const packageSchema = z.string({ description: "NPM package name" });
@@ -133,14 +118,14 @@ function packageVersionSchema(options) {
     { description: "NPM package name and version of a published package" }
   );
 }
-function weightSchema(description = "Coefficient for the given score (use weight 0 if only for display)") {
-  return positiveIntSchema(description);
-}
+var weightSchema = nonnegativeIntSchema.describe(
+  "Coefficient for the given score (use weight 0 if only for display)"
+);
 function weightedRefSchema(description, slugDescription) {
   return z.object(
     {
-      slug: slugSchema(slugDescription),
-      weight: weightSchema("Weight used to calculate score")
+      slug: slugSchema.describe(slugDescription),
+      weight: weightSchema.describe("Weight used to calculate score")
     },
     { description }
   );
@@ -148,14 +133,14 @@ function weightedRefSchema(description, slugDescription) {
 function scorableSchema(description, refSchema, duplicateCheckFn, duplicateMessageFn) {
   return z.object(
     {
-      slug: slugSchema('Human-readable unique ID, e.g. "performance"'),
+      slug: slugSchema.describe('Human-readable unique ID, e.g. "performance"'),
       refs: z.array(refSchema).min(1).refine(
         (refs) => !duplicateCheckFn(refs),
         (refs) => ({
           message: duplicateMessageFn(refs)
         })
-      ).refine(hasWeightedRefsInCategories, () => ({
-        message: `In a category there has to be at least one ref with weight > 0`
+      ).refine(hasNonZeroWeightedRef, () => ({
+        message: "In a category there has to be at least one ref with weight > 0"
       }))
     },
     { description }
@@ -164,13 +149,13 @@ function scorableSchema(description, refSchema, duplicateCheckFn, duplicateMessa
 var materialIconSchema = z.enum(MATERIAL_ICONS, {
   description: "Icon from VSCode Material Icons extension"
 });
-function hasWeightedRefsInCategories(categoryRefs) {
-  return categoryRefs.reduce((acc, { weight }) => weight + acc, 0) !== 0;
+function hasNonZeroWeightedRef(refs) {
+  return refs.reduce((acc, { weight }) => weight + acc, 0) !== 0;
 }
 
 // packages/models/src/lib/audit.ts
 var auditSchema = z2.object({
-  slug: slugSchema("ID (unique within plugin)")
+  slug: slugSchema.describe("ID (unique within plugin)")
 }).merge(
   metaSchema({
     titleDescription: "Descriptive name",
@@ -197,17 +182,20 @@ function getDuplicateSlugsInAudits(audits) {
   return hasDuplicateStrings(audits.map(({ slug }) => slug));
 }
 
-// packages/models/src/lib/audit-issue.ts
+// packages/models/src/lib/audit-output.ts
+import { z as z4 } from "zod";
+
+// packages/models/src/lib/issue.ts
 import { z as z3 } from "zod";
 var sourceFileLocationSchema = z3.object(
   {
-    file: filePathSchema("Relative path to source file in Git repo"),
+    file: filePathSchema.describe("Relative path to source file in Git repo"),
     position: z3.object(
       {
-        startLine: positiveIntSchema("Start line"),
-        startColumn: positiveIntSchema("Start column").optional(),
-        endLine: positiveIntSchema("End line").optional(),
-        endColumn: positiveIntSchema("End column").optional()
+        startLine: positiveIntSchema.describe("Start line"),
+        startColumn: positiveIntSchema.describe("Start column").optional(),
+        endLine: positiveIntSchema.describe("End line").optional(),
+        endColumn: positiveIntSchema.describe("End column").optional()
       },
       { description: "Location in file" }
     ).optional()
@@ -227,21 +215,21 @@ var issueSchema = z3.object(
 );
 
 // packages/models/src/lib/audit-output.ts
-import { z as z4 } from "zod";
+var auditDetailsSchema = z4.object(
+  {
+    issues: z4.array(issueSchema, { description: "List of findings" })
+  },
+  { description: "Detailed information" }
+);
 var auditOutputSchema = z4.object(
   {
-    slug: slugSchema("Reference to audit"),
+    slug: slugSchema.describe("Reference to audit"),
     displayValue: z4.string({ description: "Formatted value (e.g. '0.9 s', '2.1 MB')" }).optional(),
-    value: positiveIntSchema("Raw numeric value"),
+    value: nonnegativeIntSchema.describe("Raw numeric value"),
     score: z4.number({
       description: "Value between 0 and 1"
     }).min(0).max(1),
-    details: z4.object(
-      {
-        issues: z4.array(issueSchema, { description: "List of findings" })
-      },
-      { description: "Detailed information" }
-    ).optional()
+    details: auditDetailsSchema.optional()
   },
   { description: "Audit information" }
 );
@@ -271,7 +259,7 @@ var categoryRefSchema = weightedRefSchema(
     type: z5.enum(["audit", "group"], {
       description: "Discriminant for reference kind, affects where `slug` is looked up"
     }),
-    plugin: slugSchema(
+    plugin: slugSchema.describe(
       "Plugin slug (plugin should contain referenced audit or group)"
     )
   })
@@ -331,10 +319,8 @@ import { z as z11 } from "zod";
 import { z as z6 } from "zod";
 var formatSchema = z6.enum(["json", "md"]);
 var persistConfigSchema = z6.object({
-  outputDir: filePathSchema("Artifacts folder").optional(),
-  filename: fileNameSchema(
-    "Artifacts file name (without extension)"
-  ).optional(),
+  outputDir: filePathSchema.describe("Artifacts folder").optional(),
+  filename: fileNameSchema.describe("Artifacts file name (without extension)").optional(),
   format: z6.array(formatSchema).optional()
 });
 
@@ -395,7 +381,7 @@ var runnerConfigSchema = z8.object(
       description: "Shell command to execute"
     }),
     args: z8.array(z8.string({ description: "Command arguments" })).optional(),
-    outputFile: filePathSchema("Output path"),
+    outputFile: filePathSchema.describe("Output path"),
     outputTransform: outputTransformSchema.optional()
   },
   {
@@ -415,7 +401,7 @@ var pluginMetaSchema = packageVersionSchema().merge(
   })
 ).merge(
   z9.object({
-    slug: slugSchema("Unique plugin slug within core config"),
+    slug: slugSchema.describe("Unique plugin slug within core config"),
     icon: materialIconSchema
   })
 );
@@ -448,12 +434,14 @@ function getMissingRefsFromGroups(pluginCfg) {
 // packages/models/src/lib/upload-config.ts
 import { z as z10 } from "zod";
 var uploadConfigSchema = z10.object({
-  server: urlSchema("URL of deployed portal API"),
+  server: urlSchema.describe("URL of deployed portal API"),
   apiKey: z10.string({
     description: "API key with write access to portal (use `process.env` for security)"
   }),
-  organization: slugSchema("Organization slug from Code PushUp portal"),
-  project: slugSchema("Project slug from Code PushUp portal"),
+  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()
 });
 
@@ -956,16 +944,32 @@ function executeProcess(cfg) {
   });
 }
 
+// packages/utils/src/lib/transform.ts
+function deepClone(obj) {
+  return obj == null || typeof obj !== "object" ? obj : structuredClone(obj);
+}
+function toUnixPath(path) {
+  return path.replace(/\\/g, "/");
+}
+
 // packages/utils/src/lib/git.ts
+import { isAbsolute, join as join2, relative } from "node:path";
 import { simpleGit } from "simple-git";
-var git = simpleGit();
-async function getLatestCommit() {
+async function getLatestCommit(git = simpleGit()) {
   const log = await git.log({
     maxCount: 1,
     format: { hash: "%H", message: "%s", author: "%an", date: "%ad" }
   });
   return log.latest;
 }
+function getGitRoot(git = simpleGit()) {
+  return git.revparse("--show-toplevel");
+}
+function formatGitPath(path, gitRoot) {
+  const absolutePath = isAbsolute(path) ? path : join2(process.cwd(), path);
+  const relativePath = relative(gitRoot, absolutePath);
+  return toUnixPath(relativePath);
+}
 function validateCommitData(commitData, options = {}) {
   const { throwError = false } = options;
   if (!commitData) {
@@ -988,18 +992,21 @@ function groupByStatus(results) {
   );
 }
 
-// packages/utils/src/lib/progress.ts
+// packages/utils/src/lib/logging.ts
 import chalk2 from "chalk";
+
+// packages/utils/src/lib/progress.ts
+import chalk3 from "chalk";
 import { MultiProgressBars } from "multi-progress-bars";
 var barStyles = {
-  active: (s) => chalk2.green(s),
-  done: (s) => chalk2.gray(s),
-  idle: (s) => chalk2.gray(s)
+  active: (s) => chalk3.green(s),
+  done: (s) => chalk3.gray(s),
+  idle: (s) => chalk3.gray(s)
 };
 var messageStyles = {
-  active: (s) => chalk2.black(s),
-  done: (s) => chalk2.green(chalk2.bold(s)),
-  idle: (s) => chalk2.gray(s)
+  active: (s) => chalk3.black(s),
+  done: (s) => chalk3.green(chalk3.bold(s)),
+  idle: (s) => chalk3.gray(s)
 };
 var mpb;
 function getSingletonProgressBars(options) {
@@ -1298,7 +1305,7 @@ function getAuditResult(audit, isHtml = false) {
 
 // packages/utils/src/lib/reports/generate-stdout-summary.ts
 import cliui from "@isaacs/cliui";
-import chalk3 from "chalk";
+import chalk4 from "chalk";
 import CliTable3 from "cli-table3";
 function addLine(line = "") {
   return line + NEW_LINE;
@@ -1309,7 +1316,7 @@ function generateStdoutSummary(report) {
 }
 function reportToHeaderSection2(report) {
   const { packageName, version: version2 } = report;
-  return `${chalk3.bold(reportHeadlineText)} - ${packageName}@${version2}`;
+  return `${chalk4.bold(reportHeadlineText)} - ${packageName}@${version2}`;
 }
 function reportToDetailSection(report) {
   const { plugins } = report;
@@ -1329,13 +1336,13 @@ function reportToDetailSection(report) {
           padding: [0, 3, 0, 0]
         },
         {
-          text: chalk3.cyanBright(audit.displayValue || `${audit.value}`),
+          text: chalk4.cyanBright(audit.displayValue || `${audit.value}`),
           width: 10,
           padding: [0, 0, 0, 0]
         }
       );
     });
-    return acc + addLine() + addLine(chalk3.magentaBright.bold(`${title} audits`)) + addLine() + addLine(ui.toString()) + addLine();
+    return acc + addLine() + addLine(chalk4.magentaBright.bold(`${title} audits`)) + addLine() + addLine(ui.toString()) + addLine();
   }, "");
 }
 function reportToOverviewSection2({
@@ -1358,11 +1365,11 @@ function reportToOverviewSection2({
       countCategoryAudits(refs, plugins)
     ])
   );
-  return addLine(chalk3.magentaBright.bold("Categories")) + addLine() + addLine(table.toString());
+  return addLine(chalk4.magentaBright.bold("Categories")) + addLine() + addLine(table.toString());
 }
 function withColor({ score, text }) {
   const formattedScore = text ?? formatReportScore(score);
-  const style2 = text ? chalk3 : chalk3.bold;
+  const style2 = text ? chalk4 : chalk4.bold;
   if (score >= SCORE_COLOR_RANGE.GREEN_MIN) {
     return style2.green(formattedScore);
   }
@@ -1372,11 +1379,6 @@ function withColor({ score, text }) {
   return style2.red(formattedScore);
 }
 
-// packages/utils/src/lib/transform.ts
-function deepClone(obj) {
-  return obj == null || typeof obj !== "object" ? obj : structuredClone(obj);
-}
-
 // packages/utils/src/lib/reports/scoring.ts
 var GroupRefInvalidError = class extends Error {
   constructor(auditSlug, pluginSlug) {
@@ -1537,18 +1539,48 @@ var verboseUtils = (verbose = false) => ({
   exec: getExecVerbose(verbose)
 });
 
-// packages/utils/src/lib/logging.ts
-import chalk4 from "chalk";
-
 // packages/core/package.json
 var name = "@code-pushup/core";
-var version = "0.18.1";
+var version = "0.20.0";
 
 // packages/core/src/lib/implementation/execute-plugin.ts
 import chalk5 from "chalk";
 
+// packages/core/src/lib/normalize.ts
+function normalizePersistConfig(cfg) {
+  return {
+    outputDir: PERSIST_OUTPUT_DIR,
+    filename: PERSIST_FILENAME,
+    format: PERSIST_FORMAT,
+    ...cfg
+  };
+}
+async function normalizeAuditOutputs(audits) {
+  const gitRoot = await getGitRoot();
+  return audits.map((audit) => {
+    if (audit.details?.issues == null || audit.details.issues.every((issue) => issue.source == null)) {
+      return audit;
+    }
+    return {
+      ...audit,
+      details: {
+        ...audit.details,
+        issues: audit.details.issues.map(
+          (issue) => issue.source == null ? issue : {
+            ...issue,
+            source: {
+              ...issue.source,
+              file: formatGitPath(issue.source.file, gitRoot)
+            }
+          }
+        )
+      }
+    };
+  });
+}
+
 // packages/core/src/lib/implementation/runner.ts
-import { join as join2 } from "node:path";
+import { join as join3 } from "node:path";
 async function executeRunnerConfig(cfg, onProgress) {
   const { args, command, outputFile, outputTransform } = cfg;
   const { duration, date } = await executeProcess({
@@ -1556,7 +1588,7 @@ async function executeRunnerConfig(cfg, onProgress) {
     args,
     observer: { onStdout: onProgress }
   });
-  const outputs = await readJsonFile(join2(process.cwd(), outputFile));
+  const outputs = await readJsonFile(join3(process.cwd(), outputFile));
   const audits = outputTransform ? await outputTransform(outputs) : outputs;
   return {
     duration,
@@ -1594,7 +1626,8 @@ async function executePlugin(pluginConfig, onProgress) {
   const { audits: unvalidatedAuditOutputs, ...executionMeta } = runnerResult;
   const auditOutputs = auditOutputsSchema.parse(unvalidatedAuditOutputs);
   auditOutputsCorrelateWithPluginOutput(auditOutputs, pluginConfigAudits);
-  const auditReports = auditOutputs.map(
+  const normalizedAuditOutputs = await normalizeAuditOutputs(auditOutputs);
+  const auditReports = normalizedAuditOutputs.map(
     (auditOutput) => ({
       ...auditOutput,
       ...pluginConfigAudits.find(
@@ -1672,7 +1705,7 @@ 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";
+import { join as join4 } from "node:path";
 var PersistDirError = class extends Error {
   constructor(outputDir) {
     super(`outPath: ${outputDir} is no directory.`);
@@ -1716,7 +1749,7 @@ async function persistReport(report, options) {
   return Promise.allSettled(
     results.map(
       (result) => persistResult(
-        join3(outputDir, `${filename}.${result.format}`),
+        join4(outputDir, `${filename}.${result.format}`),
         result.content
       )
     )
@@ -1732,14 +1765,6 @@ 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);
@@ -1755,7 +1780,7 @@ async function collectAndPersistReports(options) {
 }
 
 // packages/core/src/lib/implementation/read-rc-file.ts
-import { join as join4 } from "node:path";
+import { join as join5 } from "node:path";
 var ConfigPathError = class extends Error {
   constructor(configPath) {
     super(`Provided path '${configPath}' is not valid.`);
@@ -1788,7 +1813,7 @@ async function autoloadRc() {
       )}) present in ${process.cwd()}`
     );
   }
-  return readRcByPath(join4(process.cwd(), `${CONFIG_FILE_NAME}.${ext}`));
+  return readRcByPath(join5(process.cwd(), `${CONFIG_FILE_NAME}.${ext}`));
 }
 
 // packages/core/src/lib/upload.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/core",
-  "version": "0.18.1",
+  "version": "0.20.0",
   "license": "MIT",
   "dependencies": {
     "@code-pushup/models": "*",

package/src/lib/normalize.d.ts

@@ -1,2 +1,3 @@
-import { PersistConfig } from '@code-pushup/models';
-export declare const normalizePersistConfig: (cfg?: Partial<PersistConfig>) => Required<PersistConfig>;
+import { type AuditOutputs, PersistConfig } from '@code-pushup/models';
+export declare function normalizePersistConfig(cfg?: Partial<PersistConfig>): Required<PersistConfig>;
+export declare function normalizeAuditOutputs(audits: AuditOutputs): Promise<AuditOutputs>;