@code-pushup/utils 0.52.0 → 0.53.0

package/index.js

@@ -1924,25 +1924,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) {
@@ -2008,6 +2013,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();
@@ -2016,6 +2030,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;
   }

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.52.0",
+  "version": "0.53.0",
   "description": "Low-level utilities (helper functions, etc.) used by Code PushUp CLI",
   "dependencies": {
-    "@code-pushup/models": "0.52.0",
+    "@code-pushup/models": "0.53.0",
     "@isaacs/cliui": "^8.0.2",
     "@poppinss/cliui": "^6.4.0",
     "ansis": "^3.3.0",

package/src/lib/reports/environment-type.d.ts

@@ -0,0 +1,4 @@
+import { type EnvironmentType } from './types';
+export declare function getEnvironmentType(): EnvironmentType;
+export declare function getGitHubBaseUrl(): string;
+export declare function getGitLabBaseUrl(): string;

package/src/lib/reports/formatting.d.ts

@@ -16,4 +16,5 @@ export declare function metaDescription(audit: Pick<AuditReport, 'docsUrl' | 'de
 export declare function linkToLocalSourceForIde(source: SourceFileLocation, options?: Pick<MdReportOptions, 'outputDir'>): InlineText;
 export declare function formatSourceLine(position: SourceFileLocation['position']): string;
 export declare function formatGitHubLink(file: string, position: SourceFileLocation['position']): string;
+export declare function formatGitLabLink(file: string, position: SourceFileLocation['position']): string;
 export declare function formatFileLink(file: string, position: SourceFileLocation['position'], outputDir: string): string;

package/src/lib/reports/types.d.ts

@@ -21,4 +21,5 @@ export type SortableAuditReport = AuditReport & {
 };
 export type DiffOutcome = 'positive' | 'negative' | 'mixed' | 'unchanged';
 export type MdReportOptions = Pick<PersistConfig, 'outputDir'>;
-export type IdeEnvironment = 'vscode' | 'github' | 'other';
+export declare const SUPPORTED_ENVIRONMENTS: readonly ["vscode", "github", "gitlab", "other"];
+export type EnvironmentType = (typeof SUPPORTED_ENVIRONMENTS)[number];

package/src/lib/reports/ide-environment.d.ts

@@ -1,3 +0,0 @@
-import type { IdeEnvironment } from './types';
-export declare function getEnvironmentType(): IdeEnvironment;
-export declare function getGitHubBaseUrl(): string;