listr2 - npm Package Compare versions

Comparing version 4.0.1 to 4.0.2

dist/index.d.ts

@@ -190,19 +190,2 @@ import { Observable, Subject } from 'rxjs';
 
-/** Returns all the prompt options depending on the type selected. */
-declare type PromptOptions<T extends boolean = false> = Unionize<{
-    [K in PromptTypes]-?: T extends true ? {
-        type: K;
-    } & PromptOptionsType<K> & {
-        name: string | (() => string);
-    } : {
-        type: K;
-    } & PromptOptionsType<K>;
-}> | ({
-    type: string;
-} & T extends true ? PromptOptionsType<string> & {
-    name: string | (() => string);
-} : PromptOptionsType<string>);
-declare type Unionize<T extends Record<PropertyKey, unknown>> = {
-    [P in keyof T]: T[P];
-}[keyof T];
 interface BasePromptOptions {
@@ -216,8 +199,8 @@ message: string | (() => string) | (() => Promise<string>);
     footer?: string;
-    skip?(value: any): boolean | Promise<boolean>;
-    format?(value: any): any | Promise<any>;
-    result?(value: any): any | Promise<any>;
-    validate?(value: any, state: any): boolean | Promise<boolean> | string | Promise<string> | Promise<string | boolean>;
-    onSubmit?(name: any, value: any, prompt: Enquirer.Prompt): boolean | Promise<boolean>;
-    onCancel?(name: any, value: any, prompt: Enquirer.Prompt): boolean | Promise<boolean>;
+    skip?: (value: any) => boolean | Promise<boolean>;
+    format?: (value: any) => any | Promise<any>;
+    result?: (value: any) => any | Promise<any>;
+    validate?: (value: any, state: any) => boolean | Promise<boolean> | string | Promise<string> | Promise<string | boolean>;
+    onSubmit?: (name: any, value: any, prompt: Enquirer.Prompt) => boolean | Promise<boolean>;
+    onCancel?: (name: any, value: any, prompt: Enquirer.Prompt) => boolean | Promise<boolean>;
 }
@@ -282,2 +265,19 @@ interface BasePromptOptionsWithName extends BasePromptOptions {
 }
+/** Returns all the prompt options depending on the type selected. */
+declare type PromptOptions<T extends boolean = false> = Unionize<{
+    [K in PromptTypes]-?: T extends true ? {
+        type: K;
+    } & PromptOptionsType<K> & {
+        name: string | (() => string);
+    } : {
+        type: K;
+    } & PromptOptionsType<K>;
+}> | ({
+    type: string;
+} & T extends true ? PromptOptionsType<string> & {
+    name: string | (() => string);
+} : PromptOptionsType<string>);
+declare type Unionize<T extends Record<PropertyKey, unknown>> = {
+    [P in keyof T]: T[P];
+}[keyof T];
 declare type PromptTypes = 'AutoComplete' | 'BasicAuth' | 'Confirm' | 'Editable' | 'Form' | 'Input' | 'Invisible' | 'List' | 'MultiSelect' | 'Numeral' | 'Password' | 'Quiz' | 'Scale' | 'Select' | 'Snippet' | 'Sort' | 'Survey' | 'Text' | 'Toggle';
@@ -313,4 +313,4 @@ declare type PromptOptionsType<T> = T extends keyof PromptOptionsMap ? PromptOptionsMap[T] : T extends string ? BasePromptOptions & Record<PropertyKey, unknown> : any;
 interface PromptInstance extends Omit<BasePromptOptions, 'onCancel' | 'onSubmit'> {
-    submit(): void;
-    cancel(err?: string): void;
+    submit: () => void;
+    cancel: (err?: string) => void;
 }
@@ -317,0 +317,0 @@

dist/index.js

@@ -99,9 +99,9 @@ var __create = Object.create;
 };
