@code-pushup/utils 0.54.0 → 0.56.0

package/index.js

@@ -29,7 +29,7 @@ function exists(value) {
   return value != null;
 }
 function getMissingRefsForCategories(categories, plugins) {
-  if (categories.length === 0) {
+  if (!categories || categories.length === 0) {
     return false;
   }
   const auditRefsFromCategory = categories.flatMap(
@@ -528,12 +528,9 @@ var unrefinedCoreConfigSchema = z14.object({
 var coreConfigSchema = refineCoreConfig(unrefinedCoreConfigSchema);
 function refineCoreConfig(schema) {
   return schema.refine(
-    (coreCfg) => !getMissingRefsForCategories(coreCfg.categories ?? [], coreCfg.plugins),
-    (coreCfg) => ({
-      message: missingRefsForCategoriesErrorMsg(
-        coreCfg.categories ?? [],
-        coreCfg.plugins
-      )
+    ({ categories, plugins }) => !getMissingRefsForCategories(categories, plugins),
+    ({ categories, plugins }) => ({
+      message: missingRefsForCategoriesErrorMsg(categories, plugins)
     })
   );
 }
@@ -585,19 +582,16 @@ var reportSchema = packageVersionSchema({
 ).merge(
   z15.object(
     {
-      categories: z15.array(categoryConfigSchema),
       plugins: z15.array(pluginReportSchema).min(1),
+      categories: z15.array(categoryConfigSchema).optional(),
       commit: commitSchema.describe("Git commit for which report was collected").nullable()
     },
     { description: "Collect output data" }
   )
 ).refine(
-  (report) => !getMissingRefsForCategories(report.categories, report.plugins),
-  (report) => ({
-    message: missingRefsForCategoriesErrorMsg(
-      report.categories,
-      report.plugins
-    )
+  ({ categories, plugins }) => !getMissingRefsForCategories(categories, plugins),
+  ({ categories, plugins }) => ({
+    message: missingRefsForCategoriesErrorMsg(categories, plugins)
   })
 );
 
@@ -1030,7 +1024,7 @@ function executeProcess(cfg) {
 import { bold, gray } from "ansis";
 import { bundleRequire } from "bundle-require";
 import { mkdir, readFile, readdir, rm, stat } from "node:fs/promises";
-import { join } from "node:path";
+import { dirname, join } from "node:path";
 
 // packages/utils/src/lib/formatting.ts
 function slugify(text) {
@@ -1267,6 +1261,16 @@ async function crawlFileSystem(options) {
   const resultsNestedArray = await Promise.all(promises);
   return resultsNestedArray.flat();
 }
+async function findNearestFile(fileNames, cwd = process.cwd()) {
+  for (let directory = cwd; directory !== dirname(directory); directory = dirname(directory)) {
+    for (const file of fileNames) {
+      if (await fileExists(join(directory, file))) {
+        return join(directory, file);
+      }
+    }
+  }
+  return void 0;
+}
 function findLineNumberInText(content, pattern) {
   const lines = content.split(/\r?\n/);
   const lineNumber = lines.findIndex((line) => line.includes(pattern)) + 1;
@@ -2097,7 +2101,7 @@ function getSortableGroupByRef({ plugin, slug, weight }, plugins) {
 }
 function sortReport(report) {
   const { categories, plugins } = report;
-  const sortedCategories = categories.map((category) => {
+  const sortedCategories = categories?.map((category) => {
     const { audits, groups } = category.refs.reduce(
       (acc, ref) => ({
         ...acc,
@@ -2237,14 +2241,15 @@ function auditDetailsAuditValue({
     String(displayValue ?? value)
   )} (score: ${formatReportScore(score)})`;
 }
+function hasCategories(report) {
+  return !!report.categories && report.categories.length > 0;
+}
 function generateMdReport(report, options) {
-  return new MarkdownDocument3().heading(HIERARCHY.level_1, REPORT_HEADLINE_TEXT).$if(
-    report.categories.length > 0,
-    (doc) => doc.$concat(
-      categoriesOverviewSection(report),
-      categoriesDetailsSection(report)
-    )
-  ).$concat(auditsSection(report, options), aboutSection(report)).rule().paragraph(md4`${FOOTER_PREFIX} ${md4.link(README_LINK, "Code PushUp")}`).toString();
+  return new MarkdownDocument3().heading(HIERARCHY.level_1, REPORT_HEADLINE_TEXT).$concat(
+    ...hasCategories(report) ? [categoriesOverviewSection(report), categoriesDetailsSection(report)] : [],
+    auditsSection(report, options),
+    aboutSection(report)
+  ).rule().paragraph(md4`${FOOTER_PREFIX} ${md4.link(README_LINK, "Code PushUp")}`).toString();
 }
 function auditDetailsIssues(issues = [], options) {
   if (issues.length === 0) {
@@ -2346,7 +2351,7 @@ function reportMetaTable({
         md4.code(version),
         formatDuration(duration),
         plugins.length.toString(),
-        categories.length.toString(),
+        (categories?.length ?? 0).toString(),
         plugins.reduce((acc, { audits }) => acc + audits.length, 0).toString()
       ]
     ]
@@ -2678,18 +2683,20 @@ function log(msg = "") {
   ui().logger.log(msg);
 }
 function logStdoutSummary(report, verbose = false) {
-  const printCategories = report.categories.length > 0;
-  log(reportToHeaderSection(report));
+  const { plugins, categories, packageName, version } = report;
+  log(reportToHeaderSection({ packageName, version }));
   log();
-  logPlugins(report.plugins, verbose);
-  if (printCategories) {
-    logCategories(report);
+  logPlugins(plugins, verbose);
+  if (categories && categories.length > 0) {
+    logCategories({ plugins, categories });
   }
   log(`${FOOTER_PREFIX} ${CODE_PUSHUP_DOMAIN}`);
   log();
 }
-function reportToHeaderSection(report) {
-  const { packageName, version } = report;
+function reportToHeaderSection({
+  packageName,
+  version
+}) {
   return `${bold4(REPORT_HEADLINE_TEXT)} - ${packageName}@${version}`;
 }
 function logPlugins(plugins, verbose) {
@@ -2735,7 +2742,10 @@ function logRow(score, title, value) {
     ] : []
   ]);
 }
-function logCategories({ categories, plugins }) {
+function logCategories({
+  plugins,
+  categories
+}) {
   const hAlign = (idx) => idx === 0 ? "left" : "right";
   const rows = categories.map(({ title, score, refs, isBinary }) => [
     title,
@@ -2817,7 +2827,7 @@ function scoreReport(report) {
     }
     return item.score;
   }
-  const scoredCategories = report.categories.map((category) => ({
+  const scoredCategories = report.categories?.map((category) => ({
     ...category,
     score: calculateScore(category.refs, catScoreFn)
   }));
@@ -2904,6 +2914,7 @@ export {
   filePathToCliArg,
   filterItemRefsBy,
   findLineNumberInText,
+  findNearestFile,
   formatBytes,
   formatDuration,
   formatGitPath,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.54.0",
+  "version": "0.56.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",
@@ -26,7 +26,7 @@
   "main": "./index.js",
   "types": "./src/index.d.ts",
   "dependencies": {
-    "@code-pushup/models": "0.54.0",
+    "@code-pushup/models": "0.56.0",
     "@isaacs/cliui": "^8.0.2",
     "@poppinss/cliui": "^6.4.0",
     "ansis": "^3.3.0",

package/src/index.d.ts

@@ -2,7 +2,7 @@ export { exists } from '@code-pushup/models';
 export { comparePairs, matchArrayItemsByKey, type Diff } from './lib/diff';
 export { stringifyError } from './lib/errors';
 export { ProcessError, executeProcess, type ProcessConfig, type ProcessObserver, type ProcessResult, } from './lib/execute-process';
-export { crawlFileSystem, directoryExists, ensureDirectoryExists, fileExists, filePathToCliArg, findLineNumberInText, importModule, logMultipleFileResults, pluginWorkDir, projectToFilename, readJsonFile, readTextFile, removeDirectoryIfExists, type CrawlFileSystemOptions, type FileResult, type MultipleFileResults, } from './lib/file-system';
+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';

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

@@ -16,6 +16,7 @@ export type CrawlFileSystemOptions<T> = {
     fileTransform?: (filePath: string) => Promise<T> | 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 projectToFilename(project: string): string;

package/src/lib/reports/generate-md-report-categoy-section.d.ts

@@ -1,8 +1,8 @@
 import { type InlineText, MarkdownDocument } from 'build-md';
 import type { AuditReport } from '@code-pushup/models';
 import type { ScoredGroup, ScoredReport } from './types';
-export declare function categoriesOverviewSection(report: Pick<ScoredReport, 'categories' | 'plugins'>): MarkdownDocument;
-export declare function categoriesDetailsSection(report: Pick<ScoredReport, 'categories' | 'plugins'>): MarkdownDocument;
+export declare function categoriesOverviewSection(report: Required<Pick<ScoredReport, 'plugins' | 'categories'>>): MarkdownDocument;
+export declare function categoriesDetailsSection(report: Required<Pick<ScoredReport, 'plugins' | 'categories'>>): MarkdownDocument;
 export declare function categoryRef({ title, score, value, displayValue }: AuditReport, pluginTitle: string): InlineText;
 export declare function categoryGroupItem({ score, title }: ScoredGroup, groupAudits: AuditReport[], pluginTitle: string): InlineText;
 export declare function binaryIconSuffix(score: number, isBinary: boolean | undefined): string;

package/src/lib/reports/log-stdout-summary.d.ts

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

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

@@ -9,7 +9,7 @@ export type ScoredReport = Omit<Report, 'plugins' | 'categories'> & {
     plugins: (Omit<PluginReport, 'groups'> & {
         groups?: ScoredGroup[];
     })[];
-    categories: ScoredCategoryConfig[];
+    categories?: ScoredCategoryConfig[];
 };
 export type SortableGroup = ScoredGroup & {
     weight: number;