@code-pushup/utils 0.56.0 → 0.58.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.56.0",
+  "version": "0.58.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",
@@ -23,10 +23,11 @@
     "access": "public"
   },
   "type": "module",
-  "main": "./index.js",
-  "types": "./src/index.d.ts",
+  "engines": {
+    "node": ">=17.0.0"
+  },
   "dependencies": {
-    "@code-pushup/models": "0.56.0",
+    "@code-pushup/models": "0.58.0",
     "@isaacs/cliui": "^8.0.2",
     "@poppinss/cliui": "^6.4.0",
     "ansis": "^3.3.0",
@@ -35,6 +36,11 @@
     "esbuild": "^0.19.2",
     "multi-progress-bars": "^5.0.3",
     "semver": "^7.6.0",
-    "simple-git": "^3.20.0"
-  }
-}
+    "simple-git": "^3.20.0",
+    "zod": "^3.23.8",
+    "zod-validation-error": "^3.4.0"
+  },
+  "module": "./src/index.js",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts"
+}

package/src/index.d.ts

@@ -1,30 +1,32 @@
 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, findNearestFile, 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';
-export { getCurrentBranchOrTag, getHashFromTag, getHashes, getLatestCommit, getSemverTags, type LogResult, } from './lib/git/git.commits-and-tags';
-export { groupByStatus } from './lib/group-by-status';
-export { isPromiseFulfilledResult, isPromiseRejectedResult, } from './lib/guards';
-export { logMultipleResults } from './lib/log-results';
-export { link, ui, type CliUi, type Column } from './lib/logging';
-export { mergeConfigs } from './lib/merge-configs';
-export { getProgressBar, type ProgressBar } from './lib/progress';
-export { CODE_PUSHUP_DOMAIN, CODE_PUSHUP_UNICODE_LOGO, FOOTER_PREFIX, README_LINK, TERMINAL_WIDTH, } from './lib/reports/constants';
-export { listAuditsFromAllPlugins, listGroupsFromAllPlugins, } from './lib/reports/flatten-plugins';
-export { generateMdReport } from './lib/reports/generate-md-report';
-export { generateMdReportsDiff, generateMdReportsDiffForMonorepo, } from './lib/reports/generate-md-reports-diff';
-export { loadReport } from './lib/reports/load-report';
-export { logStdoutSummary } from './lib/reports/log-stdout-summary';
-export { scoreReport } from './lib/reports/scoring';
-export { sortReport } from './lib/reports/sorting';
-export type { ScoredCategoryConfig, ScoredGroup, ScoredReport, } from './lib/reports/types';
-export { calcDuration, compareIssueSeverity, formatReportScore, } from './lib/reports/utils';
-export { isSemver, normalizeSemver, sortSemvers } from './lib/semver';
-export * from './lib/text-formats';
-export { capitalize, countOccurrences, distinct, factorOf, fromJsonLines, objectFromEntries, objectToCliArgs, objectToEntries, objectToKeys, toArray, toJsonLines, toNumberPrecision, toOrdinal, toUnixNewlines, toUnixPath, type CliArgsObject, } from './lib/transform';
-export type { ExcludeNullFromPropertyTypes, ExtractArray, ExtractArrays, ItemOrArray, Prettify, WithRequired, } from './lib/types';
-export { verboseUtils } from './lib/verbose-utils';
+export { comparePairs, matchArrayItemsByKey, type Diff } from './lib/diff.js';
+export { stringifyError } from './lib/errors.js';
+export { ProcessError, executeProcess, type ProcessConfig, type ProcessObserver, type ProcessResult, } from './lib/execute-process.js';
+export { crawlFileSystem, 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 { getCurrentBranchOrTag, getHashFromTag, getHashes, getLatestCommit, getSemverTags, type LogResult, } from './lib/git/git.commits-and-tags.js';
+export { formatGitPath, getGitRoot, guardAgainstLocalChanges, safeCheckout, toGitPath, } from './lib/git/git.js';
+export { groupByStatus } from './lib/group-by-status.js';
+export { isPromiseFulfilledResult, isPromiseRejectedResult, hasNoNullableProps, } from './lib/guards.js';
+export { logMultipleResults } from './lib/log-results.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 { 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';
+export { generateMdReport } from './lib/reports/generate-md-report.js';
+export { generateMdReportsDiff, generateMdReportsDiffForMonorepo, } from './lib/reports/generate-md-reports-diff.js';
+export { loadReport } from './lib/reports/load-report.js';
+export { logStdoutSummary } from './lib/reports/log-stdout-summary.js';
+export { scoreReport } from './lib/reports/scoring.js';
+export { sortReport } from './lib/reports/sorting.js';
+export type { ScoredCategoryConfig, ScoredGroup, ScoredReport, } from './lib/reports/types.js';
+export { calcDuration, compareIssueSeverity, formatReportScore, } from './lib/reports/utils.js';
+export { isSemver, normalizeSemver, sortSemvers } from './lib/semver.js';
+export * from './lib/text-formats/index.js';
+export { capitalize, countOccurrences, distinct, factorOf, fromJsonLines, objectFromEntries, objectToCliArgs, objectToEntries, objectToKeys, toArray, toJsonLines, toNumberPrecision, toOrdinal, toUnixNewlines, toUnixPath, type CliArgsObject, } from './lib/transform.js';
+export type { ExcludeNullableProps, ExtractArray, ExtractArrays, ItemOrArray, Prettify, WithRequired, } from './lib/types.js';
+export { verboseUtils } from './lib/verbose-utils.js';
+export { parseSchema, SchemaValidationError } from './lib/zod-validation.js';
+export { createRunnerFiles } from './lib/create-runner-files.js';

package/src/index.js

@@ -0,0 +1,31 @@
+export { exists } from '@code-pushup/models';
+export { comparePairs, matchArrayItemsByKey } from './lib/diff.js';
+export { stringifyError } from './lib/errors.js';
+export { ProcessError, executeProcess, } from './lib/execute-process.js';
+export { crawlFileSystem, 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 { getCurrentBranchOrTag, getHashFromTag, getHashes, getLatestCommit, getSemverTags, } from './lib/git/git.commits-and-tags.js';
+export { formatGitPath, getGitRoot, guardAgainstLocalChanges, safeCheckout, toGitPath, } from './lib/git/git.js';
+export { groupByStatus } from './lib/group-by-status.js';
+export { isPromiseFulfilledResult, isPromiseRejectedResult, hasNoNullableProps, } from './lib/guards.js';
+export { logMultipleResults } from './lib/log-results.js';
+export { link, ui } from './lib/logging.js';
+export { mergeConfigs } from './lib/merge-configs.js';
+export { getProgressBar } from './lib/progress.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';
+export { generateMdReport } from './lib/reports/generate-md-report.js';
+export { generateMdReportsDiff, generateMdReportsDiffForMonorepo, } from './lib/reports/generate-md-reports-diff.js';
+export { loadReport } from './lib/reports/load-report.js';
+export { logStdoutSummary } from './lib/reports/log-stdout-summary.js';
+export { scoreReport } from './lib/reports/scoring.js';
+export { sortReport } from './lib/reports/sorting.js';
+export { calcDuration, compareIssueSeverity, formatReportScore, } from './lib/reports/utils.js';
+export { isSemver, normalizeSemver, sortSemvers } from './lib/semver.js';
+export * from './lib/text-formats/index.js';
+export { capitalize, countOccurrences, distinct, factorOf, fromJsonLines, objectFromEntries, objectToCliArgs, objectToEntries, objectToKeys, toArray, toJsonLines, toNumberPrecision, toOrdinal, toUnixNewlines, toUnixPath, } from './lib/transform.js';
+export { verboseUtils } from './lib/verbose-utils.js';
+export { parseSchema, SchemaValidationError } from './lib/zod-validation.js';
+export { createRunnerFiles } from './lib/create-runner-files.js';
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/utils/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAa,MAAM,eAAe,CAAC;AAC9E,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EACL,YAAY,EACZ,cAAc,GAIf,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,eAAe,EACf,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,cAAc,EACd,SAAS,EACT,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,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,EACL,wBAAwB,EACxB,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,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,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,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,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,UAAU,EACV,gBAAgB,EAChB,QAAQ,EACR,QAAQ,EACR,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,YAAY,EACZ,OAAO,EACP,WAAW,EACX,iBAAiB,EACjB,SAAS,EACT,cAAc,EACd,UAAU,GAEX,MAAM,oBAAoB,CAAC;AAS5B,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAC7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC"}

package/src/lib/create-runner-files.d.ts

@@ -0,0 +1,8 @@
+import type { RunnerFilesPaths } from '@code-pushup/models';
+/**
+ * Function to create timestamp nested plugin runner files for config and output.
+ *
+ * @param pluginSlug - slug of the plugin name used as folder names to group same plugin configs
+ * @param configJSON - config of the plugin runner as JSON.
+ */
+export declare function createRunnerFiles(pluginSlug: string, configJSON: string): Promise<RunnerFilesPaths>;

package/src/lib/create-runner-files.js

@@ -0,0 +1,22 @@
+import { writeFile } from 'node:fs/promises';
+import path from 'node:path';
+import { ensureDirectoryExists, pluginWorkDir } from './file-system.js';
+/**
+ * Function to create timestamp nested plugin runner files for config and output.
+ *
+ * @param pluginSlug - slug of the plugin name used as folder names to group same plugin configs
+ * @param configJSON - config of the plugin runner as JSON.
+ */
+export async function createRunnerFiles(pluginSlug, configJSON) {
+    const timestamp = Date.now().toString();
+    const runnerWorkDir = path.join(pluginWorkDir(pluginSlug), timestamp);
+    const runnerConfigPath = path.join(runnerWorkDir, 'plugin-config.json');
+    const runnerOutputPath = path.join(runnerWorkDir, 'runner-output.json');
+    await ensureDirectoryExists(path.dirname(runnerOutputPath));
+    await writeFile(runnerConfigPath, configJSON);
+    return {
+        runnerConfigPath,
+        runnerOutputPath,
+    };
+}
+//# sourceMappingURL=create-runner-files.js.map

package/src/lib/create-runner-files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-runner-files.js","sourceRoot":"","sources":["../../../../../packages/utils/src/lib/create-runner-files.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAExE;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,UAAkB,EAClB,UAAkB;IAElB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IACxC,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC,EAAE,SAAS,CAAC,CAAC;IACtE,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,oBAAoB,CAAC,CAAC;IACxE,MAAM,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,oBAAoB,CAAC,CAAC;IAExE,MAAM,qBAAqB,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC5D,MAAM,SAAS,CAAC,gBAAgB,EAAE,UAAU,CAAC,CAAC;IAE9C,OAAO;QACL,gBAAgB;QAChB,gBAAgB;KACjB,CAAC;AACJ,CAAC"}

package/src/lib/diff.js

@@ -0,0 +1,38 @@
+export function matchArrayItemsByKey({ before, after, key, }) {
+    const pairs = [];
+    const added = [];
+    const afterKeys = new Set();
+    const keyFn = typeof key === 'function' ? key : (item) => item[key];
+    // eslint-disable-next-line functional/no-loop-statements
+    for (const afterItem of after) {
+        const afterKey = keyFn(afterItem);
+        afterKeys.add(afterKey);
+        const match = before.find(beforeItem => keyFn(beforeItem) === afterKey);
+        if (match) {
+            // eslint-disable-next-line functional/immutable-data
+            pairs.push({ before: match, after: afterItem });
+        }
+        else {
+            // eslint-disable-next-line functional/immutable-data
+            added.push(afterItem);
+        }
+    }
+    const removed = before.filter(beforeItem => !afterKeys.has(keyFn(beforeItem)));
+    return {
+        pairs,
+        added,
+        removed,
+    };
+}
+export function comparePairs(pairs, equalsFn) {
+    return pairs.reduce((acc, pair) => ({
+        ...acc,
+        ...(equalsFn(pair)
+            ? { unchanged: [...acc.unchanged, pair.after] }
+            : { changed: [...acc.changed, pair] }),
+    }), {
+        changed: [],
+        unchanged: [],
+    });
+}
+//# sourceMappingURL=diff.js.map

package/src/lib/diff.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diff.js","sourceRoot":"","sources":["../../../../../packages/utils/src/lib/diff.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,oBAAoB,CAAI,EACtC,MAAM,EACN,KAAK,EACL,GAAG,GACmD;IACtD,MAAM,KAAK,GAAc,EAAE,CAAC;IAC5B,MAAM,KAAK,GAAQ,EAAE,CAAC;IAEtB,MAAM,SAAS,GAAG,IAAI,GAAG,EAAW,CAAC;IACrC,MAAM,KAAK,GAAG,OAAO,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAO,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAEvE,yDAAyD;IACzD,KAAK,MAAM,SAAS,IAAI,KAAK,EAAE,CAAC;QAC9B,MAAM,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;QAClC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAExB,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,KAAK,QAAQ,CAAC,CAAC;QACxE,IAAI,KAAK,EAAE,CAAC;YACV,qDAAqD;YACrD,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,qDAAqD;YACrD,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAC3B,UAAU,CAAC,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAChD,CAAC;IAEF,OAAO;QACL,KAAK;QACL,KAAK;QACL,OAAO;KACR,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,KAAgB,EAChB,QAAoC;IAEpC,OAAO,KAAK,CAAC,MAAM,CACjB,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QACd,GAAG,GAAG;QACN,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC;YAChB,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,GAAG,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE;YAC/C,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;KACzC,CAAC,EACF;QACE,OAAO,EAAE,EAAE;QACX,SAAS,EAAE,EAAE;KACd,CACF,CAAC;AACJ,CAAC"}

package/src/lib/errors.js

@@ -0,0 +1,14 @@
+export function stringifyError(error) {
+    // TODO: special handling for ZodError instances
+    if (error instanceof Error) {
+        if (error.name === 'Error' || error.message.startsWith(error.name)) {
+            return error.message;
+        }
+        return `${error.name}: ${error.message}`;
+    }
+    if (typeof error === 'string') {
+        return error;
+    }
+    return JSON.stringify(error);
+}
+//# sourceMappingURL=errors.js.map

package/src/lib/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../../../packages/utils/src/lib/errors.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,gDAAgD;IAChD,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;YACnE,OAAO,KAAK,CAAC,OAAO,CAAC;QACvB,CAAC;QACD,OAAO,GAAG,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;IAC3C,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC"}

package/src/lib/execute-process.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { type ChildProcess, type SpawnOptionsWithStdioTuple, type StdioPipe } from 'node:child_process';
 /**
  * Represents the process result.

package/src/lib/execute-process.js

@@ -0,0 +1,105 @@
+import { gray } from 'ansis';
+import { spawn, } from 'node:child_process';
+import { ui } from './logging.js';
+import { calcDuration } from './reports/utils.js';
+/**
+ * Error class for process errors.
+ * Contains additional information about the process result.
+ * @category Error
+ * @public
+ * @class
+ * @extends Error
+ * @example
+ * const result = await executeProcess({})
+ * .catch((error) => {
+ *   if (error instanceof ProcessError) {
+ *   console.error(error.code);
+ *   console.error(error.stderr);
+ *   console.error(error.stdout);
+ *   }
+ * });
+ *
+ */
+export class ProcessError extends Error {
+    code;
+    stderr;
+    stdout;
+    constructor(result) {
+        super(result.stderr);
+        this.code = result.code;
+        this.stderr = result.stderr;
+        this.stdout = result.stdout;
+    }
+}
+/**
+ * Executes a process and returns a promise with the result as `ProcessResult`.
+ *
+ * @example
+ *
+ * // sync process execution
+ * const result = await executeProcess({
+ *  command: 'node',
+ *  args: ['--version']
+ * });
+ *
+ * console.info(result);
+ *
+ * // async process execution
+ * const result = await executeProcess({
+ *    command: 'node',
+ *    args: ['download-data.js'],
+ *    observer: {
+ *      onStdout: updateProgress,
+ *      error: handleError,
+ *      complete: cleanLogs,
+ *    }
+ * });
+ *
+ * console.info(result);
+ *
+ * @param cfg - see {@link ProcessConfig}
+ */
+export function executeProcess(cfg) {
+    const { command, args, observer, ignoreExitCode = false, ...options } = cfg;
+    const { onStdout, onStderr, onError, onComplete } = observer ?? {};
+    const date = new Date().toISOString();
+    const start = performance.now();
+    const logCommand = [command, ...(args || [])].join(' ');
+    ui().logger.log(gray(`Executing command:\n${logCommand}\nIn working directory:\n${cfg.cwd}`));
+    return new Promise((resolve, reject) => {
+        // shell:true tells Windows to use shell command for spawning a child process
+        const spawnedProcess = spawn(command, args ?? [], {
+            shell: true,
+            windowsHide: true,
+            ...options,
+        });
+        // eslint-disable-next-line functional/no-let
+        let stdout = '';
+        // eslint-disable-next-line functional/no-let
+        let stderr = '';
+        spawnedProcess.stdout.on('data', data => {
+            stdout += String(data);
+            onStdout?.(String(data), spawnedProcess);
+        });
+        spawnedProcess.stderr.on('data', data => {
+            stderr += String(data);
+            onStderr?.(String(data), spawnedProcess);
+        });
+        spawnedProcess.on('error', err => {
+            stderr += err.toString();
+        });
+        spawnedProcess.on('close', code => {
+            const timings = { date, duration: calcDuration(start) };
+            if (code === 0 || ignoreExitCode) {
+                onComplete?.();
+                resolve({ code, stdout, stderr, ...timings });
+            }
+            else {
+                const errorMsg = new ProcessError({ code, stdout, stderr, ...timings });
+                onError?.(errorMsg);
+                reject(errorMsg);
+            }
+        });
+    });
+}
+//# sourceMappingURL=execute-process.js.map

package/src/lib/execute-process.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"execute-process.js","sourceRoot":"","sources":["../../../../../packages/utils/src/lib/execute-process.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAC7B,OAAO,EAKL,KAAK,GACN,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAE,EAAE,EAAE,MAAM,cAAc,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAkBlD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAO,YAAa,SAAQ,KAAK;IACrC,IAAI,CAAgB;IACpB,MAAM,CAAS;IACf,MAAM,CAAS;IAEf,YAAY,MAAqB;QAC/B,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9B,CAAC;CACF;AA6DD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,UAAU,cAAc,CAAC,GAAkB;IAC/C,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,cAAc,GAAG,KAAK,EAAE,GAAG,OAAO,EAAE,GAAG,GAAG,CAAC;IAC5E,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,QAAQ,IAAI,EAAE,CAAC;IACnE,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;IACtC,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAEhC,MAAM,UAAU,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxD,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,CACb,IAAI,CACF,uBAAuB,UAAU,4BAA4B,GAAG,CAAC,GAAG,EAAE,CACvE,CACF,CAAC;IAEF,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,6EAA6E;QAC7E,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,EAAE,IAAI,IAAI,EAAE,EAAE;YAChD,KAAK,EAAE,IAAI;YACX,WAAW,EAAE,IAAI;YACjB,GAAG,OAAO;SACX,CAAsD,CAAC;QAExD,6CAA6C;QAC7C,IAAI,MAAM,GAAG,EAAE,CAAC;QAChB,6CAA6C;QAC7C,IAAI,MAAM,GAAG,EAAE,CAAC;QAEhB,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;YACtC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;YACvB,QAAQ,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,cAAc,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;YACtC,MAAM,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC;YACvB,QAAQ,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,cAAc,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE;YAC/B,MAAM,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,cAAc,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;YAChC,MAAM,OAAO,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;YACxD,IAAI,IAAI,KAAK,CAAC,IAAI,cAAc,EAAE,CAAC;gBACjC,UAAU,EAAE,EAAE,CAAC;gBACf,OAAO,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;YAChD,CAAC;iBAAM,CAAC;gBACN,MAAM,QAAQ,GAAG,IAAI,YAAY,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;gBACxE,OAAO,EAAE,CAAC,QAAQ,CAAC,CAAC;gBACpB,MAAM,CAAC,QAAQ,CAAC,CAAC;YACnB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}

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

@@ -1,8 +1,8 @@
 import { type Options } from 'bundle-require';
-export declare function readTextFile(path: string): Promise<string>;
-export declare function readJsonFile<T = unknown>(path: string): Promise<T>;
-export declare function fileExists(path: string): Promise<boolean>;
-export declare function directoryExists(path: string): Promise<boolean>;
+export declare function readTextFile(filePath: string): Promise<string>;
+export declare function readJsonFile<T = unknown>(filePath: string): Promise<T>;
+export declare function fileExists(filePath: string): Promise<boolean>;
+export declare function directoryExists(filePath: string): Promise<boolean>;
 export declare function ensureDirectoryExists(baseDir: string): Promise<void>;
 export declare function removeDirectoryIfExists(dir: string): Promise<void>;
 export type FileResult = readonly [string] | readonly [string, number];
@@ -18,5 +18,5 @@ export type CrawlFileSystemOptions<T> = {
 export declare function crawlFileSystem<T = string>(options: CrawlFileSystemOptions<T>): Promise<T[]>;
 export declare function findNearestFile(fileNames: string[], cwd?: string): Promise<string | undefined>;
 export declare function findLineNumberInText(content: string, pattern: string): number | null;
-export declare function filePathToCliArg(path: string): string;
+export declare function filePathToCliArg(filePath: string): string;
 export declare function projectToFilename(project: string): string;

package/src/lib/file-system.js

@@ -0,0 +1,113 @@
+import { bold, gray } from 'ansis';
+import { bundleRequire } from 'bundle-require';
+import { mkdir, readFile, readdir, rm, stat } from 'node:fs/promises';
+import path from 'node:path';
+import { formatBytes } from './formatting.js';
+import { logMultipleResults } from './log-results.js';
+import { ui } from './logging.js';
+export async function readTextFile(filePath) {
+    const buffer = await readFile(filePath);
+    return buffer.toString();
+}
+export async function readJsonFile(filePath) {
+    const text = await readTextFile(filePath);
+    return JSON.parse(text);
+}
+export async function fileExists(filePath) {
+    try {
+        const stats = await stat(filePath);
+        return stats.isFile();
+    }
+    catch {
+        return false;
+    }
+}
+export async function directoryExists(filePath) {
+    try {
+        const stats = await stat(filePath);
+        return stats.isDirectory();
+    }
+    catch {
+        return false;
+    }
+}
+export async function ensureDirectoryExists(baseDir) {
+    try {
+        await mkdir(baseDir, { recursive: true });
+        return;
+    }
+    catch (error) {
+        ui().logger.info(error.message);
+        if (error.code !== 'EEXIST') {
+            throw error;
+        }
+    }
+}
+export async function removeDirectoryIfExists(dir) {
+    if (await directoryExists(dir)) {
+        await rm(dir, { recursive: true, force: true });
+    }
+}
+export function logMultipleFileResults(fileResults, messagePrefix) {
+    const succeededTransform = (result) => {
+        const [fileName, size] = result.value;
+        const formattedSize = size ? ` (${gray(formatBytes(size))})` : '';
+        return `- ${bold(fileName)}${formattedSize}`;
+    };
+    const failedTransform = (result) => `- ${bold(result.reason)}`;
+    logMultipleResults(fileResults, messagePrefix, succeededTransform, failedTransform);
+}
+export async function importModule(options) {
+    const { mod } = await bundleRequire(options);
+    if (typeof mod === 'object' && 'default' in mod) {
+        return mod.default;
+    }
+    return mod;
+}
+export function pluginWorkDir(slug) {
+    return path.join('node_modules', '.code-pushup', slug);
+}
+export async function crawlFileSystem(options) {
+    const { directory, pattern, fileTransform = (filePath) => filePath, } = options;
+    const files = await readdir(directory);
+    const promises = files.map(async (file) => {
+        const filePath = path.join(directory, file);
+        const stats = await stat(filePath);
+        if (stats.isDirectory()) {
+            return crawlFileSystem({ directory: filePath, pattern, fileTransform });
+        }
+        if (stats.isFile() && (!pattern || new RegExp(pattern).test(file))) {
+            return fileTransform(filePath);
+        }
+        return [];
+    });
+    const resultsNestedArray = await Promise.all(promises);
+    return resultsNestedArray.flat();
+}
+export async function findNearestFile(fileNames, cwd = process.cwd()) {
+    // eslint-disable-next-line functional/no-loop-statements
+    for (
+    // eslint-disable-next-line functional/no-let
+    let directory = cwd; directory !== path.dirname(directory); directory = path.dirname(directory)) {
+        // eslint-disable-next-line functional/no-loop-statements
+        for (const file of fileNames) {
+            if (await fileExists(path.join(directory, file))) {
+                return path.join(directory, file);
+            }
+        }
+    }
+    return undefined;
+}
+export function findLineNumberInText(content, pattern) {
+    const lines = content.split(/\r?\n/); // Split lines, handle both Windows and UNIX line endings
+    const lineNumber = lines.findIndex(line => line.includes(pattern)) + 1; // +1 because line numbers are 1-based
+    return lineNumber === 0 ? null : lineNumber; // If the package isn't found, return null
+}
+export function filePathToCliArg(filePath) {
+    // needs to be escaped if spaces included
+    return `"${filePath}"`;
+}
+export function projectToFilename(project) {
+    return project.replace(/[/\\\s]+/g, '-').replace(/@/g, '');
+}
+//# sourceMappingURL=file-system.js.map

package/src/lib/file-system.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-system.js","sourceRoot":"","sources":["../../../../../packages/utils/src/lib/file-system.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AACnC,OAAO,EAAgB,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AACtE,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,EAAE,EAAE,EAAE,MAAM,cAAc,CAAC;AAElC,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,QAAgB;IACjD,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACxC,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;AAC3B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAc,QAAgB;IAC9D,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,QAAQ,CAAC,CAAC;IAC1C,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAM,CAAC;AAC/B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,UAAU,CAAC,QAAgB;IAC/C,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnC,OAAO,KAAK,CAAC,MAAM,EAAE,CAAC;IACxB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CAAC,QAAgB;IACpD,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;QACnC,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC;IAC7B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,OAAe;IACzD,IAAI,CAAC;QACH,MAAM,KAAK,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1C,OAAO;IACT,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAE,KAA2C,CAAC,OAAO,CAAC,CAAC;QACvE,IAAK,KAA0B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAClD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,GAAW;IACvD,IAAI,MAAM,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;QAC/B,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IAClD,CAAC;AACH,CAAC;AAKD,MAAM,UAAU,sBAAsB,CACpC,WAAgC,EAChC,aAAqB;IAErB,MAAM,kBAAkB,GAAG,CAAC,MAA0C,EAAE,EAAE;QACxE,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;QACtC,MAAM,aAAa,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAClE,OAAO,KAAK,IAAI,CAAC,QAAQ,CAAC,GAAG,aAAa,EAAE,CAAC;IAC/C,CAAC,CAAC;IACF,MAAM,eAAe,GAAG,CAAC,MAA6B,EAAE,EAAE,CACxD,KAAK,IAAI,CAAC,MAAM,CAAC,MAAgB,CAAC,EAAE,CAAC;IAEvC,kBAAkB,CAChB,WAAW,EACX,aAAa,EACb,kBAAkB,EAClB,eAAe,CAChB,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAAc,OAAgB;IAC9D,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,aAAa,CAAS,OAAO,CAAC,CAAC;IAErD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,SAAS,IAAI,GAAG,EAAE,CAAC;QAChD,OAAO,GAAG,CAAC,OAAY,CAAC;IAC1B,CAAC;IACD,OAAO,GAAQ,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,IAAY;IACxC,OAAO,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;AACzD,CAAC;AAOD,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,OAAkC;IAElC,MAAM,EACJ,SAAS,EACT,OAAO,EACP,aAAa,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,QAAa,GACpD,GAAG,OAAO,CAAC;IAEZ,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,CAAC;IACvC,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAoB,EAAE;QAC1D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC5C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEnC,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;YACxB,OAAO,eAAe,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC,CAAC;QAC1E,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,OAAO,IAAI,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACnE,OAAO,aAAa,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC,CAAC;IAEH,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IACvD,OAAO,kBAAkB,CAAC,IAAI,EAAS,CAAC;AAC1C,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,SAAmB,EACnB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE;IAEnB,yDAAyD;IACzD;IACE,6CAA6C;IAC7C,IAAI,SAAS,GAAG,GAAG,EACnB,SAAS,KAAK,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EACrC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EACnC,CAAC;QACD,yDAAyD;QACzD,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;YAC7B,IAAI,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;gBACjD,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACpC,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,OAAe,EACf,OAAe;IAEf,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,yDAAyD;IAE/F,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,sCAAsC;IAC9G,OAAO,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,0CAA0C;AACzF,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,QAAgB;IAC/C,yCAAyC;IACzC,OAAO,IAAI,QAAQ,GAAG,CAAC;AACzB,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,OAAe;IAC/C,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAC7D,CAAC"}

package/src/lib/filter.js

@@ -0,0 +1,10 @@
+export function filterItemRefsBy(items, refFilterFn) {
+    return (items
+        .map(item => ({
+        ...item,
+        refs: item.refs.filter(refFilterFn),
+    }))
+        // remove item with empty refs
+        .filter(item => item.refs.length));
+}
+//# sourceMappingURL=filter.js.map

package/src/lib/filter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filter.js","sourceRoot":"","sources":["../../../../../packages/utils/src/lib/filter.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,gBAAgB,CAC9B,KAAU,EACV,WAAiD;IAEjD,OAAO,CACL,KAAK;SACF,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACZ,GAAG,IAAI;QACP,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;KACpC,CAAC,CAAC;QACH,8BAA8B;SAC7B,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CACpC,CAAC;AACJ,CAAC"}

package/src/lib/formatting.js

@@ -0,0 +1,83 @@
+import { MAX_DESCRIPTION_LENGTH, MAX_ISSUE_MESSAGE_LENGTH, MAX_TITLE_LENGTH, } from '@code-pushup/models';
+export function slugify(text) {
+    return text
+        .trim()
+        .toLowerCase()
+        .replace(/\s+|\//g, '-')
+        .replace(/[^a-z\d-]/g, '');
+}
+export function pluralize(text, amount) {
+    if (amount != null && Math.abs(amount) === 1) {
+        return text;
+    }
+    if (text.endsWith('y')) {
+        return `${text.slice(0, -1)}ies`;
+    }
+    if (text.endsWith('s')) {
+        return `${text}es`;
+    }
+    return `${text}s`;
+}
+export function formatBytes(bytes, decimals = 2) {
+    const positiveBytes = Math.max(bytes, 0);
+    // early exit
+    if (positiveBytes === 0) {
+        return '0 B';
+    }
+    const k = 1024;
+    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]}`;
+}
+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`;
+    }
+    return `${(duration / 1000).toFixed(2)} s`;
+}
+export function formatDate(date) {
+    const locale = 'en-US'; // fixed locale to ensure consistency across local defaults execution
+    return date
+        .toLocaleString(locale, {
+        weekday: 'short',
+        month: 'short',
+        day: 'numeric',
+        year: 'numeric',
+        hour: 'numeric',
+        minute: '2-digit',
+        timeZoneName: 'short',
+    })
+        .replace(/\u202F/g, ' '); // see https://github.com/nodejs/node/issues/45171
+}
+export function truncateText(text, options) {
+    const { maxChars, position = 'end', ellipsis = '...', } = typeof options === 'number' ? { maxChars: options } : options;
+    if (text.length <= maxChars) {
+        return text;
+    }
+    const maxLength = maxChars - ellipsis.length;
+    switch (position) {
+        case 'start':
+            return ellipsis + text.slice(-maxLength).trim();
+        case 'middle':
+            const halfMaxChars = Math.floor(maxLength / 2);
+            return (text.slice(0, halfMaxChars).trim() +
+                ellipsis +
+                text.slice(-halfMaxChars).trim());
+        case 'end':
+            return text.slice(0, maxLength).trim() + ellipsis;
+    }
+}
+export function truncateTitle(text) {
+    return truncateText(text, MAX_TITLE_LENGTH);
+}
+export function truncateDescription(text) {
+    return truncateText(text, MAX_DESCRIPTION_LENGTH);
+}
+export function truncateIssueMessage(text) {
+    return truncateText(text, MAX_ISSUE_MESSAGE_LENGTH);
+}
+//# sourceMappingURL=formatting.js.map

package/src/lib/formatting.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"formatting.js","sourceRoot":"","sources":["../../../../../packages/utils/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"}