@code-pushup/utils 0.35.0 → 0.39.0

package/index.js

@@ -574,10 +574,14 @@ function makeArraysComparisonSchema(diffSchema, resultSchema, description) {
     { description }
   );
 }
-var scorableMetaSchema = z14.object({ slug: slugSchema, title: titleSchema });
+var scorableMetaSchema = z14.object({
+  slug: slugSchema,
+  title: titleSchema,
+  docsUrl: docsUrlSchema
+});
 var scorableWithPluginMetaSchema = scorableMetaSchema.merge(
   z14.object({
-    plugin: pluginMetaSchema.pick({ slug: true, title: true }).describe("Plugin which defines it")
+    plugin: pluginMetaSchema.pick({ slug: true, title: true, docsUrl: true }).describe("Plugin which defines it")
   })
 );
 var scorableDiffSchema = scorableMetaSchema.merge(
@@ -904,7 +908,7 @@ async function ensureDirectoryExists(baseDir) {
     await mkdir(baseDir, { recursive: true });
     return;
   } catch (error) {
-    ui().logger.error(error.message);
+    ui().logger.info(error.message);
     if (error.code !== "EEXIST") {
       throw error;
     }
@@ -1440,11 +1444,9 @@ function toOrdinal(value) {
 async function getLatestCommit(git = simpleGit()) {
   const log2 = await git.log({
     maxCount: 1,
+    // git log -1 --pretty=format:"%H %s %an %aI" - See: https://git-scm.com/docs/pretty-formats
     format: { hash: "%H", message: "%s", author: "%an", date: "%aI" }
   });
-  if (!log2.latest) {
-    return null;
-  }
   return commitSchema.parse(log2.latest);
 }
 function getGitRoot(git = simpleGit()) {
@@ -1459,25 +1461,48 @@ async function toGitPath(path, git = simpleGit()) {
   const gitRoot = await getGitRoot(git);
   return formatGitPath(path, gitRoot);
 }
-async function guardAgainstLocalChanges(git = simpleGit()) {
-  const isClean = await git.status(["-s"]).then((r) => r.files.length === 0);
-  if (!isClean) {
-    throw new Error(
-      "Working directory needs to be clean before we you can proceed. Commit your local changes or stash them."
+var GitStatusError = class _GitStatusError extends Error {
+  static ignoredProps = /* @__PURE__ */ new Set(["current", "tracking"]);
+  static getReducedStatus(status) {
+    return Object.fromEntries(
+      Object.entries(status).filter(([key]) => !this.ignoredProps.has(key)).filter(
+        (entry) => {
+          const value = entry[1];
+          if (value == null) {
+            return false;
+          }
+          if (Array.isArray(value) && value.length === 0) {
+            return false;
+          }
+          if (typeof value === "number" && value === 0) {
+            return false;
+          }
+          return !(typeof value === "boolean" && !value);
+        }
+      )
     );
   }
+  constructor(status) {
+    super(
+      `Working directory needs to be clean before we you can proceed. Commit your local changes or stash them: 
+ ${JSON.stringify(
+        _GitStatusError.getReducedStatus(status),
+        null,
+        2
+      )}`
+    );
+  }
+};
+async function guardAgainstLocalChanges(git = simpleGit()) {
+  const status = await git.status(["-s"]);
+  if (status.files.length > 0) {
+    throw new GitStatusError(status);
+  }
 }
 async function getCurrentBranchOrTag(git = simpleGit()) {
-  try {
-    const branch = await git.branch().then((r) => r.current);
-    if (branch) {
-      return branch;
-    } else {
-      return await git.raw(["describe", "--tags", "--exact-match"]).then((out) => out.trim());
-    }
-  } catch {
-    throw new Error("Could not get current tag or branch.");
-  }
+  return await git.branch().then((r) => r.current) || // If no current branch, try to get the tag
+  // @TODO use simple git
+  await git.raw(["describe", "--tags", "--exact-match"]).then((out) => out.trim());
 }
 async function safeCheckout(branchOrHash, forceCleanStatus = false, git = simpleGit()) {
   if (forceCleanStatus) {
@@ -1801,19 +1826,19 @@ function formatDiffCategoriesSection(diff) {
           "\u{1F504} Score change"
         ],
         ...sortChanges(changed).map((category) => [
-          category.title,
+          formatTitle(category),
           formatScoreWithColor(category.scores.after),
           formatScoreWithColor(category.scores.before, { skipBold: true }),
           formatScoreChange(category.scores.diff)
         ]),
         ...added.map((category) => [
-          category.title,
+          formatTitle(category),
           formatScoreWithColor(category.score),
           style("n/a (\\*)", ["i"]),
           style("n/a (\\*)", ["i"])
         ]),
         ...unchanged.map((category) => [
-          category.title,
+          formatTitle(category),
           formatScoreWithColor(category.score),
           formatScoreWithColor(category.score, { skipBold: true }),
           "\u2013"
@@ -1839,8 +1864,8 @@ function formatDiffGroupsSection(diff) {
         "\u{1F504} Score change"
       ],
       rows: sortChanges(diff.groups.changed).map((group) => [
-        group.plugin.title,
-        group.title,
+        formatTitle(group.plugin),
+        formatTitle(group),
         formatScoreWithColor(group.scores.after),
         formatScoreWithColor(group.scores.before, { skipBold: true }),
         formatScoreChange(group.scores.diff)
@@ -1861,8 +1886,8 @@ function formatDiffAuditsSection(diff) {
         "\u{1F504} Value change"
       ],
       rows: sortChanges(diff.audits.changed).map((audit) => [
-        audit.plugin.title,
-        audit.title,
+        formatTitle(audit.plugin),
+        formatTitle(audit),
         `${getSquaredScoreMarker(audit.scores.after)} ${style(
           audit.displayValues.after || audit.values.after.toString()
         )}`,
@@ -1930,6 +1955,15 @@ function summarizeDiffOutcomes(outcomes, token) {
     }
   }).join(", ");
 }
+function formatTitle({
+  title,
+  docsUrl
+}) {
+  if (docsUrl) {
+    return link2(docsUrl, title);
+  }
+  return title;
+}
 function sortChanges(changes) {
   return [...changes].sort(
     (a, b) => Math.abs(b.scores.diff) - Math.abs(a.scores.diff) || Math.abs(b.values?.diff ?? 0) - Math.abs(a.values?.diff ?? 0)
@@ -2248,6 +2282,7 @@ export {
   getLatestCommit,
   getProgressBar,
   groupByStatus,
+  guardAgainstLocalChanges,
   importEsmModule,
   isPromiseFulfilledResult,
   isPromiseRejectedResult,

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@code-pushup/utils",
-  "version": "0.35.0",
+  "version": "0.39.0",
   "dependencies": {
-    "@code-pushup/models": "0.35.0",
+    "@code-pushup/models": "0.39.0",
     "bundle-require": "^4.0.1",
+    "esbuild": "^0.19.2",
     "chalk": "^5.3.0",
     "@isaacs/cliui": "^8.0.2",
     "simple-git": "^3.20.0",

package/src/index.d.ts

@@ -1,10 +1,11 @@
+export { ExcludeNullFromPropertyTypes } from './lib/types';
 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, findLineNumberInText, importEsmModule, 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, getCurrentBranchOrTag, getGitRoot, getLatestCommit, safeCheckout, toGitPath, } from './lib/git';
+export { formatGitPath, getCurrentBranchOrTag, guardAgainstLocalChanges, getGitRoot, getLatestCommit, safeCheckout, toGitPath, } from './lib/git';
 export { groupByStatus } from './lib/group-by-status';
 export { isPromiseFulfilledResult, isPromiseRejectedResult, } from './lib/guards';
 export { logMultipleResults } from './lib/log-results';

package/src/lib/git.d.ts

@@ -1,8 +1,16 @@
+import { StatusResult } from 'simple-git';
 import { Commit } from '@code-pushup/models';
 export declare function getLatestCommit(git?: import("simple-git").SimpleGit): Promise<Commit | null>;
 export declare function getGitRoot(git?: import("simple-git").SimpleGit): Promise<string>;
 export declare function formatGitPath(path: string, gitRoot: string): string;
 export declare function toGitPath(path: string, git?: import("simple-git").SimpleGit): Promise<string>;
+export declare class GitStatusError extends Error {
+    static ignoredProps: Set<string>;
+    static getReducedStatus(status: StatusResult): {
+        [k: string]: any;
+    };
+    constructor(status: StatusResult);
+}
 export declare function guardAgainstLocalChanges(git?: import("simple-git").SimpleGit): Promise<void>;
 export declare function getCurrentBranchOrTag(git?: import("simple-git").SimpleGit): Promise<string>;
 export declare function safeCheckout(branchOrHash: string, forceCleanStatus?: boolean, git?: import("simple-git").SimpleGit): Promise<void>;

package/src/lib/types.d.ts

@@ -0,0 +1,3 @@
+export type ExcludeNullFromPropertyTypes<T> = {
+    [P in keyof T]: Exclude<T[P], null>;
+};