@sorrell/cli-utilities 1.0.27 → 1.0.28

package/Distribution/Listr.Types.d.ts

@@ -0,0 +1,4 @@
+import type { DefaultRenderer, ListrDefaultRenderer, ListrGetRendererClassFromValue, ListrTask, ListrTaskWrapper } from "listr2";
+export type Wrapper<ContextType> = ListrTaskWrapper<ContextType, ListrDefaultRenderer, ListrDefaultRenderer>;
+export type ListrConstructorTask<ContextType> = ListrTask<ContextType, ListrGetRendererClassFromValue<typeof DefaultRenderer>, ListrGetRendererClassFromValue<typeof DefaultRenderer>> | Array<ListrTask<ContextType, ListrGetRendererClassFromValue<typeof DefaultRenderer>, ListrGetRendererClassFromValue<typeof DefaultRenderer>>>;
+//# sourceMappingURL=Listr.Types.d.ts.map

package/Distribution/Listr.Types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Listr.Types.d.ts","sourceRoot":"","sources":["../Source/Listr.Types.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACR,eAAe,EACf,oBAAoB,EACpB,8BAA8B,EAC9B,SAAS,EACT,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAErC,MAAM,MAAM,OAAO,CAAC,WAAW,IAAI,gBAAgB,CAC/C,WAAW,EACX,oBAAoB,EACpB,oBAAoB,CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,WAAW,IACtC,SAAS,CACP,WAAW,EACX,8BAA8B,CAAC,OAAO,eAAe,CAAC,EACtD,8BAA8B,CAAC,OAAO,eAAe,CAAC,CAAC,GACzD,KAAK,CAAC,SAAS,CACb,WAAW,EACX,8BAA8B,CAAC,OAAO,eAAe,CAAC,EACtD,8BAA8B,CAAC,OAAO,eAAe,CAAC,CAAC,CAC1D,CAAC"}

package/Distribution/Listr.Types.js

@@ -0,0 +1,7 @@
+/* File:      Listr.Types.ts
+ * Author:    Gage Sorrell <gage@sorrell.sh>
+ * Copyright: (c) 2026 Gage Sorrell
+ * License:   MIT
+ */
+export {};
+//# sourceMappingURL=Listr.Types.js.map

package/Distribution/Listr.Types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Listr.Types.js","sourceRoot":"","sources":["../Source/Listr.Types.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/Distribution/Listr.d.ts

@@ -0,0 +1,22 @@
+import { type DefaultRenderer, type ListrBaseClassOptions, type ListrTaskObject } from "listr2";
+import type { ListrConstructorTask } from "./Listr.Types.js";
+/** A string-only {@link Error} used by {@link Listr} to show nicely-formatted errors. */
+export declare class SimpleError extends Error {
+    constructor(Message: string);
+    TheMessage: string;
+}
+/**
+ * A wrapper for `new Listr` that handles errors nicely.
+ *
+ * @typeParam ContextType - The type of the `listr2` context used by the {@link Task}.
+ *
+ * @param Task - The task(s) to run.
+ * @param GenericErrorMessage - The error message that is shown if the {@link Task | task(s)} throw(s)
+ * something other than a {@link SimpleError}.
+ * @param Options - *(Optional)* The {@link ListrBaseClassOptions} used to customize the
+ * {@link Task | task(s)}.
+ * @param ParentTask - *(Optional)* The {@link ListrTaskObject | parent task} of which the
+ * {@link Task | task(s)} are (a) descendant(s).
+ */
+export declare function RunListr<ContextType = unknown>(Task: ListrConstructorTask<ContextType>, GenericErrorMessage: string, Options?: ListrBaseClassOptions<ContextType, typeof DefaultRenderer, typeof DefaultRenderer>, ParentTask?: ListrTaskObject<unknown, typeof DefaultRenderer, typeof DefaultRenderer>): Promise<void>;
+//# sourceMappingURL=Listr.d.ts.map

package/Distribution/Listr.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Listr.d.ts","sourceRoot":"","sources":["../Source/Listr.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,KAAK,eAAe,EACpB,KAAK,qBAAqB,EAC1B,KAAK,eAAe,EACI,MAAM,QAAQ,CAAC;AAC3C,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAE7D,yFAAyF;AACzF,qBAAa,WAAY,SAAQ,KAAK;gBAEf,OAAO,EAAE,MAAM;IAM3B,UAAU,EAAE,MAAM,CAAC;CAC7B;AA8BD;;;;;;;;;;;;GAYG;AACH,wBAAsB,QAAQ,CAAC,WAAW,GAAG,OAAO,EAChD,IAAI,EAAE,oBAAoB,CAAC,WAAW,CAAC,EACvC,mBAAmB,EAAE,MAAM,EAC3B,OAAO,CAAC,EAAE,qBAAqB,CAAC,WAAW,EAAE,OAAO,eAAe,EAAE,OAAO,eAAe,CAAC,EAC5F,UAAU,CAAC,EAAE,eAAe,CACxB,OAAO,EACP,OAAO,eAAe,EACtB,OAAO,eAAe,CACzB,GACF,OAAO,CAAC,IAAI,CAAC,CAkBf"}

