@code-pushup/utils 0.46.0 → 0.47.0

package/index.js

@@ -63,7 +63,7 @@ function missingRefsForCategoriesErrorMsg(categories, plugins) {
 }
 
 // packages/models/src/lib/implementation/schemas.ts
-var primitiveValueSchema = z.union([z.string(), z.number()]);
+var tableCellValueSchema = z.union([z.string(), z.number(), z.boolean(), z.null()]).default(null);
 function executionMetaSchema(options = {
   descriptionDate: "Execution start date and time",
   descriptionDuration: "Execution duration in ms"
@@ -227,10 +227,10 @@ var tableColumnObjectSchema = z4.object({
   label: z4.string().optional(),
   align: tableAlignmentSchema.optional()
 });
-var tableRowObjectSchema = z4.record(primitiveValueSchema, {
+var tableRowObjectSchema = z4.record(tableCellValueSchema, {
   description: "Object row"
 });
-var tableRowPrimitiveSchema = z4.array(primitiveValueSchema, {
+var tableRowPrimitiveSchema = z4.array(tableCellValueSchema, {
   description: "Primitive row"
 });
 var tableSharedSchema = z4.object({
@@ -777,9 +777,9 @@ function formatBytes(bytes, decimals = 2) {
 function pluralizeToken(token, times) {
   return `${times} ${Math.abs(times) === 1 ? token : pluralize(token)}`;
 }
-function formatDuration(duration) {
+function formatDuration(duration, granularity = 0) {
   if (duration < 1e3) {
-    return `${duration} ms`;
+    return `${granularity ? duration.toFixed(granularity) : duration} ms`;
   }
   return `${(duration / 1e3).toFixed(2)} s`;
 }
@@ -795,12 +795,25 @@ function formatDate(date) {
     timeZoneName: "short"
   }).replace(/\u202F/g, " ");
 }
-function truncateText(text, maxChars) {
+function truncateText(text, options) {
+  const {
+    maxChars,
+    position = "end",
+    ellipsis = "..."
+  } = typeof options === "number" ? { maxChars: options } : options;
   if (text.length <= maxChars) {
     return text;
   }
-  const ellipsis = "...";
-  return text.slice(0, maxChars - ellipsis.length) + ellipsis;
+  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;
+  }
 }
 function truncateTitle(text) {
   return truncateText(text, MAX_TITLE_LENGTH);
@@ -986,20 +999,12 @@ function logMultipleFileResults(fileResults, messagePrefix) {
     failedTransform
   );
 }
-var NoExportError = class extends Error {
-  constructor(filepath) {
-    super(`No default export found in ${filepath}`);
-  }
-};
-async function importEsmModule(options) {
-  const { mod } = await bundleRequire({
-    format: "esm",
-    ...options
-  });
-  if (!("default" in mod)) {
-    throw new NoExportError(options.filepath);
+async function importModule(options) {
+  const { mod } = await bundleRequire(options);
+  if (typeof mod === "object" && "default" in mod) {
+    return mod.default;
   }
-  return mod.default;
+  return mod;
 }
 function pluginWorkDir(slug) {
   return join("node_modules", ".code-pushup", slug);
@@ -1064,7 +1069,7 @@ function code(text) {
 
 // packages/utils/src/lib/text-formats/html/link.ts
 function link2(href, text) {
-  return `<a href="${href}">${text || href}"</a>`;
+  return `<a href="${href}">${text || href}</a>`;
 }
 
 // packages/utils/src/lib/transform.ts
@@ -1171,7 +1176,7 @@ function toOrdinal(value) {
   return `${value}th`;
 }
 
-// packages/utils/src/lib/table.ts
+// packages/utils/src/lib/text-formats/table.ts
 function rowToStringArray({ rows, columns = [] }) {
   if (Array.isArray(rows.at(0)) && typeof columns.at(0) === "object") {
     throw new TypeError(
@@ -1184,14 +1189,19 @@ function rowToStringArray({ rows, columns = [] }) {
     }
     const objectRow = row;
     if (columns.length === 0 || typeof columns.at(0) === "string") {
-      return Object.values(objectRow).map(String);
+      return Object.values(objectRow).map(
+        (value) => value == null ? "" : String(value)
+      );
     }
     return columns.map(
-      ({ key }) => String(objectRow[key])
+      ({ key }) => objectRow[key] == null ? "" : String(objectRow[key])
     );
   });
 }
-function columnsToStringArray({ rows, columns = [] }) {
+function columnsToStringArray({
+  rows,
+  columns = []
+}) {
   const firstRow = rows.at(0);
   const primitiveRows = Array.isArray(firstRow);
   if (typeof columns.at(0) === "string" && !primitiveRows) {
@@ -1231,10 +1241,8 @@ function getColumnAlignmentForIndex(targetIdx, columns = []) {
     return "center";
   }
 }
-function getColumnAlignments({
-  rows,
-  columns = []
-}) {
+function getColumnAlignments(tableData) {
+  const { rows, columns = [] } = tableData;
   if (rows.at(0) == null) {
     throw new Error("first row can`t be undefined.");
   }
@@ -1244,10 +1252,17 @@ function getColumnAlignments({
       (_, idx) => getColumnAlignmentForIndex(idx, columns)
     );
   }
-  const firstObject = rows.at(0);
-  return Object.keys(firstObject).map(
-    (key, idx) => getColumnAlignmentForKeyAndIndex(key, idx, columns)
-  );
+  const biggestRow = [...rows].sort((a, b) => Object.keys(a).length - Object.keys(b).length).at(-1);
+  if (columns.length > 0) {
+    return columns.map(
+      (column, idx) => typeof column === "string" ? column : getColumnAlignmentForKeyAndIndex(
+        column.key,
+        idx,
+        columns
+      )
+    );
+  }
+  return Object.keys(biggestRow ?? {}).map((_) => "center");
 }
 
 // packages/utils/src/lib/text-formats/html/table.ts
@@ -1344,7 +1359,10 @@ function section(...contents) {
   return `${lines(...contents)}${NEW_LINE}`;
 }
 function lines(...contents) {
-  return `${contents.filter(Boolean).join(NEW_LINE)}`;
+  const filteredContent = contents.filter(
+    (value) => value != null && value !== "" && value !== false
+  );
+  return `${filteredContent.join(NEW_LINE)}`;
 }
 
 // packages/utils/src/lib/text-formats/md/table.ts
@@ -2263,8 +2281,8 @@ function formatDiffCategoriesSection(diff) {
   }
   const columns = [
     { key: "category", label: "\u{1F3F7}\uFE0F Category", align: "left" },
-    { key: "after", label: hasChanges ? "\u2B50 Current score" : "\u2B50 Score" },
     { key: "before", label: "\u2B50 Previous score" },
+    { key: "after", label: hasChanges ? "\u2B50 Current score" : "\u2B50 Score" },
     { key: "change", label: "\u{1F504} Score change" }
   ];
   return lines5(
@@ -2309,8 +2327,8 @@ function formatDiffGroupsSection(diff) {
       columns: [
         { key: "plugin", label: "\u{1F50C} Plugin", align: "left" },
         { key: "group", label: "\u{1F5C3}\uFE0F Group", align: "left" },
-        { key: "after", label: "\u2B50 Current score" },
         { key: "before", label: "\u2B50 Previous score" },
+        { key: "after", label: "\u2B50 Current score" },
         { key: "change", label: "\u{1F504} Score change" }
       ],
       rows: sortChanges(diff.groups.changed).map((group) => ({
@@ -2330,8 +2348,8 @@ function formatDiffAuditsSection(diff) {
       columns: [
         { key: "plugin", label: "\u{1F50C} Plugin", align: "left" },
         { key: "audit", label: "\u{1F6E1}\uFE0F Audit", align: "left" },
-        { key: "after", label: "\u{1F4CF} Current value" },
         { key: "before", label: "\u{1F4CF} Previous value" },
+        { key: "after", label: "\u{1F4CF} Current value" },
         { key: "change", label: "\u{1F504} Value change" }
       ],
       rows: sortChanges(diff.audits.changed).map((audit) => ({
@@ -2741,7 +2759,7 @@ export {
   groupByStatus,
   guardAgainstLocalChanges,
   html,
-  importEsmModule,
+  importModule,
   isPromiseFulfilledResult,
   isPromiseRejectedResult,
   isSemver,

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.46.0",
+  "version": "0.47.0",
   "dependencies": {
-    "@code-pushup/models": "0.46.0",
+    "@code-pushup/models": "0.47.0",
     "bundle-require": "^4.0.1",
     "esbuild": "^0.19.2",
     "chalk": "^5.3.0",

package/src/index.d.ts

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

@@ -8,10 +8,7 @@ export declare function removeDirectoryIfExists(dir: string): Promise<void>;
 export type FileResult = readonly [string] | readonly [string, number];
 export type MultipleFileResults = PromiseSettledResult<FileResult>[];
 export declare function logMultipleFileResults(fileResults: MultipleFileResults, messagePrefix: string): void;
-export declare class NoExportError extends Error {
-    constructor(filepath: string);
-}
-export declare function importEsmModule<T = unknown>(options: Options): Promise<T>;
+export declare function importModule<T = unknown>(options: Options): Promise<T>;
 export declare function pluginWorkDir(slug: string): string;
 export type CrawlFileSystemOptions<T> = {
     directory: string;

package/src/lib/formatting.d.ts

@@ -2,9 +2,13 @@ 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): string;
+export declare function formatDuration(duration: number, granularity?: number): string;
 export declare function formatDate(date: Date): string;
-export declare function truncateText(text: string, maxChars: number): string;
+export declare function truncateText(text: string, options: number | {
+    maxChars: number;
+    position?: 'start' | 'middle' | 'end';
+    ellipsis?: string;
+}): string;
 export declare function truncateTitle(text: string): string;
 export declare function truncateDescription(text: string): string;
 export declare function truncateIssueMessage(text: string): string;

package/src/lib/text-formats/md/section.d.ts

@@ -1,2 +1,2 @@
 export declare function section(...contents: (string | undefined | boolean)[]): string;
-export declare function lines(...contents: (string | undefined | boolean)[]): string;
+export declare function lines(...contents: (string | undefined | boolean | number)[]): string;

package/src/lib/text-formats/table.d.ts

@@ -1,6 +1,6 @@
 import { Table, TableAlignment, TableColumnObject, TableColumnPrimitive } from '@code-pushup/models';
 export declare function rowToStringArray({ rows, columns }: Table): string[][];
-export declare function columnsToStringArray({ rows, columns }: Table): string[];
+export declare function columnsToStringArray({ rows, columns, }: Pick<Table, 'columns' | 'rows'>): string[];
 export declare function getColumnAlignmentForKeyAndIndex(targetKey: string, targetIdx: number, columns?: TableColumnObject[]): TableAlignment;
 export declare function getColumnAlignmentForIndex(targetIdx: number, columns?: TableColumnPrimitive[]): TableAlignment;
-export declare function getColumnAlignments({ rows, columns, }: Table): TableAlignment[];
+export declare function getColumnAlignments(tableData: Table): TableAlignment[];

package/src/lib/table.d.ts

@@ -1,6 +0,0 @@
-import { Table, TableAlignment, TableColumnObject, TableColumnPrimitive } from '@code-pushup/models';
-export declare function rowToStringArray({ rows, columns }: Table): string[][];
-export declare function columnsToStringArray({ rows, columns }: Table): string[];
-export declare function getColumnAlignmentForKeyAndIndex(targetKey: string, targetIdx: number, columns?: TableColumnObject[]): TableAlignment;
-export declare function getColumnAlignmentForIndex(targetIdx: number, columns?: TableColumnPrimitive[]): TableAlignment;
-export declare function getColumnAlignments({ rows, columns, }: Table): TableAlignment[];