@code-pushup/utils 0.80.2 → 0.81.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.80.2",
+  "version": "0.81.0",
   "description": "Low-level utilities (helper functions, etc.) used by Code PushUp CLI",
   "license": "MIT",
   "homepage": "https://github.com/code-pushup/cli/tree/main/packages/utils#readme",
@@ -27,7 +27,7 @@
     "node": ">=17.0.0"
   },
   "dependencies": {
-    "@code-pushup/models": "0.80.2",
+    "@code-pushup/models": "0.81.0",
     "@isaacs/cliui": "^8.0.2",
     "@poppinss/cliui": "^6.4.0",
     "ansis": "^3.3.0",
@@ -37,7 +37,8 @@
     "multi-progress-bars": "^5.0.3",
     "semver": "^7.6.0",
     "simple-git": "^3.20.0",
-    "zod": "^4.0.5"
+    "zod": "^4.0.5",
+    "ora": "^9.0.0"
   },
   "files": [
     "src",

package/src/index.d.ts

@@ -2,22 +2,24 @@ export { exists } from '@code-pushup/models';
 export { camelCaseToKebabCase, capitalize, kebabCaseToCamelCase, lowercase, toSentenceCase, toTitleCase, uppercase, } from './lib/case-conversions.js';
 export { filesCoverageToTree, type FileCoverage } from './lib/coverage-tree.js';
 export { createRunnerFiles } from './lib/create-runner-files.js';
+export { dateToUnixTimestamp } from './lib/dates.js';
 export { comparePairs, matchArrayItemsByKey, type Diff } from './lib/diff.js';
 export { coerceBooleanValue, isCI, isEnvVarEnabled, isVerbose, runnerArgsFromEnv, runnerArgsToEnv, } from './lib/env.js';
 export { stringifyError } from './lib/errors.js';
 export { executeProcess, ProcessError, type ProcessConfig, type ProcessObserver, type ProcessResult, } from './lib/execute-process.js';
 export { crawlFileSystem, createReportPath, directoryExists, ensureDirectoryExists, fileExists, filePathToCliArg, findLineNumberInText, findNearestFile, importModule, logMultipleFileResults, pluginWorkDir, projectToFilename, readJsonFile, readTextFile, removeDirectoryIfExists, type CrawlFileSystemOptions, type FileResult, type MultipleFileResults, } from './lib/file-system.js';
 export { filterItemRefsBy } from './lib/filter.js';
-export { formatBytes, formatDuration, pluralize, pluralizeToken, slugify, truncateDescription, truncateIssueMessage, truncateText, truncateTitle, } from './lib/formatting.js';
+export { formatBytes, formatDuration, indentLines, pluralize, pluralizeToken, roundDecimals, slugify, transformLines, truncateDescription, truncateIssueMessage, truncateText, truncateTitle, } from './lib/formatting.js';
 export { getCurrentBranchOrTag, getHashes, getHashFromTag, getLatestCommit, getSemverTags, type LogResult, } from './lib/git/git.commits-and-tags.js';
 export { formatGitPath, getGitRoot, guardAgainstLocalChanges, safeCheckout, toGitPath, } from './lib/git/git.js';
 export { hasNoNullableProps, isPromiseFulfilledResult, isPromiseRejectedResult, } from './lib/guards.js';
 export { interpolate } from './lib/interpolate.js';
 export { logMultipleResults } from './lib/log-results.js';
+export { Logger, logger } from './lib/logger.js';
 export { link, ui, type CliUi, type Column } from './lib/logging.js';
 export { mergeConfigs } from './lib/merge-configs.js';
 export { getProgressBar, type ProgressBar } from './lib/progress.js';
-export { asyncSequential, groupByStatus } from './lib/promises.js';
+export { asyncSequential, groupByStatus, settlePromise, } from './lib/promises.js';
 export { generateRandomId } from './lib/random.js';
 export { CODE_PUSHUP_DOMAIN, CODE_PUSHUP_UNICODE_LOGO, FOOTER_PREFIX, README_LINK, TERMINAL_WIDTH, } from './lib/reports/constants.js';
 export { listAuditsFromAllPlugins, listGroupsFromAllPlugins, } from './lib/reports/flatten-plugins.js';

package/src/index.js

@@ -2,22 +2,24 @@ export { exists } from '@code-pushup/models';
 export { camelCaseToKebabCase, capitalize, kebabCaseToCamelCase, lowercase, toSentenceCase, toTitleCase, uppercase, } from './lib/case-conversions.js';
 export { filesCoverageToTree } from './lib/coverage-tree.js';
 export { createRunnerFiles } from './lib/create-runner-files.js';
+export { dateToUnixTimestamp } from './lib/dates.js';
 export { comparePairs, matchArrayItemsByKey } from './lib/diff.js';
 export { coerceBooleanValue, isCI, isEnvVarEnabled, isVerbose, runnerArgsFromEnv, runnerArgsToEnv, } from './lib/env.js';
 export { stringifyError } from './lib/errors.js';
 export { executeProcess, ProcessError, } from './lib/execute-process.js';
 export { crawlFileSystem, createReportPath, directoryExists, ensureDirectoryExists, fileExists, filePathToCliArg, findLineNumberInText, findNearestFile, importModule, logMultipleFileResults, pluginWorkDir, projectToFilename, readJsonFile, readTextFile, removeDirectoryIfExists, } from './lib/file-system.js';
 export { filterItemRefsBy } from './lib/filter.js';
-export { formatBytes, formatDuration, pluralize, pluralizeToken, slugify, truncateDescription, truncateIssueMessage, truncateText, truncateTitle, } from './lib/formatting.js';
+export { formatBytes, formatDuration, indentLines, pluralize, pluralizeToken, roundDecimals, slugify, transformLines, truncateDescription, truncateIssueMessage, truncateText, truncateTitle, } from './lib/formatting.js';
 export { getCurrentBranchOrTag, getHashes, getHashFromTag, getLatestCommit, getSemverTags, } from './lib/git/git.commits-and-tags.js';
 export { formatGitPath, getGitRoot, guardAgainstLocalChanges, safeCheckout, toGitPath, } from './lib/git/git.js';
 export { hasNoNullableProps, isPromiseFulfilledResult, isPromiseRejectedResult, } from './lib/guards.js';
 export { interpolate } from './lib/interpolate.js';
 export { logMultipleResults } from './lib/log-results.js';
+export { Logger, logger } from './lib/logger.js';
 export { link, ui } from './lib/logging.js';
 export { mergeConfigs } from './lib/merge-configs.js';
 export { getProgressBar } from './lib/progress.js';
-export { asyncSequential, groupByStatus } from './lib/promises.js';
+export { asyncSequential, groupByStatus, settlePromise, } from './lib/promises.js';
 export { generateRandomId } from './lib/random.js';
 export { CODE_PUSHUP_DOMAIN, CODE_PUSHUP_UNICODE_LOGO, FOOTER_PREFIX, README_LINK, TERMINAL_WIDTH, } from './lib/reports/constants.js';
 export { listAuditsFromAllPlugins, listGroupsFromAllPlugins, } from './lib/reports/flatten-plugins.js';

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,oBAAoB,EACpB,UAAU,EACV,oBAAoB,EACpB,SAAS,EACT,cAAc,EACd,WAAW,EACX,SAAS,GACV,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAqB,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAa,MAAM,eAAe,CAAC;AAC9E,OAAO,EACL,kBAAkB,EAClB,IAAI,EACJ,eAAe,EACf,SAAS,EACT,iBAAiB,EACjB,eAAe,GAChB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EACL,cAAc,EACd,YAAY,GAIb,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,UAAU,EACV,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,EACf,YAAY,EACZ,sBAAsB,EACtB,aAAa,EACb,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,uBAAuB,GAIxB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EACL,WAAW,EACX,cAAc,EACd,SAAS,EACT,cAAc,EACd,OAAO,EACP,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACZ,aAAa,GACd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,qBAAqB,EACrB,SAAS,EACT,cAAc,EACd,eAAe,EACf,aAAa,GAEd,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,aAAa,EACb,UAAU,EACV,wBAAwB,EACxB,YAAY,EACZ,SAAS,GACV,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,uBAAuB,GACxB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,IAAI,EAAE,EAAE,EAA2B,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAoB,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,aAAa,EACb,WAAW,EACX,cAAc,GACf,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,wBAAwB,EACxB,wBAAwB,GACzB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EACL,qBAAqB,EACrB,gCAAgC,GACjC,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAMtD,OAAO,EACL,YAAY,EACZ,oBAAoB,EACpB,iBAAiB,GAClB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACzE,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EACL,gBAAgB,EAChB,QAAQ,EACR,QAAQ,EACR,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,YAAY,EACZ,4BAA4B,EAC5B,OAAO,EACP,WAAW,EACX,iBAAiB,EACjB,SAAS,EACT,cAAc,EACd,UAAU,GAEX,MAAM,oBAAoB,CAAC;AAW5B,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EACL,oBAAoB,EACpB,UAAU,EACV,oBAAoB,EACpB,SAAS,EACT,cAAc,EACd,WAAW,EACX,SAAS,GACV,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAqB,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAa,MAAM,eAAe,CAAC;AAC9E,OAAO,EACL,kBAAkB,EAClB,IAAI,EACJ,eAAe,EACf,SAAS,EACT,iBAAiB,EACjB,eAAe,GAChB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EACL,cAAc,EACd,YAAY,GAIb,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,eAAe,EACf,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,UAAU,EACV,gBAAgB,EAChB,oBAAoB,EACpB,eAAe,EACf,YAAY,EACZ,sBAAsB,EACtB,aAAa,EACb,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,uBAAuB,GAIxB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EACL,WAAW,EACX,cAAc,EACd,WAAW,EACX,SAAS,EACT,cAAc,EACd,aAAa,EACb,OAAO,EACP,cAAc,EACd,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACZ,aAAa,GACd,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACL,qBAAqB,EACrB,SAAS,EACT,cAAc,EACd,eAAe,EACf,aAAa,GAEd,MAAM,mCAAmC,CAAC;AAC3C,OAAO,EACL,aAAa,EACb,UAAU,EACV,wBAAwB,EACxB,YAAY,EACZ,SAAS,GACV,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,uBAAuB,GACxB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,EAAE,EAA2B,MAAM,kBAAkB,CAAC;AACrE,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,cAAc,EAAoB,MAAM,mBAAmB,CAAC;AACrE,OAAO,EACL,eAAe,EACf,aAAa,EACb,aAAa,GACd,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,OAAO,EACL,kBAAkB,EAClB,wBAAwB,EACxB,aAAa,EACb,WAAW,EACX,cAAc,GACf,MAAM,4BAA4B,CAAC;AACpC,OAAO,EACL,wBAAwB,EACxB,wBAAwB,GACzB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EACL,qBAAqB,EACrB,gCAAgC,GACjC,MAAM,2CAA2C,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC9E,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AAMtD,OAAO,EACL,YAAY,EACZ,oBAAoB,EACpB,iBAAiB,GAClB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,QAAQ,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AACzE,cAAc,6BAA6B,CAAC;AAC5C,OAAO,EACL,gBAAgB,EAChB,QAAQ,EACR,QAAQ,EACR,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,YAAY,EACZ,4BAA4B,EAC5B,OAAO,EACP,WAAW,EACX,iBAAiB,EACjB,SAAS,EACT,cAAc,EACd,UAAU,GAEX,MAAM,oBAAoB,CAAC;AAW5B,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC"}

package/src/lib/dates.d.ts

@@ -0,0 +1 @@
+export declare function dateToUnixTimestamp(date: Date): number;

package/src/lib/dates.js

@@ -0,0 +1,4 @@
+export function dateToUnixTimestamp(date) {
+    return Math.round(date.getTime() / 1000);
+}
+//# sourceMappingURL=dates.js.map

package/src/lib/dates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dates.js","sourceRoot":"","sources":["../../../src/lib/dates.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,mBAAmB,CAAC,IAAU;IAC5C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;AAC3C,CAAC"}

package/src/lib/formatting.d.ts

@@ -1,8 +1,9 @@
+export declare function roundDecimals(value: number, maxDecimals: number): number;
 export declare function slugify(text: string): string;
 export declare function pluralize(text: string, amount?: number): string;
 export declare function formatBytes(bytes: number, decimals?: number): string;
 export declare function pluralizeToken(token: string, times: number): string;
-export declare function formatDuration(duration: number, granularity?: number): string;
+export declare function formatDuration(ms: number, maxDecimals?: number): string;
 export declare function formatDate(date: Date): string;
 export declare function truncateText(text: string, options: number | {
     maxChars: number;
@@ -12,3 +13,5 @@ export declare function truncateText(text: string, options: number | {
 export declare function truncateTitle(text: string): string;
 export declare function truncateDescription(text: string): string;
 export declare function truncateIssueMessage(text: string): string;
+export declare function transformLines(text: string, fn: (line: string) => string): string;
+export declare function indentLines(text: string, identation: number): string;

package/src/lib/formatting.js

@@ -1,4 +1,8 @@
 import { MAX_DESCRIPTION_LENGTH, MAX_ISSUE_MESSAGE_LENGTH, MAX_TITLE_LENGTH, } from '@code-pushup/models';
+export function roundDecimals(value, maxDecimals) {
+    const multiplier = Math.pow(10, maxDecimals);
+    return Math.round(value * multiplier) / multiplier;
+}
 export function slugify(text) {
     return text
         .trim()
@@ -28,16 +32,16 @@ export function formatBytes(bytes, decimals = 2) {
     const dm = Math.max(decimals, 0);
     const sizes = ['B', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB'];
     const i = Math.floor(Math.log(positiveBytes) / Math.log(k));
-    return `${Number.parseFloat((positiveBytes / Math.pow(k, i)).toFixed(dm))} ${sizes[i]}`;
+    return `${roundDecimals(positiveBytes / Math.pow(k, i), dm)} ${sizes[i]}`;
 }
 export function pluralizeToken(token, times) {
     return `${times} ${Math.abs(times) === 1 ? token : pluralize(token)}`;
 }
-export function formatDuration(duration, granularity = 0) {
-    if (duration < 1000) {
-        return `${granularity ? duration.toFixed(granularity) : duration} ms`;
+export function formatDuration(ms, maxDecimals = 2) {
+    if (ms < 1000) {
+        return `${Math.round(ms)} ms`;
     }
-    return `${(duration / 1000).toFixed(2)} s`;
+    return `${roundDecimals(ms / 1000, maxDecimals)} s`;
 }
 export function formatDate(date) {
     const locale = 'en-US'; // fixed locale to ensure consistency across local defaults execution
@@ -80,4 +84,10 @@ export function truncateDescription(text) {
 export function truncateIssueMessage(text) {
     return truncateText(text, MAX_ISSUE_MESSAGE_LENGTH);
 }
+export function transformLines(text, fn) {
+    return text.split(/\r?\n/).map(fn).join('\n');
+}
+export function indentLines(text, identation) {
+    return transformLines(text, line => `${' '.repeat(identation)}${line}`);
+}
 //# sourceMappingURL=formatting.js.map

package/src/lib/formatting.js.map

@@ -1 +1 @@
-{"version":3,"file":"formatting.js","sourceRoot":"","sources":["../../../src/lib/formatting.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,gBAAgB,GACjB,MAAM,qBAAqB,CAAC;AAE7B,MAAM,UAAU,OAAO,CAAC,IAAY;IAClC,OAAO,IAAI;SACR,IAAI,EAAE;SACN,WAAW,EAAE;SACb,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,IAAY,EAAE,MAAe;IACrD,IAAI,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IACnC,CAAC;IACD,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,GAAG,IAAI,IAAI,CAAC;IACrB,CAAC;IACD,OAAO,GAAG,IAAI,GAAG,CAAC;AACpB,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,KAAa,EAAE,QAAQ,GAAG,CAAC;IACrD,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAEzC,aAAa;IACb,IAAI,aAAa,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,CAAC,GAAG,IAAI,CAAC;IACf,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACjC,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAEpE,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5D,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IACvE,KAAK,CAAC,CAAC,CACT,EAAE,CAAC;AACL,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAa,EAAE,KAAa;IACzD,OAAO,GAAG,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,QAAgB,EAAE,WAAW,GAAG,CAAC;IAC9D,IAAI,QAAQ,GAAG,IAAI,EAAE,CAAC;QACpB,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,CAAC;IACxE,CAAC;IACD,OAAO,GAAG,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,IAAU;IACnC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,qEAAqE;IAC7F,OAAO,IAAI;SACR,cAAc,CAAC,MAAM,EAAE;QACtB,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,OAAO;QACd,GAAG,EAAE,SAAS;QACd,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,SAAS;QACf,MAAM,EAAE,SAAS;QACjB,YAAY,EAAE,OAAO;KACtB,CAAC;SACD,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,kDAAkD;AAChF,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,IAAY,EACZ,OAMK;IAEL,MAAM,EACJ,QAAQ,EACR,QAAQ,GAAG,KAAK,EAChB,QAAQ,GAAG,KAAK,GACjB,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IAClE,IAAI,IAAI,CAAC,MAAM,IAAI,QAAQ,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC;IAC7C,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,OAAO;YACV,OAAO,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC;QAClD,KAAK,QAAQ;YACX,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;YAC/C,OAAO,CACL,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,IAAI,EAAE;gBAClC,QAAQ;gBACR,IAAI,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE,CACjC,CAAC;QACJ,KAAK,KAAK;YACR,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,IAAI,EAAE,GAAG,QAAQ,CAAC;IACtD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,IAAY;IACxC,OAAO,YAAY,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAY;IAC9C,OAAO,YAAY,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,OAAO,YAAY,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;AACtD,CAAC"}
+{"version":3,"file":"formatting.js","sourceRoot":"","sources":["../../../src/lib/formatting.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,wBAAwB,EACxB,gBAAgB,GACjB,MAAM,qBAAqB,CAAC;AAE7B,MAAM,UAAU,aAAa,CAAC,KAAa,EAAE,WAAmB;IAC9D,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;IAC7C,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,UAAU,CAAC,GAAG,UAAU,CAAC;AACrD,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,IAAY;IAClC,OAAO,IAAI;SACR,IAAI,EAAE;SACN,WAAW,EAAE;SACb,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC;SACvB,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;AAC/B,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,IAAY,EAAE,MAAe;IACrD,IAAI,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IACnC,CAAC;IACD,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,GAAG,IAAI,IAAI,CAAC;IACrB,CAAC;IACD,OAAO,GAAG,IAAI,GAAG,CAAC;AACpB,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,KAAa,EAAE,QAAQ,GAAG,CAAC;IACrD,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAEzC,aAAa;IACb,IAAI,aAAa,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,CAAC,GAAG,IAAI,CAAC;IACf,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACjC,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAEpE,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAE5D,OAAO,GAAG,aAAa,CAAC,aAAa,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAC5E,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAa,EAAE,KAAa;IACzD,OAAO,GAAG,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,EAAU,EAAE,cAAsB,CAAC;IAChE,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC;QACd,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC;IAChC,CAAC;IACD,OAAO,GAAG,aAAa,CAAC,EAAE,GAAG,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,IAAU;IACnC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,qEAAqE;IAC7F,OAAO,IAAI;SACR,cAAc,CAAC,MAAM,EAAE;QACtB,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,OAAO;QACd,GAAG,EAAE,SAAS;QACd,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,SAAS;QACf,MAAM,EAAE,SAAS;QACjB,YAAY,EAAE,OAAO;KACtB,CAAC;SACD,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,kDAAkD;AAChF,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,IAAY,EACZ,OAMK;IAEL,MAAM,EACJ,QAAQ,EACR,QAAQ,GAAG,KAAK,EAChB,QAAQ,GAAG,KAAK,GACjB,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IAClE,IAAI,IAAI,CAAC,MAAM,IAAI,QAAQ,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC;IAC7C,QAAQ,QAAQ,EAAE,CAAC;QACjB,KAAK,OAAO;YACV,OAAO,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC;QAClD,KAAK,QAAQ;YACX,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC;YAC/C,OAAO,CACL,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC,IAAI,EAAE;gBAClC,QAAQ;gBACR,IAAI,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,IAAI,EAAE,CACjC,CAAC;QACJ,KAAK,KAAK;YACR,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,IAAI,EAAE,GAAG,QAAQ,CAAC;IACtD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,IAAY;IACxC,OAAO,YAAY,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,IAAY;IAC9C,OAAO,YAAY,CAAC,IAAI,EAAE,sBAAsB,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,OAAO,YAAY,CAAC,IAAI,EAAE,wBAAwB,CAAC,CAAC;AACtD,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,IAAY,EACZ,EAA4B;IAE5B,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAAY,EAAE,UAAkB;IAC1D,OAAO,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC;AAC1E,CAAC"}

package/src/lib/logger.d.ts

@@ -0,0 +1,155 @@
+/**
+ * Rich logging implementation for Code PushUp CLI, plugins, etc.
+ *
+ * Use {@link logger} singleton.
+ */
+export declare class Logger {
+    #private;
+    /**
+     * Logs an error to the console (red).
+     *
+     * Automatically adapts to logger state if called within {@link task}, {@link group}, etc.
+     *
+     * @example
+     * logger.error('Config file is invalid');
+     *
+     * @param message Error text
+     */
+    error(message: string): void;
+    /**
+     * Logs a warning to the console (yellow).
+     *
+     * Automatically adapts to logger state if called within {@link task}, {@link group}, etc.
+     *
+     * @example
+     * logger.warn('Skipping invalid audits');
+     *
+     * @param message Warning text
+     */
+    warn(message: string): void;
+    /**
+     * Logs an informational message to the console (unstyled).
+     *
+     * Automatically adapts to logger state if called within {@link task}, {@link group}, etc.
+     *
+     * @example
+     * logger.info('Code PushUp CLI v0.80.2');
+     *
+     * @param message Info text
+     */
+    info(message: string): void;
+    /**
+     * Logs a debug message to the console (gray), but **only if verbose** flag is set (see {@link isVerbose}).
+     *
+     * Automatically adapts to logger state if called within {@link task}, {@link group}, etc.
+     *
+     * @example
+     * logger.debug('Running ESLint version 9.16.0');
+     *
+     * @param message Debug text
+     */
+    debug(message: string): void;
+    /**
+     * Print a blank line to the console, used to separate logs for readability.
+     *
+     * Automatically adapts to logger state if called within {@link task}, {@link group}, etc.
+     *
+     * @example
+     * logger.newline();
+     */
+    newline(): void;
+    /**
+     * Is verbose flag set?
+     *
+     * Verbosity is configured by {@link setVerbose} call or `CP_VERBOSE` environment variable.
+     *
+     * @example
+     * if (logger.isVerbose()) {
+     *   // ...
+     * }
+     */
+    isVerbose(): boolean;
+    /**
+     * Sets verbose flag for this logger.
+     *
+     * Also sets the `CP_VERBOSE` environment variable.
+     * This means any future {@link Logger} instantiations (including child processes) will use the same verbosity level.
+     *
+     * @example
+     * logger.setVerbose(process.argv.includes('--verbose'));
+     *
+     * @param isVerbose Verbosity level
+     */
+    setVerbose(isVerbose: boolean): void;
+    /**
+     * Animates asynchronous work using a spinner.
+     *
+     * Basic logs are supported within the worker function, they will be printed with indentation once the spinner completes.
+     *
+     * In CI environments, the spinner animation is disabled, and inner logs are printed immediately.
+     *
+     * Spinners may be nested within a {@link group} call, in which case line symbols are used instead of dots, as well the group's color.
+     *
+     * The task's duration is included in the logged output as a suffix.
+     *
+     * Listens for `SIGINT` event in order to cancel and restore spinner before exiting.
+     *
+     * Concurrent or nested spinners are not supported, nor can groups be nested in spinners.
+     *
+     * @example
+     * await logger.task('Uploading report to portal', async () => {
+     *   // ...
+     *   return 'Uploaded report to portal';
+     * });
+     *
+     * @param title Display text used as pending message.
+     * @param worker Asynchronous implementation. Returned promise determines spinner status and final message. Support for inner logs has some limitations (described above).
+     */
+    task(title: string, worker: () => Promise<string>): Promise<void>;
+    /**
+     * Similar to {@link task}, but spinner texts are formatted as shell commands.
+     *
+     * A `$`-prefix is added. Its color indicates the status (blue=pending, green=success, red=failure).
+     *
+     * @example
+     * await logger.command('npx eslint . --format=json', async () => {
+     *   // ...
+     * });
+     *
+     * @param bin Command string with arguments.
+     * @param worker Asynchronous execution of the command (not implemented by the logger).
+     */
+    command(bin: string, worker: () => Promise<void>): Promise<void>;
+    /**
+     * Groups many logs into a visually distinct section.
+     *
+     * Groups alternate prefix colors between cyan and magenta.
+     *
+     * The group's total duration is included in the logged output.
+     *
+     * Nested groups are not supported.
+     *
+     * @example
+     * await logger.group('Running plugin "ESLint"', async () => {
+     *   logger.debug('ESLint version is 9.16.0');
+     *   await logger.command('npx eslint . --format=json', () => {
+     *     // ...
+     *   })
+     *   logger.info('Found 42 lint errors.');
+     *   return 'Completed "ESLint" plugin execution';
+     * });
+     *
+     * @param title Display title for the group.
+     * @param worker Asynchronous implementation. Returned promise determines group status and ending message. Inner logs are attached to the group.
+     */
+    group(title: string, worker: () => Promise<string>): Promise<void>;
+}
+/**
+ * Shared {@link Logger} instance.
+ *
+ * @example
+ * import { logger } from '@code-pushup/utils';
+ *
+ * logger.info('Made with ❤️ by Code PushUp');
+ */
+export declare const logger: Logger;

package/src/lib/logger.js

@@ -0,0 +1,408 @@
+import ansis, {} from 'ansis';
+import os from 'node:os';
+import ora, {} from 'ora';
+import { dateToUnixTimestamp } from './dates.js';
+import { isEnvVarEnabled } from './env.js';
+import { formatDuration, indentLines, transformLines } from './formatting.js';
+import { settlePromise } from './promises.js';
+const GROUP_COLOR_ENV_VAR_NAME = 'CP_LOGGER_GROUP_COLOR';
+/**
+ * Rich logging implementation for Code PushUp CLI, plugins, etc.
+ *
+ * Use {@link logger} singleton.
+ */
+export class Logger {
+    #isVerbose = isEnvVarEnabled('CP_VERBOSE');
+    #isCI = isEnvVarEnabled('CI');
+    #ciPlatform = process.env['GITHUB_ACTIONS'] === 'true'
+        ? 'GitHub Actions'
+        : process.env['GITLAB_CI'] === 'true'
+            ? 'GitLab CI/CD'
+            : undefined;
+    #groupColor = process.env[GROUP_COLOR_ENV_VAR_NAME] === 'cyan' ||
+        process.env[GROUP_COLOR_ENV_VAR_NAME] === 'magenta'
+        ? process.env[GROUP_COLOR_ENV_VAR_NAME]
+        : undefined;
+    #groupsCount = 0;
+    #activeSpinner;
+    #activeSpinnerLogs = [];
+    #endsWithBlankLine = false;
+    #groupSymbols = {
+        start: '❯',
+        middle: '│',
+        end: '└',
+    };
+    #sigintListener = () => {
+        if (this.#activeSpinner != null) {
+            const text = `${this.#activeSpinner.text} ${ansis.red.bold('[SIGINT]')}`;
+            if (this.#groupColor) {
+                this.#activeSpinner.stopAndPersist({
+                    text,
+                    symbol: this.#colorize(this.#groupSymbols.end, this.#groupColor),
+                });
+                this.#setGroupColor(undefined);
+            }
+            else {
+                this.#activeSpinner.fail(text);
+            }
+            this.#activeSpinner = undefined;
+        }
+        this.newline();
+        this.error(ansis.bold('Cancelled by SIGINT'));
+        process.exit(os.platform() === 'win32' ? 2 : 130);
+    };
+    /**
+     * Logs an error to the console (red).
+     *
+     * Automatically adapts to logger state if called within {@link task}, {@link group}, etc.
+     *
+     * @example
+     * logger.error('Config file is invalid');
+     *
+     * @param message Error text
+     */
+    error(message) {
+        this.#log(message, 'red');
+    }
+    /**
+     * Logs a warning to the console (yellow).
+     *
+     * Automatically adapts to logger state if called within {@link task}, {@link group}, etc.
+     *
+     * @example
+     * logger.warn('Skipping invalid audits');
+     *
+     * @param message Warning text
+     */
+    warn(message) {
+        this.#log(message, 'yellow');
+    }
+    /**
+     * Logs an informational message to the console (unstyled).
+     *
+     * Automatically adapts to logger state if called within {@link task}, {@link group}, etc.
+     *
+     * @example
+     * logger.info('Code PushUp CLI v0.80.2');
+     *
+     * @param message Info text
+     */
+    info(message) {
+        this.#log(message);
+    }
+    /**
+     * Logs a debug message to the console (gray), but **only if verbose** flag is set (see {@link isVerbose}).
+     *
+     * Automatically adapts to logger state if called within {@link task}, {@link group}, etc.
+     *
+     * @example
+     * logger.debug('Running ESLint version 9.16.0');
+     *
+     * @param message Debug text
+     */
+    debug(message) {
+        if (this.#isVerbose) {
+            this.#log(message, 'gray');
+        }
+    }
+    /**
+     * Print a blank line to the console, used to separate logs for readability.
+     *
+     * Automatically adapts to logger state if called within {@link task}, {@link group}, etc.
+     *
+     * @example
+     * logger.newline();
+     */
+    newline() {
+        this.#log('');
+    }
+    /**
+     * Is verbose flag set?
+     *
+     * Verbosity is configured by {@link setVerbose} call or `CP_VERBOSE` environment variable.
+     *
+     * @example
+     * if (logger.isVerbose()) {
+     *   // ...
+     * }
+     */
+    isVerbose() {
+        return this.#isVerbose;
+    }
+    /**
+     * Sets verbose flag for this logger.
+     *
+     * Also sets the `CP_VERBOSE` environment variable.
+     * This means any future {@link Logger} instantiations (including child processes) will use the same verbosity level.
+     *
+     * @example
+     * logger.setVerbose(process.argv.includes('--verbose'));
+     *
+     * @param isVerbose Verbosity level
+     */
+    setVerbose(isVerbose) {
+        process.env['CP_VERBOSE'] = `${isVerbose}`;
+        this.#isVerbose = isVerbose;
+    }
+    /**
+     * Animates asynchronous work using a spinner.
+     *
+     * Basic logs are supported within the worker function, they will be printed with indentation once the spinner completes.
+     *
+     * In CI environments, the spinner animation is disabled, and inner logs are printed immediately.
+     *
+     * Spinners may be nested within a {@link group} call, in which case line symbols are used instead of dots, as well the group's color.
+     *
+     * The task's duration is included in the logged output as a suffix.
+     *
+     * Listens for `SIGINT` event in order to cancel and restore spinner before exiting.
+     *
+     * Concurrent or nested spinners are not supported, nor can groups be nested in spinners.
+     *
+     * @example
+     * await logger.task('Uploading report to portal', async () => {
+     *   // ...
+     *   return 'Uploaded report to portal';
+     * });
+     *
+     * @param title Display text used as pending message.
+     * @param worker Asynchronous implementation. Returned promise determines spinner status and final message. Support for inner logs has some limitations (described above).
+     */
+    task(title, worker) {
+        return this.#spinner(worker, {
+            pending: title,
+            success: value => value,
+            failure: error => `${title} → ${ansis.red(`${error}`)}`,
+        });
+    }
+    /**
+     * Similar to {@link task}, but spinner texts are formatted as shell commands.
+     *
+     * A `$`-prefix is added. Its color indicates the status (blue=pending, green=success, red=failure).
+     *
+     * @example
+     * await logger.command('npx eslint . --format=json', async () => {
+     *   // ...
+     * });
+     *
+     * @param bin Command string with arguments.
+     * @param worker Asynchronous execution of the command (not implemented by the logger).
+     */
+    command(bin, worker) {
+        return this.#spinner(worker, {
+            pending: `${ansis.blue('$')} ${bin}`,
+            success: () => `${ansis.green('$')} ${bin}`,
+            failure: () => `${ansis.red('$')} ${bin}`,
+        });
+    }
+    /**
+     * Groups many logs into a visually distinct section.
+     *
+     * Groups alternate prefix colors between cyan and magenta.
+     *
+     * The group's total duration is included in the logged output.
+     *
+     * Nested groups are not supported.
+     *
+     * @example
+     * await logger.group('Running plugin "ESLint"', async () => {
+     *   logger.debug('ESLint version is 9.16.0');
+     *   await logger.command('npx eslint . --format=json', () => {
+     *     // ...
+     *   })
+     *   logger.info('Found 42 lint errors.');
+     *   return 'Completed "ESLint" plugin execution';
+     * });
+     *
+     * @param title Display title for the group.
+     * @param worker Asynchronous implementation. Returned promise determines group status and ending message. Inner logs are attached to the group.
+     */
+    async group(title, worker) {
+        if (this.#groupColor) {
+            throw new Error('Internal Logger error - nested groups are not supported');
+        }
+        if (this.#activeSpinner) {
+            throw new Error('Internal Logger error - creating group in active spinner is not supported');
+        }
+        if (!this.#endsWithBlankLine) {
+            this.newline();
+        }
+        this.#setGroupColor(this.#groupsCount % 2 === 0 ? 'cyan' : 'magenta');
+        this.#groupsCount++;
+        const groupMarkers = this.#createGroupMarkers();
+        console.log(groupMarkers.start(title));
+        const start = performance.now();
+        const result = await settlePromise(worker());
+        const end = performance.now();
+        if (result.status === 'fulfilled') {
+            console.log([
+                this.#colorize(this.#groupSymbols.end, this.#groupColor),
+                this.#colorize(result.value, 'green'),
+                this.#formatDurationSuffix({ start, end }),
+            ].join(' '));
+        }
+        else {
+            console.log([
+                this.#colorize(this.#groupSymbols.end, this.#groupColor),
+                this.#colorize(`${result.reason}`, 'red'),
+            ].join(' '));
+        }
+        const endMarker = groupMarkers.end();
+        if (endMarker) {
+            console.log(endMarker);
+        }
+        this.#setGroupColor(undefined);
+        this.newline();
+        if (result.status === 'rejected') {
+            throw result.reason;
+        }
+    }
+    #createGroupMarkers() {
+        switch (this.#ciPlatform) {
+            case 'GitHub Actions':
+                // https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-commands#grouping-log-lines
+                return {
+                    start: title => `::group::${this.#formatGroupTitle(title, { prefix: false })}`,
+                    end: () => '::endgroup::',
+                };
+            case 'GitLab CI/CD':
+                // https://docs.gitlab.com/ci/jobs/job_logs/#custom-collapsible-sections
+                const ansiEscCode = '\x1b[0K'; // '\e' ESC character only works for `echo -e`, Node console must use '\x1b'
+                const id = Math.random().toString(16).slice(2);
+                const sectionId = `code_pushup_logs_group_${id}`;
+                return {
+                    start: title => {
+                        const sectionHeader = this.#formatGroupTitle(title, {
+                            prefix: true,
+                        });
+                        const options = this.#isVerbose ? '' : '[collapsed=true]';
+                        // return `${ansiEscCode}section_start:${dateToUnixTimestamp(new Date())}:${sectionId}${options}${ansiEscCode}${sectionHeader}`;
+                        return `${ansiEscCode}section_start:${dateToUnixTimestamp(new Date())}:${sectionId}${options}\r${ansiEscCode}${sectionHeader}`;
+                    },
+                    end: () => 
+                    // `${ansiEscCode}section_end:${dateToUnixTimestamp(new Date())}:${sectionId}${ansiEscCode}`,
+                    `${ansiEscCode}section_end:${dateToUnixTimestamp(new Date())}:${sectionId}\r${ansiEscCode}`,
+                };
+            case undefined:
+                return {
+                    start: title => this.#formatGroupTitle(title, { prefix: true }),
+                    end: () => '',
+                };
+        }
+    }
+    #formatGroupTitle(title, symbols) {
+        const text = symbols.prefix
+            ? `${this.#groupSymbols.start} ${title}`
+            : title;
+        return ansis.bold(this.#colorize(text, this.#groupColor));
+    }
+    #setGroupColor(groupColor) {
+        this.#groupColor = groupColor;
+        if (groupColor) {
+            process.env[GROUP_COLOR_ENV_VAR_NAME] = groupColor;
+        }
+        else {
+            delete process.env[GROUP_COLOR_ENV_VAR_NAME];
+        }
+    }
+    async #spinner(worker, messages) {
+        if (this.#activeSpinner) {
+            throw new Error('Internal Logger error - concurrent spinners are not supported');
+        }
+        process.removeListener('SIGINT', this.#sigintListener);
+        process.addListener('SIGINT', this.#sigintListener);
+        if (this.#groupColor) {
+            this.#activeSpinner = ora({
+                text: messages.pending,
+                spinner: 'line',
+                color: this.#groupColor,
+            });
+            if (this.#isCI) {
+                console.log(this.#format(messages.pending, undefined));
+            }
+            else {
+                this.#activeSpinner.start();
+            }
+        }
+        else {
+            this.#activeSpinner = ora(messages.pending);
+            this.#activeSpinner.start();
+        }
+        this.#endsWithBlankLine = false;
+        const start = performance.now();
+        const result = await settlePromise(worker());
+        const end = performance.now();
+        const text = result.status === 'fulfilled'
+            ? [
+                messages.success(result.value),
+                this.#formatDurationSuffix({ start, end }),
+            ].join(' ')
+            : messages.failure(result.reason);
+        if (this.#activeSpinner) {
+            if (this.#groupColor) {
+                this.#activeSpinner.stopAndPersist({
+                    text,
+                    symbol: this.#colorize(this.#groupSymbols.middle, this.#groupColor),
+                });
+            }
+            else {
+                if (result.status === 'fulfilled') {
+                    this.#activeSpinner.succeed(text);
+                }
+                else {
+                    this.#activeSpinner.fail(text);
+                }
+            }
+            this.#endsWithBlankLine = false;
+        }
+        this.#activeSpinner = undefined;
+        this.#activeSpinnerLogs.forEach(message => {
+            this.#log(indentLines(message, 2));
+        });
+        this.#activeSpinnerLogs = [];
+        process.removeListener('SIGINT', this.#sigintListener);
+        if (result.status === 'rejected') {
+            throw result.reason;
+        }
+    }
+    #log(message, color) {
+        if (this.#activeSpinner) {
+            if (this.#activeSpinner.isSpinning) {
+                this.#activeSpinnerLogs.push(this.#format(message, color));
+            }
+            else {
+                console.log(this.#format(indentLines(message, 2), color));
+            }
+        }
+        else {
+            console.log(this.#format(message, color));
+        }
+        this.#endsWithBlankLine = !message || message.endsWith('\n');
+    }
+    #format(message, color) {
+        if (!this.#groupColor || this.#activeSpinner?.isSpinning) {
+            return this.#colorize(message, color);
+        }
+        return transformLines(message, line => `${this.#colorize('│', this.#groupColor)} ${this.#colorize(line, color)}`);
+    }
+    #colorize(text, color) {
+        if (!color) {
+            return text;
+        }
+        return ansis[color](text);
+    }
+    #formatDurationSuffix({ start, end, }) {
+        const duration = formatDuration(end - start);
+        return ansis.gray(`(${duration})`);
+    }
+}
+/**
+ * Shared {@link Logger} instance.
+ *
+ * @example
+ * import { logger } from '@code-pushup/utils';
+ *
+ * logger.info('Made with ❤️ by Code PushUp');
+ */
+export const logger = new Logger();
+//# sourceMappingURL=logger.js.map