package/Distribution/Listr.js

@@ -0,0 +1,57 @@
+/* File:      Listr.ts
+ * Author:    Gage Sorrell <gage@sorrell.sh>
+ * Copyright: (c) 2026 Gage Sorrell
+ * License:   MIT
+ */
+import { Listr as OriginalListr } from "listr2";
+/** A string-only {@link Error} used by {@link Listr} to show nicely-formatted errors. */
+export class SimpleError extends Error {
+    constructor(Message) {
+        super();
+        this.TheMessage = Message;
+    }
+    TheMessage;
+}
+;
+class Listr extends OriginalListr {
+    constructor(Task, Options, ParentTask) {
+        if (Options === undefined && ParentTask === undefined) {
+            super(Task);
+        }
+        else if (Options !== undefined && ParentTask === undefined) {
+            super(Task, Options);
+        }
+        else if (Options !== undefined && ParentTask !== undefined) {
+            super(Task, Options, ParentTask);
+        }
+    }
+}
+;
+/**
+ * A wrapper for `new Listr` that handles errors nicely.
+ *
+ * @typeParam ContextType - The type of the `listr2` context used by the {@link Task}.
+ *
+ * @param Task - The task(s) to run.
+ * @param GenericErrorMessage - The error message that is shown if the {@link Task | task(s)} throw(s)
+ * something other than a {@link SimpleError}.
+ * @param Options - *(Optional)* The {@link ListrBaseClassOptions} used to customize the
+ * {@link Task | task(s)}.
+ * @param ParentTask - *(Optional)* The {@link ListrTaskObject | parent task} of which the
+ * {@link Task | task(s)} are (a) descendant(s).
+ */
+export async function RunListr(Task, GenericErrorMessage, Options, ParentTask) {
+    try {
+        await new Listr(Task, Options, ParentTask);
+    }
+    catch (ListrError) {
+        if (ListrError instanceof SimpleError) {
+            console.error(`🚨 ${ListrError.TheMessage}`);
+        }
+        else {
+            console.dir(ListrError);
+            console.error(`\n🚨 ${GenericErrorMessage}.  The error is printed above.`);
+        }
+    }
+}
+//# sourceMappingURL=Listr.js.map

package/Distribution/Listr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Listr.js","sourceRoot":"","sources":["../Source/Listr.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAIH,KAAK,IAAI,aAAa,EAAE,MAAM,QAAQ,CAAC;AAG3C,yFAAyF;AACzF,MAAM,OAAO,WAAY,SAAQ,KAAK;IAElC,YAAmB,OAAe;QAE9B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;IAC9B,CAAC;IAEM,UAAU,CAAS;CAC7B;AAAA,CAAC;AAEF,MAAM,KACF,SAAQ,aAA0E;IAElF,YACI,IAAuC,EACvC,OAA4F,EAC5F,UAIC;QAGD,IAAI,OAAO,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EACrD,CAAC;YACG,KAAK,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC;aACI,IAAI,OAAO,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAC1D,CAAC;YACG,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACzB,CAAC;aACI,IAAI,OAAO,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAC1D,CAAC;YACG,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QACrC,CAAC;IACL,CAAC;CACJ;AAAA,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC1B,IAAuC,EACvC,mBAA2B,EAC3B,OAA4F,EAC5F,UAIC;IAGD,IACA,CAAC;QACG,MAAM,IAAI,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,UAAmB,EAC1B,CAAC;QACG,IAAI,UAAU,YAAY,WAAW,EACrC,CAAC;YACG,OAAO,CAAC,KAAK,CAAC,MAAO,UAAU,CAAC,UAAW,EAAE,CAAC,CAAC;QACnD,CAAC;aAED,CAAC;YACG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACxB,OAAO,CAAC,KAAK,CAAC,QAAS,mBAAoB,gCAAgC,CAAC,CAAC;QACjF,CAAC;IACL,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sorrell/cli-utilities",
-  "version": "1.0.27",
+  "version": "1.0.28",
   "description": "Utilities for CLI tools.",
   "keywords": [
     "cli",
@@ -44,12 +44,14 @@
     "@inquirer/core": "^11.1.7",
     "@inquirer/prompts": "^8.3.2",
     "@inquirer/type": "^4.0.4",
+    "@listr2/prompt-adapter-enquirer": "^4.2.1",
     "@sorrell/inquirer-file-selector": "^1.0.4",
     "@sorrell/utilities": "^1.1.11",
     "chalk": "^5.6.2",
     "cli-table3": "^0.6.5",
     "clipboardy": "^5.3.1",
     "commander": "^14.0.3",
+    "listr2": "^10.2.1",
     "ora": "^9.3.0"
   }
 }