listr2 - npm Package Compare versions

Comparing version 6.2.0 to 6.3.0

dist/index.d.ts

@@ -108,3 +108,5 @@ import Enquirer from 'enquirer';
      */
-    MESSAGE = "MESSAGE"
+    MESSAGE = "MESSAGE",
+    /** The current Task is closed and no further action in expected. */
+    CLOSED = "CLOSED"
 }
@@ -677,2 +679,4 @@
     private taskFn;
+    /** Marks the task as closed. This is different from finalized since this is not really related to task itself. */
+    private closed;
     constructor(listr: Listr<Ctx, any, any>, task: ListrTask<Ctx, any>, options: ListrOptions, rendererOptions: ListrGetRendererOptions<Renderer>);
@@ -737,2 +741,4 @@ /**
     isPaused(): boolean;
+    /** Returns whether this task is closed. */
+    isClosed(): boolean;
     /** Pause the given task for certain time. */
@@ -742,3 +748,3 @@ pause(time: number): Promise<void>;
     run(context: Ctx, wrapper: TaskWrapper<Ctx, Renderer>): Promise<void>;
-    private emitShouldRefreshRender;
+    private close;
 }
@@ -783,7 +789,5 @@
     private wrap;
+    private readonly cache;
     constructor(tasks: ListrDefaultRendererTask[], options: ListrDefaultRendererOptions, events: ListrEventManager);
-    getTaskOptions(task: ListrDefaultRendererTask): ListrDefaultRendererTaskOptions;
     isBottomBar(task: ListrDefaultRendererTask): boolean;
-    hasPersistentOutput(task: ListrDefaultRendererTask): boolean;
-    getSelfOrParentOption<K extends keyof ListrDefaultRendererOptions>(task: ListrDefaultRendererTask, key: K): ListrDefaultRendererOptions[K];
     render(): Promise<void>;
@@ -802,2 +806,4 @@ update(): void;
     private renderPrompt;
+    private calculate;
+    private reset;
     private dump;
@@ -949,2 +955,8 @@ private indent;
     suffixRetries?: boolean;
+    /**
+     * Show duration for the pauses.
+     *
+     * @defaultValue `PRESET_TIMER`
+     */
+    pausedTimer?: PresetTimer;
 }
@@ -972,2 +984,8 @@ interface ListrDefaultRendererTaskOptions extends RendererPresetTimer {
 }
+interface ListrDefaultRendererCache {
+    output: ListrDefaultRendererCacheMap<string[]>;
+    rendererOptions: ListrDefaultRendererCacheMap<ListrDefaultRendererOptions>;
+    rendererTaskOptions: ListrDefaultRendererCacheMap<ListrDefaultRendererTaskOptions>;
+}
+type ListrDefaultRendererCacheMap<T> = Map<ListrDefaultRendererTask['id'], T>;
 
@@ -996,7 +1014,9 @@ declare class SilentRenderer implements ListrRenderer {
     private readonly logger;
+    private readonly cache;
     constructor(tasks: ListrSimpleRendererTask[], options: ListrSimpleRendererOptions);
     end(): void;
     render(): void;
-    getSelfOrParentOption<K extends keyof ListrSimpleRendererOptions>(task: ListrSimpleRendererTask, key: K): ListrSimpleRendererOptions[K];
     private renderer;
+    private calculate;
+    private reset;
 }
@@ -1006,5 +1026,16 @@
 interface ListrSimpleRendererOptions extends RendererPresetTimer, RendererPresetTimestamp, RendererLoggerOptions<ListrLogLevels>, ListrLoggerStyleMap<ListrLogLevels> {
+    /**
+     * Show duration for the pauses.
+     *
+     * @defaultValue `PRESET_TIMER`
+     */
+    pausedTimer?: PresetTimer;
 }
 interface ListrSimpleRendererTaskOptions extends RendererPresetTimer {
 }
+interface ListrSimpleRendererCache {
+    rendererOptions: ListrSimpleRendererCacheMap<ListrSimpleRendererOptions>;
+    rendererTaskOptions: ListrSimpleRendererCacheMap<ListrSimpleRendererTaskOptions>;
+}
+type ListrSimpleRendererCacheMap<T> = Map<ListrSimpleRendererTask['id'], T>;
 
@@ -1085,7 +1116,9 @@ declare class TestRenderer implements ListrRenderer {
     private logger;
+    private readonly cache;
     constructor(tasks: ListrVerboseRendererTask[], options: ListrVerboseRendererOptions);
     render(): void;
     end(): void;
-    getSelfOrParentOption<K extends keyof ListrVerboseRendererOptions>(task: ListrVerboseRendererTask, key: K): ListrVerboseRendererOptions[K];
     private renderer;
+    private calculate;
+    private reset;
 }