package/src/lib/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../../src/lib/logger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAmB,MAAM,OAAO,CAAC;AAC/C,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,GAAG,EAAE,EAAY,MAAM,KAAK,CAAC;AACpC,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAC9E,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAK9C,MAAM,wBAAwB,GAAG,uBAAuB,CAAC;AAEzD;;;;GAIG;AACH,MAAM,OAAO,MAAM;IACjB,UAAU,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;IAC3C,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IAC9B,WAAW,GACT,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,MAAM;QACtC,CAAC,CAAC,gBAAgB;QAClB,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,MAAM;YACnC,CAAC,CAAC,cAAc;YAChB,CAAC,CAAC,SAAS,CAAC;IAClB,WAAW,GACT,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,KAAK,MAAM;QAChD,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,KAAK,SAAS;QACjD,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC;QACvC,CAAC,CAAC,SAAS,CAAC;IAEhB,YAAY,GAAG,CAAC,CAAC;IACjB,cAAc,CAAkB;IAChC,kBAAkB,GAAa,EAAE,CAAC;IAClC,kBAAkB,GAAG,KAAK,CAAC;IAE3B,aAAa,GAAG;QACd,KAAK,EAAE,GAAG;QACV,MAAM,EAAE,GAAG;QACX,GAAG,EAAE,GAAG;KACT,CAAC;IAEF,eAAe,GAAG,GAAG,EAAE;QACrB,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,EAAE,CAAC;YAChC,MAAM,IAAI,GAAG,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YACzE,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACrB,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC;oBACjC,IAAI;oBACJ,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC;iBACjE,CAAC,CAAC;gBACH,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;YACjC,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjC,CAAC;YACD,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAClC,CAAC;QACD,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC;QAC9C,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACpD,CAAC,CAAC;IAEF;;;;;;;;;OASG;IACH,KAAK,CAAC,OAAe;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAe;QAClB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;;;;;OASG;IACH,IAAI,CAAC,OAAe;QAClB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrB,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,OAAe;QACnB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChB,CAAC;IAED;;;;;;;;;OASG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED;;;;;;;;;;OAUG;IACH,UAAU,CAAC,SAAkB;QAC3B,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,GAAG,SAAS,EAAE,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,IAAI,CAAC,KAAa,EAAE,MAA6B;QAC/C,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YAC3B,OAAO,EAAE,KAAK;YACd,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK;YACvB,OAAO,EAAE,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE;SACxD,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,GAAW,EAAE,MAA2B;QAC9C,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;YAC3B,OAAO,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE;YACpC,OAAO,EAAE,GAAG,EAAE,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE;YAC3C,OAAO,EAAE,GAAG,EAAE,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE;SAC1C,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,KAAK,CAAC,KAAa,EAAE,MAA6B;QACtD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CACb,yDAAyD,CAC1D,CAAC;QACJ,CAAC;QACD,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC7B,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC;QAED,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,YAAY,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;QACtE,IAAI,CAAC,YAAY,EAAE,CAAC;QAEpB,MAAM,YAAY,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAEhD,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QAEvC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAChC,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7C,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAE9B,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;YAClC,OAAO,CAAC,GAAG,CACT;gBACE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC;gBACxD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC;gBACrC,IAAI,CAAC,qBAAqB,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;aAC3C,CAAC,IAAI,CAAC,GAAG,CAAC,CACZ,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CACT;gBACE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC;gBACxD,IAAI,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,EAAE,KAAK,CAAC;aAC1C,CAAC,IAAI,CAAC,GAAG,CAAC,CACZ,CAAC;QACJ,CAAC;QAED,MAAM,SAAS,GAAG,YAAY,CAAC,GAAG,EAAE,CAAC;QACrC,IAAI,SAAS,EAAE,CAAC;YACd,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QACzB,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;QAC/B,IAAI,CAAC,OAAO,EAAE,CAAC;QAEf,IAAI,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YACjC,MAAM,MAAM,CAAC,MAAM,CAAC;QACtB,CAAC;IACH,CAAC;IAED,mBAAmB;QAIjB,QAAQ,IAAI,CAAC,WAAW,EAAE,CAAC;YACzB,KAAK,gBAAgB;gBACnB,0GAA0G;gBAC1G,OAAO;oBACL,KAAK,EAAE,KAAK,CAAC,EAAE,CACb,YAAY,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE;oBAChE,GAAG,EAAE,GAAG,EAAE,CAAC,cAAc;iBAC1B,CAAC;YACJ,KAAK,cAAc;gBACjB,wEAAwE;gBACxE,MAAM,WAAW,GAAG,SAAS,CAAC,CAAC,4EAA4E;gBAC3G,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAC/C,MAAM,SAAS,GAAG,0BAA0B,EAAE,EAAE,CAAC;gBACjD,OAAO;oBACL,KAAK,EAAE,KAAK,CAAC,EAAE;wBACb,MAAM,aAAa,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE;4BAClD,MAAM,EAAE,IAAI;yBACb,CAAC,CAAC;wBACH,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,kBAAkB,CAAC;wBAC1D,gIAAgI;wBAChI,OAAO,GAAG,WAAW,iBAAiB,mBAAmB,CAAC,IAAI,IAAI,EAAE,CAAC,IAAI,SAAS,GAAG,OAAO,KAAK,WAAW,GAAG,aAAa,EAAE,CAAC;oBACjI,CAAC;oBACD,GAAG,EAAE,GAAG,EAAE;oBACR,6FAA6F;oBAC7F,GAAG,WAAW,eAAe,mBAAmB,CAAC,IAAI,IAAI,EAAE,CAAC,IAAI,SAAS,KAAK,WAAW,EAAE;iBAC9F,CAAC;YACJ,KAAK,SAAS;gBACZ,OAAO;oBACL,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;oBAC/D,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE;iBACd,CAAC;QACN,CAAC;IACH,CAAC;IAED,iBAAiB,CAAC,KAAa,EAAE,OAA4B;QAC3D,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM;YACzB,CAAC,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,IAAI,KAAK,EAAE;YACxC,CAAC,CAAC,KAAK,CAAC;QACV,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,cAAc,CAAC,UAAkC;QAC/C,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,GAAG,UAAU,CAAC;QACrD,CAAC;aAAM,CAAC;YACN,OAAO,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,KAAK,CAAC,QAAQ,CACZ,MAAwB,EACxB,QAIC;QAED,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;QACJ,CAAC;QAED,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QACvD,OAAO,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAEpD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC;gBACxB,IAAI,EAAE,QAAQ,CAAC,OAAO;gBACtB,OAAO,EAAE,MAAM;gBACf,KAAK,EAAE,IAAI,CAAC,WAAW;aACxB,CAAC,CAAC;YACH,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;YACzD,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;YAC9B,CAAC;QACH,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;YAC5C,IAAI,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;QAEhC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAChC,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC;QAC7C,MAAM,GAAG,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAE9B,MAAM,IAAI,GACR,MAAM,CAAC,MAAM,KAAK,WAAW;YAC3B,CAAC,CAAC;gBACE,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC;gBAC9B,IAAI,CAAC,qBAAqB,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;aAC3C,CAAC,IAAI,CAAC,GAAG,CAAC;YACb,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAEtC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACrB,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC;oBACjC,IAAI;oBACJ,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC;iBACpE,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;oBAClC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACpC,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACjC,CAAC;YACH,CAAC;YACD,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC;QAClC,CAAC;QAED,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;QAChC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YACxC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;QAC7B,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAEvD,IAAI,MAAM,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YACjC,MAAM,MAAM,CAAC,MAAM,CAAC;QACtB,CAAC;IACH,CAAC;IAED,IAAI,CAAC,OAAe,EAAE,KAAkB;QACtC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,CAAC;gBACnC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;YAC7D,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QAC5C,CAAC;QACD,IAAI,CAAC,kBAAkB,GAAG,CAAC,OAAO,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED,OAAO,CAAC,OAAe,EAAE,KAA6B;QACpD,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,cAAc,EAAE,UAAU,EAAE,CAAC;YACzD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACxC,CAAC;QACD,OAAO,cAAc,CACnB,OAAO,EACP,IAAI,CAAC,EAAE,CACL,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAC5E,CAAC;IACJ,CAAC;IAED,SAAS,CAAC,IAAY,EAAE,KAA6B;QACnD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,qBAAqB,CAAC,EACpB,KAAK,EACL,GAAG,GAIJ;QACC,MAAM,QAAQ,GAAG,cAAc,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC;QAC7C,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,QAAQ,GAAG,CAAC,CAAC;IACrC,CAAC;CACF;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC"}

