@code-pushup/utils 0.14.4 → 0.16.0

package/index.js

@@ -960,6 +960,13 @@ function compareIssues(a, b) {
   }
   return 0;
 }
+function portalCommitLink(config, commit) {
+  const { organization, project, baseUrl } = config;
+  return `${baseUrl}/portal/${organization}/${project}/commit/${commit}`;
+}
+function portalCommitDashboardLink(config, commit) {
+  return `${portalCommitLink(config, commit)}/dashboard`;
+}
 
 // packages/utils/src/lib/execute-process.ts
 var ProcessError = class extends Error {
@@ -1016,6 +1023,19 @@ async function getLatestCommit() {
   });
   return log.latest;
 }
+function validateCommitData(commitData, options = {}) {
+  const { throwError = false } = options;
+  if (!commitData) {
+    const msg = "no commit data available";
+    if (throwError) {
+      throw new Error(msg);
+    } else {
+      console.warn(msg);
+      return false;
+    }
+  }
+  return true;
+}
 
 // packages/utils/src/lib/group-by-status.ts
 function groupByStatus(results) {
@@ -1661,6 +1681,35 @@ var verboseUtils = (verbose = false) => ({
   log: getLogVerbose(verbose),
   exec: getExecVerbose(verbose)
 });
+
+// packages/utils/src/lib/logging.ts
+import chalk4 from "chalk";
+function link2(text) {
+  return chalk4.underline(chalk4.blueBright(text));
+}
+
+// packages/utils/src/lib/filter-by-slug.ts
+function filterGroupsByAuditSlug(groups, auditSlugs) {
+  const slugs = toArray(auditSlugs);
+  if (slugs.length === 0) {
+    return groups;
+  }
+  return groups.map((group) => ({
+    ...group,
+    refs: filterSlug(group.refs, slugs)
+  })).filter((group) => group.refs.length);
+}
+function filterAuditsBySlug(list, auditSlugs) {
+  const slugs = toArray(auditSlugs);
+  if (slugs.length === 0) {
+    return list;
+  }
+  return filterSlug(list, slugs);
+}
+function filterSlug(refs, slugOrSlugs) {
+  const slugs = toArray(slugOrSlugs);
+  return refs.filter(({ slug }) => slugs.includes(slug));
+}
 export {
   CODE_PUSHUP_DOMAIN,
   FOOTER_PREFIX,
@@ -1679,6 +1728,8 @@ export {
   exists,
   factorOf,
   fileExists,
+  filterAuditsBySlug,
+  filterGroupsByAuditSlug,
   findLineNumberInText,
   formatBytes,
   formatDuration,
@@ -1691,6 +1742,7 @@ export {
   importEsmModule,
   isPromiseFulfilledResult,
   isPromiseRejectedResult,
+  link2 as link,
   loadReport,
   logMultipleFileResults,
   logMultipleResults,
@@ -1700,6 +1752,7 @@ export {
   pluginWorkDir,
   pluralize,
   pluralizeToken,
+  portalCommitDashboardLink,
   readJsonFile,
   readTextFile,
   scoreReport,
@@ -1714,5 +1767,6 @@ export {
   truncateIssueMessage,
   truncateText,
   truncateTitle,
+  validateCommitData,
   verboseUtils
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.14.4",
+  "version": "0.16.0",
   "dependencies": {
     "@code-pushup/models": "*",
     "bundle-require": "^4.0.1",

package/src/index.d.ts

@@ -2,7 +2,7 @@ export { exists } from '@code-pushup/models';
 export { ProcessConfig, ProcessError, ProcessObserver, ProcessResult, executeProcess, } from './lib/execute-process';
 export { CrawlFileSystemOptions, FileResult, MultipleFileResults, crawlFileSystem, directoryExists, ensureDirectoryExists, fileExists, findLineNumberInText, importEsmModule, logMultipleFileResults, pluginWorkDir, readJsonFile, readTextFile, } from './lib/file-system';
 export { formatBytes, formatDuration, pluralize, pluralizeToken, slugify, truncateDescription, truncateIssueMessage, truncateText, truncateTitle, } from './lib/formatting';
-export { getLatestCommit, git } from './lib/git';
+export { getLatestCommit, git, validateCommitData } from './lib/git';
 export { groupByStatus } from './lib/group-by-status';
 export { isPromiseFulfilledResult, isPromiseRejectedResult, } from './lib/guards';
 export { logMultipleResults } from './lib/log-results';
@@ -12,6 +12,8 @@ export { generateMdReport } from './lib/reports/generate-md-report';
 export { generateStdoutSummary } from './lib/reports/generate-stdout-summary';
 export { ScoredReport, scoreReport } from './lib/reports/scoring';
 export { sortReport } from './lib/reports/sorting';
-export { CODE_PUSHUP_DOMAIN, FOOTER_PREFIX, README_LINK, calcDuration, compareIssueSeverity, loadReport, } from './lib/reports/utils';
+export { CODE_PUSHUP_DOMAIN, FOOTER_PREFIX, README_LINK, calcDuration, compareIssueSeverity, loadReport, portalCommitDashboardLink, } from './lib/reports/utils';
 export { CliArgsObject, capitalize, countOccurrences, distinct, factorOf, objectToCliArgs, objectToEntries, objectToKeys, toArray, toNumberPrecision, toOrdinal, toUnixNewlines, toUnixPath, } from './lib/transform';
 export { verboseUtils } from './lib/verbose-utils';
+export { link } from './lib/logging';
+export { filterAuditsBySlug, filterGroupsByAuditSlug, } from './lib/filter-by-slug';

package/src/lib/filter-by-slug.d.ts

@@ -0,0 +1,6 @@
+import { Audit, Group } from '@code-pushup/models';
+export declare function filterGroupsByAuditSlug(groups: Group[], auditSlugs: string | string[]): Group[];
+export declare function filterAuditsBySlug(list: Audit[], auditSlugs: string[] | string): Audit[];
+export declare function filterSlug<T extends {
+    slug: string;
+}>(refs: T[], slugOrSlugs: string | string[]): T[];

package/src/lib/git.d.ts

@@ -11,3 +11,6 @@ export declare function getLatestCommit(): Promise<({
     author: string;
     date: string;
 } & import("simple-git").ListLogLine) | null>;
+export declare function validateCommitData(commitData?: unknown, options?: {
+    throwError?: boolean;
+}): commitData is CommitData;

package/src/lib/logging.d.ts

@@ -0,0 +1 @@
+export declare function link(text: string): string;

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

@@ -1,4 +1,4 @@
-import { CategoryRef, IssueSeverity as CliIssueSeverity, Format, Issue, PersistConfig, Report } from '@code-pushup/models';
+import { CategoryRef, IssueSeverity as CliIssueSeverity, Format, Issue, PersistConfig, Report, UploadConfig } from '@code-pushup/models';
 import { EnrichedAuditReport, EnrichedScoredGroupWithAudits, ScoredReport, WeighedAuditReport } from './scoring';
 export declare const FOOTER_PREFIX = "Made with \u2764 by";
 export declare const CODE_PUSHUP_DOMAIN = "code-pushup.dev";
@@ -28,4 +28,9 @@ export declare function loadReport<T extends Format>(options: Required<Pick<Pers
 export declare function throwIsNotPresentError(itemName: string, presentPlace: string): never;
 export declare function getPluginNameFromSlug(slug: string, plugins: ScoredReport['plugins']): string;
 export declare function compareIssues(a: Issue, b: Issue): number;
+export type CommitLinkOptions = Pick<UploadConfig, 'project' | 'organization'> & {
+    baseUrl: string;
+};
+export declare function portalCommitLink(config: CommitLinkOptions, commit: string): string;
+export declare function portalCommitDashboardLink(config: CommitLinkOptions, commit: string): string;
 export {};