listr2 - npm Package Compare versions

Comparing version 6.0.0-beta.13 to 6.0.0-beta.14

dist/index.d.ts

@@ -531,2 +531,3 @@ import { Observable } from 'rxjs';
     set title$(title: string);
+    get path(): string[];
     /**
@@ -611,3 +612,3 @@ * A function to check whether this task should run at all via enable.
     private wrap;
-    constructor(tasks: ListrDefaultRendererTasks, options: ListrDefaultRendererOptions, events: ListrEventManager);
+    constructor(tasks: ListrDefaultRendererTask[], options: ListrDefaultRendererOptions, events: ListrEventManager);
     getTaskOptions(task: Task<any, typeof DefaultRenderer>): (typeof DefaultRenderer)['rendererTaskOptions'];
@@ -666,3 +667,3 @@ isBottomBar(task: Task<any, typeof DefaultRenderer>): boolean;
 type ListrDefaultRendererOptionsStyle = ListrLoggerStyleMap<ListrDefaultRendererLogLevels>;
-type ListrDefaultRendererTasks = Task<any, typeof DefaultRenderer>[];
+type ListrDefaultRendererTask = Task<any, typeof DefaultRenderer>;
 type ListrDefaultRendererOptions = (typeof DefaultRenderer)['rendererOptions'];
@@ -810,3 +811,3 @@ interface DefaultRendererOptions extends RendererPresetTimer, LoggerRendererOptions<ListrDefaultRendererLogLevels> {
     private readonly logger;
-    constructor(tasks: ListrSimpleRendererTasks, options: ListrSimpleRendererOptions);
+    constructor(tasks: ListrSimpleRendererTask[], options: ListrSimpleRendererOptions);
     end(): void;
@@ -818,3 +819,3 @@ render(): void;
 
-type ListrSimpleRendererTasks = Task<any, typeof SimpleRenderer>[];
+type ListrSimpleRendererTask = Task<any, typeof SimpleRenderer>;
 type ListrSimpleRendererOptions = (typeof SimpleRenderer)['rendererOptions'];
@@ -836,3 +837,4 @@ interface SimpleRendererOptions extends RendererPresetTimer, RendererPresetTimestamp, LoggerRendererOptions {
     private readonly logger;
-    constructor(tasks: ListrTestRendererTasks, options: ListrTestRendererOptions);
+    private serializer;
+    constructor(tasks: ListrTestRendererTask[], options: ListrTestRendererOptions);
     render(): void;
@@ -843,11 +845,4 @@ end(): void;
 
-type ListrTestRendererTasks = Task<any, typeof TestRenderer>[];
+type ListrTestRendererTask = Task<any, typeof TestRenderer>;
 type ListrTestRendererOptions = (typeof TestRenderer)['rendererOptions'];
-declare class TestRendererEvent<T extends ListrTaskEventType> {
-    event: T;
-    data: ListrTaskEventMap[T];
-    task?: Task<any, typeof TestRenderer>;
-    constructor(event: T, data: ListrTaskEventMap[T], task?: Task<any, typeof TestRenderer>);
-    toJson(): string;
-}
 interface TestRendererOptions extends LoggerRendererOptions {
@@ -861,3 +856,16 @@ subtasks?: boolean;
     messagesToStderr?: (keyof ListrTaskMessage)[];
+    task?: false | TestRendererSerializerTaskKeys[];
 }
+declare class TestRendererSerializer {
+    options?: TestRendererOptions;
+    constructor(options?: TestRendererOptions);
+    serialize<T extends ListrTaskEventType>(event: T, data: ListrTaskEventMap[T], task?: ListrTestRendererTask): string;
+    generate<T extends ListrTaskEventType>(event: T, data: ListrTaskEventMap[T], task?: ListrTestRendererTask): TestRendererSerializerOutput<T>;
+}
+interface TestRendererSerializerOutput<T extends ListrTaskEventType> {
+    event: T;
+    data: ListrTaskEventMap[T];
+    task?: Partial<Record<TestRendererSerializerTaskKeys, unknown>>;
+}
+type TestRendererSerializerTaskKeys = Extract<keyof Task<any, typeof TestRenderer>, 'hasSubtasks' | 'hasFinalized' | 'isPending' | 'isStarted' | 'isSkipped' | 'isCompleted' | 'hasFailed' | 'isRollingBack' | 'hasRolledBack' | 'isRetrying' | 'hasReset' | 'isEnabled' | 'hasTitle' | 'isPrompt' | 'isPaused' | 'title' | 'path'>;
 
@@ -874,3 +882,3 @@ declare class VerboseRenderer implements ListrRenderer {
     private logger;
-    constructor(tasks: ListrVerboseRendererTasks, options: ListrVerboseRendererOptions);
+    constructor(tasks: ListrVerboseRendererTask[], options: ListrVerboseRendererOptions);
     render(): void;
@@ -882,3 +890,3 @@ end(): void;
 
-type ListrVerboseRendererTasks = Task<any, typeof VerboseRenderer>[];
+type ListrVerboseRendererTask = Task<any, typeof VerboseRenderer>;
 type ListrVerboseRendererOptions = (typeof VerboseRenderer)['rendererOptions'];
@@ -1254,4 +1262,5 @@ interface VerboseRendererOptions extends RendererPresetTimer, RendererPresetTimestamp, LoggerRendererOptions {
     constructor(task: ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>> | ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>>[], options?: ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>, parentTask?: Task<any, any>);
-    add(task: ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>> | ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>>[]): void;
+    add(tasks: ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>> | ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>>[]): void;
     run(context?: Ctx): Promise<Ctx>;
+    private generate;
     private runTask;
@@ -1279,2 +1288,2 @@ }
 
-export { ANSI_ESCAPE, ANSI_ESCAPE_CODES, BaseEventMap, Concurrency, DefaultRenderer, DefaultRendererOptions, DefaultRendererTaskOptions, EventData, EventManager, EventMap, Figures, LISTR_DEFAULT_RENDERER_STYLE, LISTR_LOGGER_STYLE, Listr, ListrBaseClassOptions, ListrBaseRenderer, ListrContext, ListrDefaultRenderer, ListrDefaultRendererLogLevels, ListrDefaultRendererOptions, ListrDefaultRendererOptionsStyle, ListrDefaultRendererTasks, ListrDefaultRendererValue, ListrEnvironmentVariables, ListrError, ListrErrorTypes, ListrEventManager, ListrEventMap, ListrEventType, ListrFallbackRenderer, ListrFallbackRendererValue, ListrGetRendererClassFromValue, ListrGetRendererOptions, ListrGetRendererTaskOptions, ListrGetRendererValueFromClass, ListrLogger, ListrLoggerOptions, ListrLoggerStyleMap, ListrOptions, ListrPrimaryRendererOptions, ListrRenderer, ListrRendererFactory, ListrRendererOptions, ListrRendererValue, ListrSecondaryRendererOptions, ListrSilentRenderer, ListrSilentRendererValue, ListrSimpleRenderer, ListrSimpleRendererOptions, ListrSimpleRendererTasks, ListrSimpleRendererValue, ListrSubClassOptions, ListrTask, ListrTaskEventManager, ListrTaskEventMap, ListrTaskEventType, ListrTaskFn, ListrTaskMessage, Task as ListrTaskObject, ListrTaskPrompt, ListrTaskResult, ListrTaskRetry, ListrTaskState, TaskWrapper as ListrTaskWrapper, ListrTestRenderer, ListrTestRendererOptions, ListrTestRendererTasks, ListrTestRendererValue, ListrVerboseRendererOptions, ListrVerboseRendererTasks, LogLevels, LoggerField, LoggerFieldFn, LoggerFieldOptions, LoggerFormat, LoggerRendererOptions, Manager, PRESET_TIMER, PRESET_TIMESTAMP, PresetTimer, PresetTimestamp, ProcessOutput, ProcessOutputBuffer, ProcessOutputBufferEntry, ProcessOutputBufferOptions, ProcessOutputRendererOptions, ProcessOutputStream, PromptCancelOptions, PromptError, PromptInstance, PromptOptions, PromptOptionsMap, PromptOptionsType, PromptSettings, PromptTypes, RendererPresetTimer, RendererPresetTimestamp, SilentRenderer, SimpleRenderer, SimpleRendererOptions, SimpleRendererTaskOptions, Spinner, SupportedRenderer, TestRenderer, TestRendererEvent, TestRendererOptions, Unionize, VerboseRenderer, VerboseRendererOptions, VerboseRendererTaskOptions, assertFunctionOrSelf, cleanseAnsi, cloneObject, color, createPrompt, delay, figures, generateUUID, getRenderer, getRendererClass, indent, isObservable, isUnicodeSupported, parseTimer, parseTimestamp, splat };
+export { ANSI_ESCAPE, ANSI_ESCAPE_CODES, BaseEventMap, Concurrency, DefaultRenderer, DefaultRendererOptions, DefaultRendererTaskOptions, EventData, EventManager, EventMap, Figures, LISTR_DEFAULT_RENDERER_STYLE, LISTR_LOGGER_STYLE, Listr, ListrBaseClassOptions, ListrBaseRenderer, ListrContext, ListrDefaultRenderer, ListrDefaultRendererLogLevels, ListrDefaultRendererOptions, ListrDefaultRendererOptionsStyle, ListrDefaultRendererTask, ListrDefaultRendererValue, ListrEnvironmentVariables, ListrError, ListrErrorTypes, ListrEventManager, ListrEventMap, ListrEventType, ListrFallbackRenderer, ListrFallbackRendererValue, ListrGetRendererClassFromValue, ListrGetRendererOptions, ListrGetRendererTaskOptions, ListrGetRendererValueFromClass, ListrLogger, ListrLoggerOptions, ListrLoggerStyleMap, ListrOptions, ListrPrimaryRendererOptions, ListrRenderer, ListrRendererFactory, ListrRendererOptions, ListrRendererValue, ListrSecondaryRendererOptions, ListrSilentRenderer, ListrSilentRendererValue, ListrSimpleRenderer, ListrSimpleRendererOptions, ListrSimpleRendererTask, ListrSimpleRendererValue, ListrSubClassOptions, ListrTask, ListrTaskEventManager, ListrTaskEventMap, ListrTaskEventType, ListrTaskFn, ListrTaskMessage, Task as ListrTaskObject, ListrTaskPrompt, ListrTaskResult, ListrTaskRetry, ListrTaskState, TaskWrapper as ListrTaskWrapper, ListrTestRenderer, ListrTestRendererOptions, ListrTestRendererTask, ListrTestRendererValue, ListrVerboseRendererOptions, ListrVerboseRendererTask, LogLevels, LoggerField, LoggerFieldFn, LoggerFieldOptions, LoggerFormat, LoggerRendererOptions, Manager, PRESET_TIMER, PRESET_TIMESTAMP, PresetTimer, PresetTimestamp, ProcessOutput, ProcessOutputBuffer, ProcessOutputBufferEntry, ProcessOutputBufferOptions, ProcessOutputRendererOptions, ProcessOutputStream, PromptCancelOptions, PromptError, PromptInstance, PromptOptions, PromptOptionsMap, PromptOptionsType, PromptSettings, PromptTypes, RendererPresetTimer, RendererPresetTimestamp, SilentRenderer, SimpleRenderer, SimpleRendererOptions, SimpleRendererTaskOptions, Spinner, SupportedRenderer, TestRenderer, TestRendererOptions, TestRendererSerializer, TestRendererSerializerOutput, TestRendererSerializerTaskKeys, Unionize, VerboseRenderer, VerboseRendererOptions, VerboseRendererTaskOptions, assertFunctionOrSelf, cleanseAnsi, cloneObject, color, createPrompt, delay, figures, generateUUID, getRenderer, getRendererClass, indent, isObservable, isUnicodeSupported, parseTimer, parseTimestamp, splat };

package.json

 {
   "name": "listr2",
-  "version": "6.0.0-beta.13",
+  "version": "6.0.0-beta.14",
   "description": "Terminal task list reborn! Create beautiful CLI interfaces via easy and logical to implement task lists that feel alive and interactive.",
@@ -84,5 +84,5 @@ "license": "MIT",
     "@cenk1cenk2/cz-cc": "^1.5.9",
-    "@cenk1cenk2/eslint-config": "2.6.3",
+    "@cenk1cenk2/eslint-config": "2.6.4",
     "@jest/globals": "^29.5.0",
-    "@swc/core": "^1.3.44",
+    "@swc/core": "^1.3.46",
     "@types/clone": "^2.1.1",
@@ -94,3 +94,3 @@ "@types/jest": "^29.5.0",
     "@vuepress/client": "2.0.0-beta.61",
-    "@vuepress/plugin-docsearch": "^2.0.0-beta.61",
+    "@vuepress/plugin-docsearch": "2.0.0-beta.61",
     "enquirer": "^2.3.6",
@@ -105,3 +105,3 @@ "eslint": "^8.37.0",
     "simple-git-hooks": "^2.8.0",
-    "ts-jest": "^29.0.5",
+    "ts-jest": "^29.1.0",
     "ts-node": "^10.9.1",
@@ -115,3 +115,3 @@ "tsconfig-paths": "^4.2.0",
     "vuepress": "2.0.0-beta.61",
-    "vuepress-theme-hope": "2.0.0-beta.200"
+    "vuepress-theme-hope": "2.0.0-beta.201"
   },
@@ -118,0 +118,0 @@ "peerDependencies": {

No alert changes

Improved metrics

Total package byte prevSize

197929

increased by1.12%

Lines of code

5345

increased by1.38%

No dependency changes