package/src/lib/promises.d.ts

@@ -3,3 +3,4 @@ export declare function groupByStatus<T>(results: PromiseSettledResult<T>[]): {
     rejected: PromiseRejectedResult[];
 };
 export declare function asyncSequential<TInput, TOutput>(items: TInput[], work: (item: TInput) => Promise<TOutput>): Promise<TOutput[]>;
+export declare function settlePromise<T>(promise: Promise<T>): Promise<PromiseSettledResult<T>>;

package/src/lib/promises.js

@@ -14,4 +14,13 @@ export async function asyncSequential(items, work) {
     }
     return results;
 }
+export async function settlePromise(promise) {
+    try {
+        const value = await promise;
+        return { status: 'fulfilled', value };
+    }
+    catch (error) {
+        return { status: 'rejected', reason: error };
+    }
+}
 //# sourceMappingURL=promises.js.map

package/src/lib/promises.js.map

@@ -1 +1 @@
-{"version":3,"file":"promises.js","sourceRoot":"","sources":["../../../src/lib/promises.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,aAAa,CAAI,OAAkC;IAIjE,OAAO,OAAO,CAAC,MAAM,CAInB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CACd,MAAM,CAAC,MAAM,KAAK,WAAW;QAC3B,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,SAAS,EAAE,CAAC,GAAG,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE;QACnD,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,CAAC,GAAG,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,EACrD,EAAE,SAAS,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAChC,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,KAAe,EACf,IAAwC;IAExC,kDAAkD;IAClD,MAAM,OAAO,GAAc,EAAE,CAAC;IAC9B,yDAAyD;IACzD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,qDAAqD;QACrD,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC"}
+{"version":3,"file":"promises.js","sourceRoot":"","sources":["../../../src/lib/promises.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,aAAa,CAAI,OAAkC;IAIjE,OAAO,OAAO,CAAC,MAAM,CAInB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CACd,MAAM,CAAC,MAAM,KAAK,WAAW;QAC3B,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,SAAS,EAAE,CAAC,GAAG,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE;QACnD,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,QAAQ,EAAE,CAAC,GAAG,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,EACrD,EAAE,SAAS,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,CAChC,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,KAAe,EACf,IAAwC;IAExC,kDAAkD;IAClD,MAAM,OAAO,GAAc,EAAE,CAAC;IAC9B,yDAAyD;IACzD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;QAChC,qDAAqD;QACrD,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,OAAmB;IAEnB,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC;QAC5B,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;IACxC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;IAC/C,CAAC;AACH,CAAC"}