@code-pushup/utils 0.52.0 → 0.53.1

package/index.js

@@ -12,7 +12,7 @@ var MAX_ISSUE_MESSAGE_LENGTH = 1024;
 var slugRegex = /^[a-z\d]+(?:-[a-z\d]+)*$/;
 var filenameRegex = /^(?!.*[ \\/:*?"<>|]).+$/;
 function hasDuplicateStrings(strings) {
-  const sortedStrings = [...strings].sort();
+  const sortedStrings = strings.toSorted();
   const duplStrings = sortedStrings.filter(
     (item, index) => index !== 0 && item === sortedStrings[index - 1]
   );
@@ -1873,7 +1873,7 @@ function getColumnAlignments(tableData) {
       (_, idx) => getColumnAlignmentForIndex(idx, columns)
     );
   }
-  const biggestRow = [...rows].sort((a, b) => Object.keys(a).length - Object.keys(b).length).at(-1);
+  const biggestRow = rows.toSorted((a, b) => Object.keys(a).length - Object.keys(b).length).at(-1);
   if (columns.length > 0) {
     return columns.map(
       (column, idx) => typeof column === "string" ? column : getColumnAlignmentForKeyAndIndex(
@@ -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;
   }
@@ -2067,7 +2083,7 @@ function getSortableGroupByRef({ plugin, slug, weight }, plugins) {
     throwIsNotPresentError(`Group ${slug}`, groupPlugin.slug);
   }
   const sortedAudits = getSortedGroupAudits(group, groupPlugin.slug, plugins);
-  const sortedAuditRefs = [...group.refs].sort((a, b) => {
+  const sortedAuditRefs = group.refs.toSorted((a, b) => {
     const aIndex = sortedAudits.findIndex((ref) => ref.slug === a.slug);
     const bIndex = sortedAudits.findIndex((ref) => ref.slug === b.slug);
     return aIndex - bIndex;
@@ -2096,7 +2112,7 @@ function sortReport(report) {
     const sortedAuditsAndGroups = [...audits, ...groups].sort(
       compareCategoryAuditsAndGroups
     );
-    const sortedRefs = [...category.refs].sort((a, b) => {
+    const sortedRefs = category.refs.toSorted((a, b) => {
       const aIndex = sortedAuditsAndGroups.findIndex(
         (ref) => ref.slug === a.slug && ref.plugin === a.plugin
       );
@@ -2116,12 +2132,12 @@ function sortReport(report) {
 function sortPlugins(plugins) {
   return plugins.map((plugin) => ({
     ...plugin,
-    audits: [...plugin.audits].sort(compareAudits).map(
+    audits: plugin.audits.toSorted(compareAudits).map(
       (audit) => audit.details?.issues ? {
         ...audit,
         details: {
           ...audit.details,
-          issues: [...audit.details.issues].sort(compareIssues)
+          issues: audit.details.issues.toSorted(compareIssues)
         }
       } : audit
     )
@@ -2398,7 +2414,7 @@ function formatPortalLink(portalUrl) {
   return portalUrl && md5.link(portalUrl, "\u{1F575}\uFE0F See full comparison in Code PushUp portal \u{1F50D}");
 }
 function sortChanges(changes) {
-  return [...changes].sort(
+  return changes.toSorted(
     (a, b) => Math.abs(b.scores.diff) - Math.abs(a.scores.diff) || Math.abs(b.values?.diff ?? 0) - Math.abs(a.values?.diff ?? 0)
   );
 }

package/package.json

@@ -1,33 +1,40 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.52.0",
+  "version": "0.53.1",
   "description": "Low-level utilities (helper functions, etc.) used by Code PushUp CLI",
-  "dependencies": {
-    "@code-pushup/models": "0.52.0",
-    "@isaacs/cliui": "^8.0.2",
-    "@poppinss/cliui": "^6.4.0",
-    "ansis": "^3.3.0",
-    "build-md": "^0.4.2",
-    "bundle-require": "^4.0.1",
-    "esbuild": "^0.19.2",
-    "multi-progress-bars": "^5.0.3",
-    "semver": "^7.6.0",
-    "simple-git": "^3.20.0"
-  },
   "license": "MIT",
   "homepage": "https://github.com/code-pushup/cli/tree/main/packages/utils#readme",
   "bugs": {
-    "url": "https://github.com/code-pushup/cli/issues"
+    "url": "https://github.com/code-pushup/cli/issues?q=is%3Aissue%20state%3Aopen%20type%3ABug%20label%3A\"🧩%20utils\""
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/code-pushup/cli.git",
     "directory": "packages/utils"
   },
+  "keywords": [
+    "CLI",
+    "Code PushUp",
+    "developer tools",
+    "helpers",
+    "utils"
+  ],
   "publishConfig": {
     "access": "public"
   },
   "type": "module",
   "main": "./index.js",
-  "types": "./src/index.d.ts"
-}
+  "types": "./src/index.d.ts",
+  "dependencies": {
+    "@code-pushup/models": "0.53.1",
+    "@isaacs/cliui": "^8.0.2",
+    "@poppinss/cliui": "^6.4.0",
+    "ansis": "^3.3.0",
+    "build-md": "^0.4.2",
+    "bundle-require": "^4.0.1",
+    "esbuild": "^0.19.2",
+    "multi-progress-bars": "^5.0.3",
+    "semver": "^7.6.0",
+    "simple-git": "^3.20.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;