-var ListrErrorTypes = /* @__PURE__ */ ((ListrErrorTypes3) => {
-  ListrErrorTypes3["WILL_RETRY"] = "WILL_RETRY";
-  ListrErrorTypes3["WILL_ROLLBACK"] = "WILL_ROLLBACK";
-  ListrErrorTypes3["HAS_FAILED_TO_ROLLBACK"] = "HAS_FAILED_TO_ROLLBACK";
-  ListrErrorTypes3["HAS_FAILED"] = "HAS_FAILED";
-  ListrErrorTypes3["HAS_FAILED_WITHOUT_ERROR"] = "HAS_FAILED_WITHOUT_ERROR";
-  return ListrErrorTypes3;
+var ListrErrorTypes = /* @__PURE__ */ ((ListrErrorTypes2) => {
+  ListrErrorTypes2["WILL_RETRY"] = "WILL_RETRY";
+  ListrErrorTypes2["WILL_ROLLBACK"] = "WILL_ROLLBACK";
+  ListrErrorTypes2["HAS_FAILED_TO_ROLLBACK"] = "HAS_FAILED_TO_ROLLBACK";
+  ListrErrorTypes2["HAS_FAILED"] = "HAS_FAILED";
+  ListrErrorTypes2["HAS_FAILED_WITHOUT_ERROR"] = "HAS_FAILED_WITHOUT_ERROR";
+  return ListrErrorTypes2;
 })(ListrErrorTypes || {});
@@ -807,3 +807,3 @@ var PromptError = class extends Error {
 // src/lib/task.ts
-var Task2 = class extends Subject {
+var Task = class extends Subject {
   constructor(listr, tasks, options, rendererOptions) {
@@ -1023,2 +1023,12 @@ super();
 // src/utils/prompt.ts
+function defaultCancelCallback(settings) {
+  const errorMsg = "Cancelled prompt.";
+  if (this instanceof TaskWrapper) {
+    this.task.prompt = new PromptError(errorMsg);
+  } else if ((settings == null ? void 0 : settings.error) !== false) {
+    throw new Error(errorMsg);
+  } else {
+    return errorMsg;
+  }
+}
 async function createPrompt(options, settings) {
@@ -1043,3 +1053,3 @@ let cancelCallback;
       Object.assign(option, {
-        stdout: this instanceof TaskWrapper2 ? (_a2 = settings == null ? void 0 : settings.stdout) != null ? _a2 : this.stdout() : process.stdout,
+        stdout: this instanceof TaskWrapper ? (_a2 = settings == null ? void 0 : settings.stdout) != null ? _a2 : this.stdout() : process.stdout,
         onCancel: cancelCallback.bind(this, settings)
@@ -1060,3 +1070,3 @@ })
   }
-  if (this instanceof TaskWrapper2) {
+  if (this instanceof TaskWrapper) {
     enquirer.on("prompt", (prompt) => this.task.prompt = prompt);
@@ -1089,15 +1099,5 @@ enquirer.on("submit", () => this.task.prompt = void 0);
 }
-function defaultCancelCallback(settings) {
-  const errorMsg = "Cancelled prompt.";
-  if (this instanceof TaskWrapper2) {
-    this.task.prompt = new PromptError(errorMsg);
-  } else if ((settings == null ? void 0 : settings.error) !== false) {
-    throw new Error(errorMsg);
-  } else {
-    return errorMsg;
-  }
-}
 
 // src/lib/task-wrapper.ts
-var TaskWrapper2 = class {
+var TaskWrapper = class {
   constructor(task, errors, options) {
@@ -1224,3 +1224,3 @@ this.task = task;
     tasks.forEach((task2) => {
-      this.tasks.push(new Task2(this, task2, this.options, __spreadValues(__spreadValues({}, this.rendererClassOptions), task2.options)));
+      this.tasks.push(new Task(this, task2, this.options, __spreadValues(__spreadValues({}, this.rendererClassOptions), task2.options)));
     });
@@ -1257,3 +1257,3 @@ }
     }
-    return new TaskWrapper2(task, errors, this.options).run(context);
+    return new TaskWrapper(task, errors, this.options).run(context);
   }
@@ -1260,0 +1260,0 @@ };

package.json

 {
   "name": "listr2",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "description": "Terminal task list reborn! Create beautiful CLI interfaces via easy and logical to implement task lists that feel alive and interactive.",
@@ -21,3 +21,3 @@ "license": "MIT",
     "email": "[e-mail]",
-    "url": "https://srcs.kilic.dev"
+    "url": "https://cenk.kilic.dev"
   },
@@ -30,3 +30,3 @@ "engines": {
     "dev:start": "tsup-node --watch",
-    "example": "ts-node -r tsconfig-paths/register",
+    "example": "ts-node -r tsconfig-paths/register --project examples/tsconfig.json",
     "read-snapshot": "./tests/read-terminal-snapshots.sh",
@@ -85,6 +85,6 @@ "clean": "rimraf node_modules yarn.lock",
     "@cenk1cenk2/cz-cc": "^1.4.11",
-    "@cenk1cenk2/eslint-config": "^1.0.10",
+    "@cenk1cenk2/eslint-config": "^2.4.0",
     "@types/clone": "^2.1.1",
     "@types/jest": "^27.4.0",
-    "@types/node": "^17.0.8",
+    "@types/node": "^17.0.13",
     "@types/through": "^0.0.30",
@@ -94,16 +94,16 @@ "@types/wrap-ansi": "^3.0.0",
     "enquirer": "^2.3.6",
-    "eslint": "^8.6.0",
+    "eslint": "^8.8.0",
     "jest": "^27.4.7",
     "jest-mock-process": "^1.4.1",
-    "lint-staged": "^12.1.5",
+    "lint-staged": "^12.3.2",
     "prettier": "^2.5.1",
     "rimraf": "^3.0.2",
     "simple-git-hooks": "^2.7.0",
-    "ts-jest": "^27.1.2",
+    "ts-jest": "^27.1.3",
     "ts-node": "^10.4.0",
     "tsconfig-paths": "^3.12.0",
-    "tsup": "^5.11.10",
-    "typedoc": "^0.22.10",
-    "typedoc-plugin-markdown": "^3.11.9",
-    "typescript": "^4.5.4"
+    "tsup": "5.11.13",
+    "typedoc": "^0.22.11",
+    "typedoc-plugin-markdown": "^3.11.12",
+    "typescript": "^4.6.0-dev.20220131"
   },
@@ -110,0 +110,0 @@ "peerDependencies": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

184183

increased by0.03%

No dependency changes