@code-pushup/core 0.51.0 → 0.53.0

package/index.js

@@ -1494,25 +1494,30 @@ import {
 } from "build-md";
 import { posix as pathPosix } from "node:path";
 
-// packages/utils/src/lib/reports/ide-environment.ts
+// packages/utils/src/lib/reports/types.ts
+var SUPPORTED_ENVIRONMENTS = [
+  "vscode",
+  "github",
+  "gitlab",
+  "other"
+];
+
+// packages/utils/src/lib/reports/environment-type.ts
+var environmentChecks = {
+  vscode: () => process.env["TERM_PROGRAM"] === "vscode",
+  github: () => process.env["GITHUB_ACTIONS"] === "true",
+  gitlab: () => process.env["GITLAB_CI"] === "true",
+  other: () => true
+};
 function getEnvironmentType() {
-  if (isVSCode()) {
-    return "vscode";
-  }
-  if (isGitHub()) {
-    return "github";
-  }
-  return "other";
-}
-function isVSCode() {
-  return process.env["TERM_PROGRAM"] === "vscode";
-}
-function isGitHub() {
-  return process.env["GITHUB_ACTIONS"] === "true";
+  return SUPPORTED_ENVIRONMENTS.find((env) => environmentChecks[env]()) ?? "other";
 }
 function getGitHubBaseUrl() {
   return `${process.env["GITHUB_SERVER_URL"]}/${process.env["GITHUB_REPOSITORY"]}/blob/${process.env["GITHUB_SHA"]}`;
 }
