@code-pushup/utils 0.51.0 → 0.53.0

package/index.js

@@ -1275,6 +1275,9 @@ function findLineNumberInText(content, pattern) {
 function filePathToCliArg(path) {
   return `"${path}"`;
 }
+function projectToFilename(project) {
+  return project.replace(/[/\\\s]+/g, "-").replace(/@/g, "");
+}
 
 // packages/utils/src/lib/filter.ts
 function filterItemRefsBy(items, refFilterFn) {
@@ -1921,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) {
@@ -2005,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();
@@ -2013,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;
   }
@@ -2658,11 +2677,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);
   }
@@ -2673,36 +2692,49 @@ function reportToHeaderSection(report) {
   const { packageName, version } = report;
   return `${bold4(REPORT_HEADLINE_TEXT)} - ${packageName}@${version}`;
 }
-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 }) => [
@@ -2911,6 +2943,7 @@ export {
   pluginWorkDir,
   pluralize,
   pluralizeToken,
+  projectToFilename,
   readJsonFile,
   readTextFile,
   removeDirectoryIfExists,

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.51.0",
+  "version": "0.53.0",
   "description": "Low-level utilities (helper functions, etc.) used by Code PushUp CLI",
   "dependencies": {
-    "@code-pushup/models": "0.51.0",
+    "@code-pushup/models": "0.53.0",
     "@isaacs/cliui": "^8.0.2",
     "@poppinss/cliui": "^6.4.0",
     "ansis": "^3.3.0",
@@ -24,6 +24,9 @@
     "url": "git+https://github.com/code-pushup/cli.git",
     "directory": "packages/utils"
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "type": "module",
   "main": "./index.js",
   "types": "./src/index.d.ts"

package/src/index.d.ts

@@ -2,7 +2,7 @@ export { exists } from '@code-pushup/models';
 export { comparePairs, matchArrayItemsByKey, type Diff } from './lib/diff';
 export { stringifyError } from './lib/errors';
 export { ProcessError, executeProcess, type ProcessConfig, type ProcessObserver, type ProcessResult, } from './lib/execute-process';
-export { crawlFileSystem, directoryExists, ensureDirectoryExists, fileExists, filePathToCliArg, findLineNumberInText, importModule, logMultipleFileResults, pluginWorkDir, readJsonFile, readTextFile, removeDirectoryIfExists, type CrawlFileSystemOptions, type FileResult, type MultipleFileResults, } from './lib/file-system';
+export { crawlFileSystem, directoryExists, ensureDirectoryExists, fileExists, filePathToCliArg, findLineNumberInText, importModule, logMultipleFileResults, pluginWorkDir, projectToFilename, readJsonFile, readTextFile, removeDirectoryIfExists, type CrawlFileSystemOptions, type FileResult, type MultipleFileResults, } from './lib/file-system';
 export { filterItemRefsBy } from './lib/filter';
 export { formatBytes, formatDuration, pluralize, pluralizeToken, slugify, truncateDescription, truncateIssueMessage, truncateText, truncateTitle, } from './lib/formatting';
 export { formatGitPath, getGitRoot, guardAgainstLocalChanges, safeCheckout, toGitPath, } from './lib/git/git';

package/src/lib/file-system.d.ts

@@ -18,3 +18,4 @@ export type CrawlFileSystemOptions<T> = {
 export declare function crawlFileSystem<T = string>(options: CrawlFileSystemOptions<T>): Promise<T[]>;
 export declare function findLineNumberInText(content: string, pattern: string): number | null;
 export declare function filePathToCliArg(path: string): string;
+export declare function projectToFilename(project: string): string;

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/log-stdout-summary.d.ts

@@ -1,4 +1,5 @@
 import type { ScoredReport } from './types';
-export declare function logStdoutSummary(report: ScoredReport): void;
+export declare function logStdoutSummary(report: ScoredReport, verbose?: boolean): void;
+export declare function logPlugins(plugins: ScoredReport['plugins'], verbose: boolean): void;
 export declare function logCategories({ categories, plugins }: ScoredReport): void;
 export declare function binaryIconPrefix(score: number, isBinary: boolean | undefined): 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;