listr2 - npm Package Compare versions

Comparing version 7.0.0-beta.2 to 7.0.0-beta.3

dist/index.d.ts

 import Enquirer from 'enquirer';
 import { Observable } from 'rxjs';
 import { Writable, Readable } from 'stream';
+import * as colorette from 'colorette';
 import { WriteStream } from 'fs';
-import * as colorette from 'colorette';
+import { CancelablePromise, Prompt } from '@inquirer/type';
 
@@ -141,3 +142,5 @@ /**
     /** Task has successfully processed the prompt. */
-    PROMPT_COMPLETED = "PROMPT_COMPLETED"
+    PROMPT_COMPLETED = "PROMPT_COMPLETED",
+    /** Task has failed to process the prompt. */
+    PROMPT_FAILED = "PROMPT_FAILED"
 }
@@ -389,14 +392,3 @@
 
-declare class Spinner {
-    protected readonly spinner: string[];
-    private id?;
-    private spinnerPosition;
-    spin(): void;
-    fetch(): string;
-    isRunning(): boolean;
-    start(cb?: () => void, interval?: number): void;
-    stop(): void;
-}
-
-interface BasePromptOptions {
+interface EnquirerBasePromptOptions {
     message: string | (() => string) | (() => Promise<string>);
@@ -416,7 +408,7 @@ initial?: boolean | number | number[] | string | (() => string) | (() => Promise<string>);
 }
-interface BasePromptOptionsWithName extends BasePromptOptions {
+interface EnquirerBasePromptOptionsWithName extends EnquirerBasePromptOptions {
     name: string | (() => string);
 }
-interface ArrayPromptOptions extends BasePromptOptions {
-    choices: string[] | BasePromptOptionsWithName[];
+interface EnquirerArrayPromptOptions extends EnquirerBasePromptOptions {
+    choices: string[] | EnquirerBasePromptOptionsWithName[];
     maxChoices?: number;
@@ -434,14 +426,14 @@ multiple?: boolean;
 }
-interface BooleanPromptOptions extends BasePromptOptions {
+interface EnquirerBooleanPromptOptions extends EnquirerBasePromptOptions {
     initial?: boolean | (() => string) | (() => Promise<string>);
 }
-interface StringPromptOptions extends BasePromptOptions {
+interface EnquirerStringPromptOptions extends EnquirerBasePromptOptions {
     initial?: string;
     multiline?: boolean;
 }
-interface ScalePromptOptions extends ArrayPromptOptions {
-    scale: StringPromptOptions[];
+interface EnquirerScalePromptOptions extends EnquirerArrayPromptOptions {
+    scale: EnquirerStringPromptOptions[];
     margin?: [number, number, number, number];
 }
-interface NumberPromptOptions extends BasePromptOptions {
+interface EnquirerNumberPromptOptions extends EnquirerBasePromptOptions {
     min?: number;
@@ -456,8 +448,8 @@ max?: number;
 }
-interface SnippetPromptOptions extends BasePromptOptions {
+interface EnquirerSnippetPromptOptions extends EnquirerBasePromptOptions {
     newline?: string;
-    fields: Partial<BasePromptOptionsWithName>[];
+    fields: Partial<EnquirerBasePromptOptionsWithName>[];
     template: string;
 }
-interface SortPromptOptions extends BasePromptOptions {
+interface EnquirerSortPromptOptions extends EnquirerBasePromptOptions {
     hint?: string;
@@ -467,57 +459,54 @@ drag?: boolean;
 }
-interface SurveyPromptOptions extends ArrayPromptOptions {
-    scale: BasePromptOptionsWithName[];
+interface EnquirerSurveyPromptOptions extends EnquirerArrayPromptOptions {
+    scale: EnquirerBasePromptOptionsWithName[];
     margin: [number, number, number, number];
 }
-interface QuizPromptOptions extends ArrayPromptOptions {
+interface EnquirerQuizPromptOptions extends EnquirerArrayPromptOptions {
     correctChoice: number;
 }
-interface TogglePromptOptions extends BasePromptOptions {
+interface EnquirerTogglePromptOptions extends EnquirerBasePromptOptions {
     enabled?: string;
     disabled?: string;
 }
-interface PromptCancelOptions {
+interface EnquirerPromptCancelOptions {
     throw?: boolean;
 }
 /** Returns all the prompt options depending on the type selected. */
-type PromptOptions<T extends boolean = false> = Unionize<{
-    [K in PromptTypes]-?: T extends true ? {
+type EnquirerPromptOptions<T extends boolean = false> = Unionize<{
+    [K in EnquirerPromptTypes]-?: T extends true ? {
         type: K;
-    } & PromptOptionsType<K> & {
+    } & EnquirerPromptOptionsType<K> & {
         name: string | (() => string);
     } : {
         type: K;
-    } & PromptOptionsType<K>;
+    } & EnquirerPromptOptionsType<K>;
 }> | ({
     type: string;
-} & T extends true ? PromptOptionsType<string> & {
+} & T extends true ? EnquirerPromptOptionsType<string> & {
     name: string | (() => string);
-} : PromptOptionsType<string>);
-type Unionize<T extends Record<PropertyKey, unknown>> = {
-    [P in keyof T]: T[P];
-}[keyof T];
-type PromptTypes = 'AutoComplete' | 'BasicAuth' | 'Confirm' | 'Editable' | 'Form' | 'Input' | 'Invisible' | 'List' | 'MultiSelect' | 'Numeral' | 'Password' | 'Quiz' | 'Scale' | 'Select' | 'Snippet' | 'Sort' | 'Survey' | 'Text' | 'Toggle';
-type PromptOptionsType<T> = T extends keyof PromptOptionsMap ? PromptOptionsMap[T] : T extends string ? BasePromptOptions & Record<PropertyKey, unknown> : any;
-declare class PromptOptionsMap implements Record<PromptTypes, Record<PropertyKey, any>> {
-    AutoComplete: ArrayPromptOptions;
-    BasicAuth: StringPromptOptions;
-    Confirm: BooleanPromptOptions;
-    Editable: ArrayPromptOptions;
-    Form: ArrayPromptOptions;
-    Input: StringPromptOptions;
-    Invisible: StringPromptOptions;
-    List: ArrayPromptOptions;
-    MultiSelect: ArrayPromptOptions;
-    Numeral: NumberPromptOptions;
-    Password: StringPromptOptions;
-    Quiz: QuizPromptOptions;
-    Scale: ScalePromptOptions;
-    Select: ArrayPromptOptions;
-    Snippet: SnippetPromptOptions;
-    Sort: SortPromptOptions;
-    Survey: SurveyPromptOptions;
-    Text: StringPromptOptions;
-    Toggle: TogglePromptOptions;
+} : EnquirerPromptOptionsType<string>);
+type EnquirerPromptTypes = 'AutoComplete' | 'BasicAuth' | 'Confirm' | 'Editable' | 'Form' | 'Input' | 'Invisible' | 'List' | 'MultiSelect' | 'Numeral' | 'Password' | 'Quiz' | 'Scale' | 'Select' | 'Snippet' | 'Sort' | 'Survey' | 'Text' | 'Toggle';
+type EnquirerPromptOptionsType<T> = T extends keyof EnquirerPromptOptionsMap ? EnquirerPromptOptionsMap[T] : T extends string ? EnquirerBasePromptOptions & Record<PropertyKey, unknown> : any;
+declare class EnquirerPromptOptionsMap implements Record<EnquirerPromptTypes, Record<PropertyKey, any>> {
+    AutoComplete: EnquirerArrayPromptOptions;
+    BasicAuth: EnquirerStringPromptOptions;
+    Confirm: EnquirerBooleanPromptOptions;
+    Editable: EnquirerArrayPromptOptions;
+    Form: EnquirerArrayPromptOptions;
+    Input: EnquirerStringPromptOptions;
+    Invisible: EnquirerStringPromptOptions;
+    List: EnquirerArrayPromptOptions;
+    MultiSelect: EnquirerArrayPromptOptions;
+    Numeral: EnquirerNumberPromptOptions;
+    Password: EnquirerStringPromptOptions;
+    Quiz: EnquirerQuizPromptOptions;
+    Scale: EnquirerScalePromptOptions;
+    Select: EnquirerArrayPromptOptions;
+    Snippet: EnquirerSnippetPromptOptions;
+    Sort: EnquirerSortPromptOptions;
+    Survey: EnquirerSurveyPromptOptions;
+    Text: EnquirerStringPromptOptions;
+    Toggle: EnquirerTogglePromptOptions;
 }
-interface PromptSettings {
+interface EnquirerPromptSettings {
     error?: boolean;
@@ -527,3 +516,3 @@ stdout?: WriteStream | Writable;
 }
-interface PromptInstance extends Omit<BasePromptOptions, 'onCancel' | 'onSubmit'> {
+interface EnquirerPromptInstance extends Omit<EnquirerBasePromptOptions, 'onCancel' | 'onSubmit'> {
     submit: () => void;
@@ -533,12 +522,60 @@ cancel: (err?: string) => void;
 
-/**
- * Create a new prompt with Enquirer externally.
- * This extends enquirer so you dont have to give a name to single prompts and such so it is also
- * useful to use externally.
- * @param this
- * @param options
- * @param settings
- */
-declare function createPrompt(this: any, options: PromptOptions | PromptOptions<true>[], settings?: PromptSettings): Promise<any>;
+declare abstract class ListrPromptAdapter {
+    protected task: Task<any, any>;
+    protected wrapper: TaskWrapper<any, any>;
+    private state;
+    constructor(task: Task<any, any>, wrapper: TaskWrapper<any, any>);
+    protected reportStarted(): void;
+    protected reportFailed(): void;
+    protected reportCompleted(): void;
+    protected restoreState(): void;
+    abstract run<T = any>(...args: any[]): T | Promise<T>;
+}
 
+declare class ListrEnquirerPromptAdapter extends ListrPromptAdapter {
+    error: PromptError;
+    private prompt;
+    /**
+     * Get the current running instance of `enquirer`.
+     */
+    get instance(): EnquirerPromptInstance;
+    /**
+     * Create a new prompt with `enquirer`.
+     *
+     * `enquirer` is a peer dependency that must be installed seperately.
+     */
+    run<T = any>(options: EnquirerPromptOptions | EnquirerPromptOptions<true>[], settings?: EnquirerPromptSettings): Promise<T>;
+    /**
+     * Cancel the ongoing prompt.
+     */
+    cancel(options?: EnquirerPromptCancelOptions): void;
+}
+
+declare class ListrInquirerPromptAdapter extends ListrPromptAdapter {
+    private prompt;
+    /**
+     * Get the current running instance of `inquirer`.
+     */
+    get instance(): CancelablePromise<any>;
+    /**
+     * Create a new prompt with `inquirer`.
+     */
+    run<T extends Prompt<any, any> = Prompt<any, any>>(prompt: T, ...[config, context]: Parameters<T>): Promise<ReturnType<T>>;
+    /**
+     * Cancel the ongoing prompt.
+     */
+    cancel(): void;
+}
+
+declare class Spinner {
+    protected readonly spinner: string[];
+    private id?;
+    private spinnerPosition;
+    spin(): void;
+    fetch(): string;
+    isRunning(): boolean;
+    start(cb?: () => void, interval?: number): void;
+    stop(): void;
+}
+
 declare function getRendererClass(renderer: ListrRendererValue): ListrRendererFactory;
@@ -587,4 +624,3 @@ declare function getRenderer<Renderer extends ListrRendererValue, FallbackRenderer extends ListrRendererValue>(options: {
     task: Task<Ctx, ListrRendererFactory>;
-    private options;
-    constructor(task: Task<Ctx, ListrRendererFactory>, options: ListrBaseClassOptions<Ctx, any, any>);
+    constructor(task: Task<Ctx, ListrRendererFactory>);
     get title(): string;
@@ -631,16 +667,11 @@ /**
     /**
-     * Create a new prompt for getting user input through `enquirer`.
+     * Create a new prompt for getting user input through the prompt adapter.
+     * This will create a new prompt through the adapter if the task is not currently rendering a prompt or will return the active instance.
      *
-     * - `enquirer` is a optional peer dependency and has to be already installed separately.
+     * This part of the application requires optional peer dependencies, please refer to documentation.
      *
      * @see {@link https://listr2.kilic.dev/task/prompt.html}
      */
-    prompt<T = any>(options: PromptOptions | PromptOptions<true>[]): Promise<T>;
+    prompt<T extends ListrPromptAdapter = ListrPromptAdapter>(adapter: new (task: Task<Ctx, Renderer>, wrapper: TaskWrapper<Ctx, Renderer>) => T): T;
     /**
-     * Cancel the current active prompt, if there is any.
-     *
-     * @see {@link https://listr2.kilic.dev/task/prompt.html}
-     */
-    cancelPrompt(options?: PromptCancelOptions): void;
-    /**
      * Generates a fake stdout for your use case, where it will be tunnelled through Listr to handle the rendering process.
@@ -1403,10 +1434,2 @@ *
 /**
- * Internal error handling mechanism for Listr prompts to identify the failing cause is coming from a prompt.
- *
- * @see {@link https://listr2.kilic.dev/task/prompts.html}
- */
-declare class PromptError extends Error {
-}
-
-/**
  * Defines the task, conditions and options to run a specific task in the Listr.
@@ -1494,7 +1517,4 @@ * This defines the external API for the task where {@link TaskWrapper} is used internally.
  * Tasks can have attached prompts to them.
- *
- * - Whenever the prompt is running this should be with full with the instance of current prompt.
- * - Whenever the prompt fails/cancelled it is tracked here as well due to some internal complication with `enquirer`.
  */
-type ListrTaskPrompt = PromptInstance | PromptError;
+type ListrTaskPrompt = ListrPromptAdapter;
 /**
@@ -1547,2 +1567,14 @@ * Tasks can retry themselves when defined.
 /**
+ * Internal error handling mechanism for Listr prompts to identify the failing cause is coming from a prompt.
+ *
+ * @see {@link https://listr2.kilic.dev/task/prompts.html}
+ */
+declare class PromptError extends Error {
+}
+
+type Unionize<T extends Record<PropertyKey, unknown>> = {
+    [P in keyof T]: T[P];
+}[keyof T];
+
+/**
  * Create a new task list with Listr.
@@ -1593,2 +1625,2 @@ *
 
-export { ANSI_ESCAPE, ANSI_ESCAPE_CODES, BaseEventMap, Concurrency, DefaultRenderer, EventData, EventManager, EventMap, Figures, LISTR_DEFAULT_RENDERER_STYLE, LISTR_LOGGER_STDERR_LEVELS, LISTR_LOGGER_STYLE, Listr, ListrBaseClassOptions, ListrContext, ListrDefaultRenderer, ListrDefaultRendererCache, ListrDefaultRendererLogLevels, ListrDefaultRendererOptions, ListrDefaultRendererOptionsStyle, ListrDefaultRendererOutputBuffer, ListrDefaultRendererTask, ListrDefaultRendererTaskOptions, ListrDefaultRendererValue, ListrEnvironmentVariables, ListrError, ListrErrorTypes, ListrEventManager, ListrEventMap, ListrEventType, ListrGetRendererClassFromValue, ListrGetRendererOptions, ListrGetRendererTaskOptions, ListrGetRendererValueFromClass, ListrLogLevels, ListrLogger, ListrLoggerOptions, ListrLoggerStyleMap, ListrOptions, ListrPrimaryRendererOptions, ListrPrimaryRendererValue, ListrRenderer, ListrRendererCacheMap, ListrRendererError, ListrRendererFactory, ListrRendererOptions, ListrRendererValue, ListrSecondaryRendererOptions, ListrSecondaryRendererValue, ListrSilentRenderer, ListrSilentRendererOptions, ListrSilentRendererTask, ListrSilentRendererTaskOptions, ListrSilentRendererValue, ListrSimpleRenderer, ListrSimpleRendererCache, ListrSimpleRendererOptions, ListrSimpleRendererTask, ListrSimpleRendererTaskOptions, ListrSimpleRendererValue, ListrSubClassOptions, ListrTask, ListrTaskEventManager, ListrTaskEventMap, ListrTaskEventType, ListrTaskFn, ListrTaskMessage, Task as ListrTaskObject, ListrTaskPrompt, ListrTaskResult, ListrTaskRetry, ListrTaskState, TaskWrapper as ListrTaskWrapper, ListrTestRenderer, ListrTestRendererOptions, ListrTestRendererTask, ListrTestRendererTaskOptions, ListrTestRendererValue, ListrVerboseRenderer, ListrVerboseRendererCache, ListrVerboseRendererOptions, ListrVerboseRendererTask, ListrVerboseRendererTaskOptions, ListrVerboseRendererValue, LoggerField, LoggerFieldFn, LoggerFieldOptions, LoggerFormat, LoggerFormatOptions, Manager, PRESET_TIMER, PRESET_TIMESTAMP, PresetTimer, PresetTimestamp, ProcessOutput, ProcessOutputBuffer, ProcessOutputBufferEntry, ProcessOutputBufferOptions, ProcessOutputOptions, ProcessOutputRendererOptions, ProcessOutputStream, ProcessOutputStreamMap, PromptCancelOptions, PromptError, PromptInstance, PromptOptions, PromptOptionsMap, PromptOptionsType, PromptSettings, PromptTypes, RendererLoggerOptions, RendererPresetTimer, RendererPresetTimestamp, SilentRenderer, SimpleRenderer, Spinner, SupportedRenderer, TestRenderer, TestRendererSerializer, TestRendererSerializerOutput, TestRendererSerializerTaskKeys, Unionize, VerboseRenderer, assertFunctionOrSelf, cleanseAnsi, cloneObject, color, createPrompt, createWritable, delay, figures, getRenderer, getRendererClass, indent, isObservable, isUnicodeSupported, parseTimer, parseTimestamp, splat };
+export { ANSI_ESCAPE, ANSI_ESCAPE_CODES, BaseEventMap, Concurrency, DefaultRenderer, EnquirerPromptCancelOptions, EnquirerPromptInstance, EnquirerPromptOptions, EnquirerPromptOptionsMap, EnquirerPromptOptionsType, EnquirerPromptSettings, EnquirerPromptTypes, EventData, EventManager, EventMap, Figures, LISTR_DEFAULT_RENDERER_STYLE, LISTR_LOGGER_STDERR_LEVELS, LISTR_LOGGER_STYLE, Listr, ListrBaseClassOptions, ListrContext, ListrDefaultRenderer, ListrDefaultRendererCache, ListrDefaultRendererLogLevels, ListrDefaultRendererOptions, ListrDefaultRendererOptionsStyle, ListrDefaultRendererOutputBuffer, ListrDefaultRendererTask, ListrDefaultRendererTaskOptions, ListrDefaultRendererValue, ListrEnquirerPromptAdapter, ListrEnvironmentVariables, ListrError, ListrErrorTypes, ListrEventManager, ListrEventMap, ListrEventType, ListrGetRendererClassFromValue, ListrGetRendererOptions, ListrGetRendererTaskOptions, ListrGetRendererValueFromClass, ListrInquirerPromptAdapter, ListrLogLevels, ListrLogger, ListrLoggerOptions, ListrLoggerStyleMap, ListrOptions, ListrPrimaryRendererOptions, ListrPrimaryRendererValue, ListrPromptAdapter, ListrRenderer, ListrRendererCacheMap, ListrRendererError, ListrRendererFactory, ListrRendererOptions, ListrRendererValue, ListrSecondaryRendererOptions, ListrSecondaryRendererValue, ListrSilentRenderer, ListrSilentRendererOptions, ListrSilentRendererTask, ListrSilentRendererTaskOptions, ListrSilentRendererValue, ListrSimpleRenderer, ListrSimpleRendererCache, ListrSimpleRendererOptions, ListrSimpleRendererTask, ListrSimpleRendererTaskOptions, ListrSimpleRendererValue, ListrSubClassOptions, ListrTask, ListrTaskEventManager, ListrTaskEventMap, ListrTaskEventType, ListrTaskFn, ListrTaskMessage, Task as ListrTaskObject, ListrTaskPrompt, ListrTaskResult, ListrTaskRetry, ListrTaskState, TaskWrapper as ListrTaskWrapper, ListrTestRenderer, ListrTestRendererOptions, ListrTestRendererTask, ListrTestRendererTaskOptions, ListrTestRendererValue, ListrVerboseRenderer, ListrVerboseRendererCache, ListrVerboseRendererOptions, ListrVerboseRendererTask, ListrVerboseRendererTaskOptions, ListrVerboseRendererValue, LoggerField, LoggerFieldFn, LoggerFieldOptions, LoggerFormat, LoggerFormatOptions, Manager, PRESET_TIMER, PRESET_TIMESTAMP, PresetTimer, PresetTimestamp, ProcessOutput, ProcessOutputBuffer, ProcessOutputBufferEntry, ProcessOutputBufferOptions, ProcessOutputOptions, ProcessOutputRendererOptions, ProcessOutputStream, ProcessOutputStreamMap, PromptError, RendererLoggerOptions, RendererPresetTimer, RendererPresetTimestamp, SilentRenderer, SimpleRenderer, Spinner, SupportedRenderer, TestRenderer, TestRendererSerializer, TestRendererSerializerOutput, TestRendererSerializerTaskKeys, Unionize, VerboseRenderer, assertFunctionOrSelf, cleanseAnsi, cloneObject, color, createWritable, delay, figures, getRenderer, getRendererClass, indent, isObservable, isUnicodeSupported, parseTimer, parseTimestamp, splat };

package.json

 {
   "name": "listr2",
-  "version": "7.0.0-beta.2",
+  "version": "7.0.0-beta.3",
   "description": "Terminal task list reborn! Create beautiful CLI interfaces via easy and logical to implement task lists that feel alive and interactive.",
@@ -43,3 +43,3 @@ "license": "MIT",
     "test:read-snapshot": "./tests/read-terminal-snapshots.sh",
-    "docs:build": "vuepress build docs",
+    "docs:build": "vuepress build docs && vuepress build docs",
     "docs:dev:start": "vuepress dev docs",
@@ -90,8 +90,11 @@ "docs:dev:start:clean": "vuepress dev docs --clean-cache"
     "@cenk1cenk2/cz-cc": "^1.6.7",
-    "@cenk1cenk2/eslint-config": "^2.7.17",
+    "@cenk1cenk2/eslint-config": "^2.7.18",
+    "@inquirer/input": "^1.2.11",
+    "@inquirer/prompts": "^3.1.1",
+    "@inquirer/type": "^1.1.3",
     "@jest/globals": "^29.6.4",
-    "@swc/core": "^1.3.82",
+    "@swc/core": "1.3.82",
     "@tsconfig/node16": "^16.1.1",
     "@types/jest": "^29.5.4",
-    "@types/node": "^20.5.9",
+    "@types/node": "^20.6.0",
     "@types/wrap-ansi": "^8.0.1",
@@ -101,3 +104,3 @@ "@vuepress/client": "2.0.0-beta.67",
     "enquirer": "^2.4.1",
-    "eslint": "^8.48.0",
+    "eslint": "^8.49.0",
     "execa": "^8.0.1",
@@ -115,3 +118,3 @@ "jest": "^29.6.4",
     "tsup": "7.2.0",
-    "typedoc": "^0.25.0",
+    "typedoc": "^0.25.1",
     "typedoc-plugin-markdown": "^3.16.0",
@@ -122,6 +125,7 @@ "typescript": "^5.2.2",
     "vuepress-plugin-typedoc": "0.13.0",
-    "vuepress-theme-hope": "2.0.0-beta.236"
+    "vuepress-theme-hope": "2.0.0-beta.237"
   },
   "peerDependencies": {
-    "enquirer": ">= 2.3.0 < 3"
+    "enquirer": ">= 2.3.0 < 3",
+    "@inquirer/prompts": ">= 3 < 4"
   },
@@ -131,2 +135,5 @@ "peerDependenciesMeta": {
       "optional": true
+    },
+    "@inquirer/prompts": {
+      "optional": true
     }
@@ -133,0 +140,0 @@ },

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

291457

increased by2.9%

Lines of code

6282

increased by3.37%

Worsened metrics

Dependency count

8

increased by14.29%

Dev dependency count

34

increased by9.68%

No dependency changes