+function getGitLabBaseUrl() {
+  return `${process.env["CI_SERVER_URL"]}/${process.env["CI_PROJECT_PATH"]}/-/blob/${process.env["CI_COMMIT_SHA"]}`;
+}
 
 // packages/utils/src/lib/reports/formatting.ts
 function tableSection(tableData, options) {
@@ -1578,6 +1583,15 @@ function formatGitHubLink(file, position) {
   const lineRange = end && start !== end ? `${start}-${end}` : start;
   return `${baseUrl}/${file}#${lineRange}`;
 }
+function formatGitLabLink(file, position) {
+  const baseUrl = getGitLabBaseUrl();
+  if (!position) {
+    return `${baseUrl}/${file}`;
+  }
+  const { startLine, endLine } = position;
+  const lineRange = endLine && startLine !== endLine ? `${startLine}-${endLine}` : startLine;
+  return `${baseUrl}/${file}#L${lineRange}`;
+}
 function formatFileLink(file, position, outputDir) {
   const relativePath = pathPosix.relative(outputDir, file);
   const env = getEnvironmentType();
@@ -1586,6 +1600,8 @@ function formatFileLink(file, position, outputDir) {
       return position ? `${relativePath}#L${position.startLine}` : relativePath;
     case "github":
       return formatGitHubLink(file, position);
+    case "gitlab":
+      return formatGitLabLink(file, position);
     default:
       return relativePath;
   }
@@ -2231,11 +2247,11 @@ import { bold as bold4, cyan, cyanBright, green as green2, red } from "ansis";
 function log(msg = "") {
   ui().logger.log(msg);
 }
-function logStdoutSummary(report) {
+function logStdoutSummary(report, verbose = false) {
   const printCategories = report.categories.length > 0;
   log(reportToHeaderSection(report));
   log();
-  logPlugins(report);
+  logPlugins(report.plugins, verbose);
   if (printCategories) {
     logCategories(report);
   }
@@ -2246,36 +2262,49 @@ function reportToHeaderSection(report) {
   const { packageName, version: version2 } = report;
   return `${bold4(REPORT_HEADLINE_TEXT)} - ${packageName}@${version2}`;
 }
-function logPlugins(report) {
-  const { plugins } = report;
+function logPlugins(plugins, verbose) {
   plugins.forEach((plugin) => {
     const { title, audits } = plugin;
+    const filteredAudits = verbose ? audits : audits.filter(({ score }) => score !== 1);
+    const diff = audits.length - filteredAudits.length;
+    logAudits(title, filteredAudits);
+    if (diff > 0) {
+      const notice = filteredAudits.length === 0 ? `... All ${diff} audits have perfect scores ...` : `... ${diff} audits with perfect scores omitted for brevity ...`;
+      logRow(1, notice);
+    }
     log();
-    log(bold4.magentaBright(`${title} audits`));
-    log();
-    audits.forEach((audit) => {
-      ui().row([
-        {
-          text: applyScoreColor({ score: audit.score, text: "\u25CF" }),
-          width: 2,
-          padding: [0, 1, 0, 0]
-        },
-        {
-          text: audit.title,
-          // eslint-disable-next-line no-magic-numbers
-          padding: [0, 3, 0, 0]
-        },
-        {
-          text: cyanBright(audit.displayValue || `${audit.value}`),
-          // eslint-disable-next-line no-magic-numbers
-          width: 20,
-          padding: [0, 0, 0, 0]
-        }
-      ]);
-    });
-    log();
   });
 }
+function logAudits(pluginTitle, audits) {
+  log();
+  log(bold4.magentaBright(`${pluginTitle} audits`));
+  log();
+  audits.forEach(({ score, title, displayValue, value }) => {
+    logRow(score, title, displayValue || `${value}`);
+  });
+}
+function logRow(score, title, value) {
+  ui().row([
+    {
+      text: applyScoreColor({ score, text: "\u25CF" }),
+      width: 2,
+      padding: [0, 1, 0, 0]
+    },
+    {
+      text: title,
+      // eslint-disable-next-line no-magic-numbers
+      padding: [0, 3, 0, 0]
+    },
+    ...value ? [
+      {
+        text: cyanBright(value),
+        // eslint-disable-next-line no-magic-numbers
+        width: 20,
+        padding: [0, 0, 0, 0]
+      }
+    ] : []
+  ]);
+}
 function logCategories({ categories, plugins }) {
   const hAlign = (idx) => idx === 0 ? "left" : "right";
   const rows = categories.map(({ title, score, refs, isBinary }) => [
@@ -2421,7 +2450,7 @@ var verboseUtils = (verbose = false) => ({
 
 // packages/core/package.json
 var name = "@code-pushup/core";
-var version = "0.51.0";
+var version = "0.53.0";
 
 // packages/core/src/lib/implementation/execute-plugin.ts
 import { bold as bold5 } from "ansis";
@@ -2616,10 +2645,8 @@ var PersistError = class extends Error {
     super(`fileName: ${reportPath} could not be saved.`);
   }
 };
-async function persistReport(report, options) {
+async function persistReport(report, sortedScoredReport, options) {
   const { outputDir, filename, format } = options;
-  const sortedScoredReport = sortReport(scoreReport(report));
-  logStdoutSummary(sortedScoredReport);
   const results = format.map((reportType) => {
     switch (reportType) {
       case "json":
@@ -2665,7 +2692,13 @@ function logPersistedResults(persistResults) {
 async function collectAndPersistReports(options) {
   const { exec } = verboseUtils(options.verbose);
   const report = await collect(options);
-  const persistResults = await persistReport(report, options.persist);
+  const sortedScoredReport = sortReport(scoreReport(report));
+  const persistResults = await persistReport(
+    report,
+    sortedScoredReport,
+    options.persist
+  );
+  logStdoutSummary(sortedScoredReport, options.verbose);
   exec(() => {
     logPersistedResults(persistResults);
   });
@@ -2677,10 +2710,6 @@ async function collectAndPersistReports(options) {
 // packages/core/src/lib/compare.ts
 import { writeFile as writeFile2 } from "node:fs/promises";
 import { join as join5 } from "node:path";
-import {
-  PortalOperationError,
-  getPortalComparisonLink
-} from "@code-pushup/portal-client";
 
 // packages/core/src/lib/implementation/compare-scorables.ts
 function compareCategories(reports) {
@@ -2816,6 +2845,18 @@ function selectMeta(meta) {
   };
 }
 
+// packages/core/src/lib/load-portal-client.ts
+async function loadPortalClient() {
+  try {
+    return await import("@code-pushup/portal-client");
+  } catch {
+    ui().logger.error(
+      "Optional peer dependency @code-pushup/portal-client is not available. Make sure it is installed to enable upload functionality."
+    );
+    return null;
+  }
+}
+
 // packages/core/src/lib/compare.ts
 async function compareReportFiles(inputPaths, persistConfig, uploadConfig, label) {
   const { outputDir, filename, format } = persistConfig;
@@ -2880,6 +2921,11 @@ function reportsDiffToFileContent(reportsDiff, format) {
 }
 async function fetchPortalComparisonLink(uploadConfig, commits) {
   const { server, apiKey, organization, project } = uploadConfig;
+  const portalClient = await loadPortalClient();
+  if (!portalClient) {
+    return;
+  }
+  const { PortalOperationError, getPortalComparisonLink } = portalClient;
   try {
     return await getPortalComparisonLink({
       server,
@@ -2902,18 +2948,7 @@ async function fetchPortalComparisonLink(uploadConfig, commits) {
   }
 }
 
-// packages/core/src/lib/upload.ts
-import {
-  uploadToPortal
-} from "@code-pushup/portal-client";
-
 // packages/core/src/lib/implementation/report-to-gql.ts
-import {
-  CategoryConfigRefType as PortalCategoryRefType,
-  IssueSeverity as PortalIssueSeverity,
-  IssueSourceType as PortalIssueSourceType,
-  TableAlignment as PortalTableAlignment
-} from "@code-pushup/portal-client";
 function reportToGQL(report) {
   return {
     packageName: report.packageName,
@@ -2980,7 +3015,7 @@ function issueToGQL(issue) {
     message: issue.message,
     severity: issueSeverityToGQL(issue.severity),
     ...issue.source?.file && {
-      sourceType: PortalIssueSourceType.SourceCode,
+      sourceType: safeEnum("SourceCode"),
       sourceFilePath: issue.source.file,
       sourceStartLine: issue.source.position?.startLine,
       sourceStartColumn: issue.source.position?.startColumn,
@@ -3026,37 +3061,45 @@ function categoryToGQL(category) {
 function categoryRefTypeToGQL(type) {
   switch (type) {
     case "audit":
-      return PortalCategoryRefType.Audit;
+      return safeEnum("Audit");
     case "group":
-      return PortalCategoryRefType.Group;
+      return safeEnum("Group");
   }
 }
 function issueSeverityToGQL(severity) {
   switch (severity) {
     case "info":
-      return PortalIssueSeverity.Info;
+      return safeEnum("Info");
     case "error":
-      return PortalIssueSeverity.Error;
+      return safeEnum("Error");
     case "warning":
-      return PortalIssueSeverity.Warning;
+      return safeEnum("Warning");
   }
 }
 function tableAlignmentToGQL(alignment) {
   switch (alignment) {
     case "left":
-      return PortalTableAlignment.Left;
+      return safeEnum("Left");
     case "center":
-      return PortalTableAlignment.Center;
+      return safeEnum("Center");
     case "right":
-      return PortalTableAlignment.Right;
+      return safeEnum("Right");
   }
 }
+function safeEnum(value) {
+  return value;
+}
 
 // packages/core/src/lib/upload.ts
-async function upload(options, uploadFn = uploadToPortal) {
+async function upload(options) {
   if (options.upload == null) {
     throw new Error("Upload configuration is not set.");
   }
+  const portalClient = await loadPortalClient();
+  if (!portalClient) {
+    return;
+  }
+  const { uploadToPortal } = portalClient;
   const { apiKey, server, organization, project, timeout } = options.upload;
   const report = await loadReport({
     ...options.persist,
@@ -3071,7 +3114,7 @@ async function upload(options, uploadFn = uploadToPortal) {
     commit: report.commit.hash,
     ...reportToGQL(report)
   };
-  return uploadFn({ apiKey, server, data, timeout });
+  return uploadToPortal({ apiKey, server, data, timeout });
 }
 
 // packages/core/src/lib/history.ts

package/package.json

@@ -1,14 +1,21 @@
 {
   "name": "@code-pushup/core",
-  "version": "0.51.0",
+  "version": "0.53.0",
   "license": "MIT",
   "description": "Core business logic for the used by the Code PushUp CLI",
   "dependencies": {
-    "@code-pushup/models": "0.51.0",
-    "@code-pushup/utils": "0.51.0",
-    "@code-pushup/portal-client": "^0.9.0",
+    "@code-pushup/models": "0.53.0",
+    "@code-pushup/utils": "0.53.0",
     "ansis": "^3.3.0"
   },
+  "peerDependencies": {
+    "@code-pushup/portal-client": "^0.9.0"
+  },
+  "peerDependenciesMeta": {
+    "@code-pushup/portal-client": {
+      "optional": true
+    }
+  },
   "homepage": "https://github.com/code-pushup/cli/tree/main/packages/core#readme",
   "bugs": {
     "url": "https://github.com/code-pushup/cli/issues"
@@ -18,6 +25,9 @@
     "url": "git+https://github.com/code-pushup/cli.git",
     "directory": "packages/core"
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "type": "module",
   "main": "./index.js",
   "types": "./src/index.d.ts"

package/src/lib/implementation/persist.d.ts

@@ -1,10 +1,10 @@
 import type { PersistConfig, Report } from '@code-pushup/models';
-import { type MultipleFileResults } from '@code-pushup/utils';
+import { type MultipleFileResults, type ScoredReport } from '@code-pushup/utils';
 export declare class PersistDirError extends Error {
     constructor(outputDir: string);
 }
 export declare class PersistError extends Error {
     constructor(reportPath: string);
 }
-export declare function persistReport(report: Report, options: Required<PersistConfig>): Promise<MultipleFileResults>;
+export declare function persistReport(report: Report, sortedScoredReport: ScoredReport, options: Required<PersistConfig>): Promise<MultipleFileResults>;
 export declare function logPersistedResults(persistResults: MultipleFileResults): void;

package/src/lib/implementation/report-to-gql.d.ts

@@ -1,4 +1,4 @@
-import { type AuditReportIssue as PortalIssue, type AuditReportTable as PortalTable, type SaveReportMutationVariables } from '@code-pushup/portal-client';
+import type { AuditReportIssue as PortalIssue, AuditReportTable as PortalTable, SaveReportMutationVariables } from '@code-pushup/portal-client';
 import type { Issue, Report, Table } from '@code-pushup/models';
 export declare function reportToGQL(report: Report): Omit<SaveReportMutationVariables, 'organization' | 'project' | 'commit'>;
 export declare function issueToGQL(issue: Issue): PortalIssue;

package/src/lib/load-portal-client.d.ts

@@ -0,0 +1 @@
+export declare function loadPortalClient(): Promise<typeof import('@code-pushup/portal-client') | null>;

package/src/lib/upload.d.ts

@@ -1,4 +1,3 @@
-import { uploadToPortal } from '@code-pushup/portal-client';
 import type { PersistConfig, UploadConfig } from '@code-pushup/models';
 import type { GlobalOptions } from './types';
 export type UploadOptions = {
@@ -11,4 +10,4 @@ export type UploadOptions = {
  * @param options
  * @param uploadFn
  */
-export declare function upload(options: UploadOptions, uploadFn?: typeof uploadToPortal): Promise<import("@code-pushup/portal-client").ReportFragment>;
+export declare function upload(options: UploadOptions): Promise<import("@code-pushup/portal-client").ReportFragment | undefined>;