@@ -1101,5 +1134,16 @@
     logTitleChange?: boolean;
+    /**
+     * Show duration for the pauses.
+     *
+     * @defaultValue `PRESET_TIMER`
+     */
+    pausedTimer?: PresetTimer;
 }
 interface ListrVerboseRendererTaskOptions extends RendererPresetTimer {
 }
+interface ListrVerboseRendererCache {
+    rendererOptions: ListrVerboseRendererCacheMap<ListrVerboseRendererOptions>;
+    rendererTaskOptions: ListrVerboseRendererCacheMap<ListrVerboseRendererTaskOptions>;
+}
+type ListrVerboseRendererCacheMap<T> = Map<ListrVerboseRendererTask['id'], T>;
 
@@ -1340,2 +1384,8 @@ /** Name of the default renderer. */
 /**
+ * Internal error coming from renderer.
+ */
+declare class ListrRendererError extends Error {
+}
+
+/**
  * Internal error handling mechanism for Listr prompts to identify the failing cause is coming from a prompt.
@@ -1346,3 +1396,2 @@ *
 declare class PromptError extends Error {
-    constructor(message: string);
 }
@@ -1418,2 +1467,4 @@
      * - Whenever the preferred renderer has no options it will be displayed as never.
+     *
+     * **This option will be deprecated in a future major release in favor of having options for both the default and the fallback renderer.**
      */
@@ -1480,2 +1531,3 @@ options?: ListrGetRendererTaskOptions<Renderer>;
     [ListrTaskEventType.PROMPT]: string;
+    [ListrTaskEventType.CLOSED]: never;
 }
@@ -1529,2 +1581,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, ListrDefaultRendererLogLevels, ListrDefaultRendererOptions, ListrDefaultRendererOptionsStyle, ListrDefaultRendererTask, ListrDefaultRendererTaskOptions, ListrDefaultRendererValue, ListrEnvironmentVariables, ListrError, ListrErrorTypes, ListrEventManager, ListrEventMap, ListrEventType, ListrGetRendererClassFromValue, ListrGetRendererOptions, ListrGetRendererTaskOptions, ListrGetRendererValueFromClass, ListrLogLevels, ListrLogger, ListrLoggerOptions, ListrLoggerStyleMap, ListrOptions, ListrPrimaryRendererOptions, ListrPrimaryRendererValue, ListrRenderer, ListrRendererFactory, ListrRendererOptions, ListrRendererValue, ListrSecondaryRendererOptions, ListrSecondaryRendererValue, ListrSilentRenderer, ListrSilentRendererOptions, ListrSilentRendererTask, ListrSilentRendererTaskOptions, ListrSilentRendererValue, ListrSimpleRenderer, 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, 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, delay, figures, getRenderer, getRendererClass, indent, isObservable, isUnicodeSupported, parseTimer, parseTimestamp, splat };
+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, ListrDefaultRendererCacheMap, ListrDefaultRendererLogLevels, ListrDefaultRendererOptions, ListrDefaultRendererOptionsStyle, ListrDefaultRendererTask, ListrDefaultRendererTaskOptions, ListrDefaultRendererValue, ListrEnvironmentVariables, ListrError, ListrErrorTypes, ListrEventManager, ListrEventMap, ListrEventType, ListrGetRendererClassFromValue, ListrGetRendererOptions, ListrGetRendererTaskOptions, ListrGetRendererValueFromClass, ListrLogLevels, ListrLogger, ListrLoggerOptions, ListrLoggerStyleMap, ListrOptions, ListrPrimaryRendererOptions, ListrPrimaryRendererValue, ListrRenderer, ListrRendererError, ListrRendererFactory, ListrRendererOptions, ListrRendererValue, ListrSecondaryRendererOptions, ListrSecondaryRendererValue, ListrSilentRenderer, ListrSilentRendererOptions, ListrSilentRendererTask, ListrSilentRendererTaskOptions, ListrSilentRendererValue, ListrSimpleRenderer, ListrSimpleRendererCache, ListrSimpleRendererCacheMap, 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, ListrVerboseRendererCacheMap, 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, delay, figures, getRenderer, getRendererClass, indent, isObservable, isUnicodeSupported, parseTimer, parseTimestamp, splat };

package.json

 {
   "name": "listr2",
-  "version": "6.2.0",
+  "version": "6.3.0",
   "description": "Terminal task list reborn! Create beautiful CLI interfaces via easy and logical to implement task lists that feel alive and interactive.",
@@ -5,0 +5,0 @@ "license": "MIT",

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

215486

increased by4.13%

Lines of code

5940

increased by4.82%

No dependency changes