feat(utils): support GitLab report links

Author: hanna-skryl

packages/utils/src/lib/reports/environment-type.ts

@@ -0,0 +1,22 @@
+import { type EnvironmentType, SUPPORTED_ENVIRONMENTS } from './types';
+
+const environmentChecks: Record<EnvironmentType, () => boolean> = {
+  vscode: () => process.env['TERM_PROGRAM'] === 'vscode',
+  github: () => process.env['GITHUB_ACTIONS'] === 'true',
+  gitlab: () => process.env['GITLAB_CI'] === 'true',
+  other: () => true,
+};
+
+export function getEnvironmentType(): EnvironmentType {
+  return (
+    SUPPORTED_ENVIRONMENTS.find(env => environmentChecks[env]()) ?? 'other'
+  );
+}
+
+export function getGitHubBaseUrl(): string {
+  return `${process.env['GITHUB_SERVER_URL']}/${process.env['GITHUB_REPOSITORY']}/blob/${process.env['GITHUB_SHA']}`;
+}
+
+export function getGitLabBaseUrl(): string {
+  return `${process.env['CI_SERVER_URL']}/${process.env['CI_PROJECT_PATH']}/-/blob/${process.env['CI_COMMIT_SHA']}`;
+}

packages/utils/src/lib/reports/formatting.ts

@@ -16,7 +16,11 @@ import {
   getColumnAlignments,
   rowToStringArray,
 } from '../text-formats/table';
-import { getEnvironmentType, getGitHubBaseUrl } from './ide-environment';
+import {
+  getEnvironmentType,
+  getGitHubBaseUrl,
+  getGitLabBaseUrl,
+} from './environment-type';
 import type { MdReportOptions } from './types';
 
 export function tableSection(
@@ -120,6 +124,20 @@ export function formatGitHubLink(
   return `${baseUrl}/${file}#${lineRange}`;
 }
 
+export function formatGitLabLink(
+  file: string,
+  position: SourceFileLocation['position'],
+): string {
+  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}`;
+}
+
 export function formatFileLink(
   file: string,
   position: SourceFileLocation['position'],
@@ -133,6 +151,8 @@ export function formatFileLink(
       return position ? `${relativePath}#L${position.startLine}` : relativePath;
     case 'github':
       return formatGitHubLink(file, position);
+    case 'gitlab':
+      return formatGitLabLink(file, position);
     default:
       return relativePath;
   }

packages/utils/src/lib/reports/formatting.unit.test.ts

@@ -3,6 +3,7 @@ import { toUnixPath } from '../transform';
 import {
   formatFileLink,
   formatGitHubLink,
+  formatGitLabLink,
   formatSourceLine,
   linkToLocalSourceForIde,
   metaDescription,
@@ -226,6 +227,57 @@ describe('formatGitHubLink', () => {
   });
 });
 
+describe('formatGitLabLink', () => {
+  beforeEach(() => {
+    vi.stubEnv('TERM_PROGRAM', '');
+    vi.stubEnv('GITHUB_ACTIONS', 'false');
+    vi.stubEnv('GITLAB_CI', 'true');
+    vi.stubEnv('CI_SERVER_URL', 'https://gitlab.com');
+    vi.stubEnv('CI_PROJECT_PATH', 'user/repo');
+    vi.stubEnv('CI_COMMIT_SHA', '1234567890abcdef');
+  });
+
+  it.each([
+    [
+      { startLine: 2 },
+      'https://gitlab.com/user/repo/-/blob/1234567890abcdef/src/index.ts#L2',
+    ],
+    [
+      { startLine: 2, endLine: 5 },
+      'https://gitlab.com/user/repo/-/blob/1234567890abcdef/src/index.ts#L2-5',
+    ],
+    [
+      { startLine: 2, startColumn: 1 },
+      'https://gitlab.com/user/repo/-/blob/1234567890abcdef/src/index.ts#L2',
+    ],
+    [
+      { startLine: 2, endLine: 2, startColumn: 1, endColumn: 5 },
+      'https://gitlab.com/user/repo/-/blob/1234567890abcdef/src/index.ts#L2',
+    ],
+    [
+      { startLine: 2, endLine: 5, startColumn: 1, endColumn: 6 },
+      'https://gitlab.com/user/repo/-/blob/1234567890abcdef/src/index.ts#L2-5',
+    ],
+    [
+      { startLine: 2, endLine: 2, startColumn: 1, endColumn: 1 },
+      'https://gitlab.com/user/repo/-/blob/1234567890abcdef/src/index.ts#L2',
+    ],
+  ])(
+    'should generate a GitLab repository link for the file with position %o',
+    (position, expected) => {
+      expect(formatGitLabLink(toUnixPath('src/index.ts'), position)).toBe(
+        expected,
+      );
+    },
+  );
+
+  it('should generate a GitLab repository link for the file when the position is undefined', () => {
+    expect(formatGitLabLink(toUnixPath('src/index.ts'), undefined)).toBe(
+      'https://gitlab.com/user/repo/-/blob/1234567890abcdef/src/index.ts',
+    );
+  });
+});
+
 describe('formatFileLink', () => {
   it('should return a GitHub repository link when running in GitHub Actions', () => {
     vi.stubEnv('TERM_PROGRAM', '');
@@ -245,6 +297,25 @@ describe('formatFileLink', () => {
     );
   });
 
+  it('should return a GitLab repository link when running in GitLab CI/CD', () => {
+    vi.stubEnv('TERM_PROGRAM', '');
+    vi.stubEnv('GITHUB_ACTIONS', 'false');
+    vi.stubEnv('GITLAB_CI', 'true');
+    vi.stubEnv('CI_SERVER_URL', 'https://gitlab.com');
+    vi.stubEnv('CI_PROJECT_PATH', 'user/repo');
+    vi.stubEnv('CI_COMMIT_SHA', '1234567890abcdef');
+
+    expect(
+      formatFileLink(
+        toUnixPath('src/index.ts'),
+        { startLine: 2 },
+        toUnixPath('.code-pushup'),
+      ),
+    ).toBe(
+      `https://gitlab.com/user/repo/-/blob/1234567890abcdef/src/index.ts#L2`,
+    );
+  });
+
   it.each([
     [{ startLine: 2 }, '../src/index.ts#L2'],
     [{ startLine: 2, endLine: 5 }, '../src/index.ts#L2'],
@@ -276,9 +347,10 @@ describe('formatFileLink', () => {
     ).toBe('../src/index.ts');
   });
 
-  it('should return a relative file path when the environment is neither VS Code nor GitHub', () => {
+  it('should return a relative file path when the environment is neither VS Code nor GitHub, nor GitLab', () => {
     vi.stubEnv('TERM_PROGRAM', '');
     vi.stubEnv('GITHUB_ACTIONS', 'false');
+    vi.stubEnv('GITLAB_CI', 'false');
     expect(
       formatFileLink(
         toUnixPath('src/index.ts'),

packages/utils/src/lib/reports/ide-environment.ts

@@ -34,4 +34,10 @@ export type DiffOutcome = 'positive' | 'negative' | 'mixed' | 'unchanged';
 
 export type MdReportOptions = Pick<PersistConfig, 'outputDir'>;
 
-export type IdeEnvironment = 'vscode' | 'github' | 'other';
+export const SUPPORTED_ENVIRONMENTS = [
+  'vscode',
+  'github',
+  'gitlab',
+  'other',
+] as const;
+export type EnvironmentType = (typeof SUPPORTED_ENVIRONMENTS)[number];