listr2 - npm Package Compare versions
Comparing version 6.0.0-beta.18 to 6.0.0-beta.19
@@ -178,6 +178,10 @@ import Enquirer from 'enquirer'; | ||
| /** | ||
| * A internal logger for using in the verbose renderer mostly. | ||
| * Creates a new Listr2 logger. | ||
| * | ||
| * This logger is used throughout the renderers for consistency. | ||
| * | ||
| * @see {@link https://listr2.kilic.dev/renderer/logger.html} | ||
| */ | ||
| declare class ListrLogger<Levels extends string = ListrLogLevels> { | ||
| protected readonly options?: ListrLoggerOptions<Levels>; | ||
| declare class ListrLogger<Levels extends string = string> { | ||
| options?: ListrLoggerOptions<Levels>; | ||
| readonly process: ProcessOutput; | ||
@@ -203,3 +207,3 @@ constructor(options?: ListrLoggerOptions<Levels>); | ||
| */ | ||
| interface ListrLoggerOptions<Levels extends string, T = any> extends ProcessOutputRendererOptions { | ||
| interface ListrLoggerOptions<Levels extends string> extends ProcessOutputRendererOptions, ListrLoggerStyleMap<Levels | string> { | ||
| /** | ||
@@ -212,21 +216,18 @@ * Use icons for the log levels. | ||
| */ | ||
| fieldOptions?: LoggerFieldOptions<true>; | ||
| fields?: LoggerFieldOptions<true>; | ||
| /** | ||
| * Style map for coloring and icons. | ||
| */ | ||
| style?: ListrLoggerStyleMap<Levels | string>; | ||
| /** | ||
| * Pass custom options to user created logger on different environments. | ||
| * | ||
| * Not used on the default logger. | ||
| */ | ||
| user?: T; | ||
| /** | ||
| * Send the designated levels to `process.stderr`. | ||
| */ | ||
| toStderr?: Levels | string[]; | ||
| toStderr?: (Levels | string)[]; | ||
| } | ||
| /** | ||
| * Inject your custom style map consisting of icons and coloring for the ListrLogger. | ||
| * | ||
| * @see {@link https://listr2.kilic.dev/renderer/logger.html} | ||
| */ | ||
| interface ListrLoggerStyleMap<Levels extends string> { | ||
| /** | ||
| * Coloring of the levels. | ||
| * | ||
| * @see {@link https://listr2.kilic.dev/renderer/logger.html#style} | ||
| */ | ||
@@ -236,2 +237,4 @@ color?: Partial<Record<Levels, LoggerFormat>>; | ||
| * Icons of the levels. | ||
| * | ||
| * @see {@link https://listr2.kilic.dev/renderer/logger.html#style} | ||
| */ | ||
@@ -270,3 +273,3 @@ icon?: Partial<Record<Levels, string>>; | ||
| type LoggerField<Args extends any[] = any[]> = LoggerFieldFn<Args> | string; | ||
| interface LoggerRendererOptions<Levels extends string = ListrLogLevels> { | ||
| interface RendererLoggerOptions<Levels extends string> { | ||
| /** | ||
@@ -277,9 +280,3 @@ * Inject your custom implementation of the ListrLogger. | ||
| */ | ||
| logger?: typeof ListrLogger; | ||
| /** | ||
| * Inject your settings for the ListrLogger. | ||
| * | ||
| * @see {@link https://listr2.kilic.dev/renderer/logger.html} | ||
| */ | ||
| loggerOptions?: ListrLoggerOptions<Levels>; | ||
| logger?: ListrLogger<Levels>; | ||
| } | ||
@@ -301,2 +298,3 @@ | ||
| declare const LISTR_LOGGER_STYLE: ListrLoggerStyleMap<ListrLogLevels>; | ||
| declare const LISTR_LOGGER_STDERR_LEVELS: ListrLogLevels[]; | ||
@@ -336,2 +334,9 @@ interface ProcessOutputBufferEntry { | ||
| /** | ||
| * Creates a new Listr2 process-output controller. | ||
| * | ||
| * This is used to control the flow to `process.stdout` and `process.stderr` for all renderers. | ||
| * | ||
| * @see {@link https://listr2.kilic.dev/renderer/process-output.html} | ||
| */ | ||
| declare class ProcessOutput { | ||
@@ -729,3 +734,3 @@ readonly stream: { | ||
| declare enum ListrDefaultRendererListrLogLevels { | ||
| declare enum ListrDefaultRendererLogLevels { | ||
| SKIPPED_WITH_COLLAPSE = "SKIPPED_WITH_COLLAPSE", | ||
@@ -747,3 +752,3 @@ SKIPPED_WITHOUT_COLLAPSE = "SKIPPED_WITHOUT_COLLAPSE", | ||
| } | ||
| declare const LISTR_DEFAULT_RENDERER_STYLE: ListrLoggerStyleMap<ListrDefaultRendererListrLogLevels>; | ||
| declare const LISTR_DEFAULT_RENDERER_STYLE: ListrLoggerStyleMap<ListrDefaultRendererLogLevels>; | ||
@@ -815,5 +820,5 @@ declare class DefaultRenderer implements ListrRenderer { | ||
| type ListrDefaultRendererOptionsStyle = ListrLoggerStyleMap<ListrDefaultRendererListrLogLevels>; | ||
| type ListrDefaultRendererOptionsStyle = ListrLoggerStyleMap<ListrDefaultRendererLogLevels>; | ||
| type ListrDefaultRendererTask = Task<any, typeof DefaultRenderer>; | ||
| interface ListrDefaultRendererOptions extends RendererPresetTimer, LoggerRendererOptions<ListrDefaultRendererListrLogLevels> { | ||
| interface ListrDefaultRendererOptions extends RendererPresetTimer, RendererLoggerOptions<ListrDefaultRendererLogLevels>, ListrLoggerStyleMap<ListrDefaultRendererLogLevels> { | ||
| /** | ||
@@ -983,3 +988,3 @@ * Indentation per-level. | ||
| type ListrSimpleRendererTask = Task<any, typeof SimpleRenderer>; | ||
| interface ListrSimpleRendererOptions extends RendererPresetTimer, RendererPresetTimestamp, LoggerRendererOptions { | ||
| interface ListrSimpleRendererOptions extends RendererPresetTimer, RendererPresetTimestamp, RendererLoggerOptions<ListrLogLevels>, ListrLoggerStyleMap<ListrLogLevels> { | ||
| } | ||
@@ -1011,3 +1016,3 @@ interface ListrSimpleRendererTaskOptions extends RendererPresetTimer { | ||
| type ListrTestRendererTask = Task<any, typeof TestRenderer>; | ||
| interface ListrTestRendererOptions extends LoggerRendererOptions { | ||
| interface ListrTestRendererOptions extends RendererLoggerOptions<ListrLogLevels> { | ||
| /** | ||
@@ -1072,3 +1077,3 @@ * Log subtasks. | ||
| type ListrVerboseRendererTask = Task<any, typeof VerboseRenderer>; | ||
| interface ListrVerboseRendererOptions extends RendererPresetTimer, RendererPresetTimestamp, LoggerRendererOptions { | ||
| interface ListrVerboseRendererOptions extends RendererPresetTimer, RendererPresetTimestamp, RendererLoggerOptions<ListrLogLevels>, ListrLoggerStyleMap<ListrLogLevels> { | ||
| /** | ||
@@ -1302,10 +1307,2 @@ * Log the title changes of the task. | ||
| } | ||
| /** | ||
| * 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 { | ||
| constructor(message: string); | ||
| } | ||
@@ -1323,2 +1320,11 @@ /** | ||
| /** | ||
| * 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 { | ||
| constructor(message: string); | ||
| } | ||
| /** | ||
| * Defines the task, conditions and options to run a specific task in the Listr. | ||
@@ -1455,3 +1461,5 @@ * This defines the external API for the task where {@link TaskWrapper} is used internally. | ||
| /** | ||
| * Creates a new set of Listr2 task list. | ||
| * Create a new task list with Listr. | ||
| * | ||
| * @see {@link https://listr2.kilic.dev/listr/listr.html} | ||
| */ | ||
@@ -1482,2 +1490,4 @@ declare class Listr<Ctx = ListrContext, Renderer extends ListrRendererValue = ListrDefaultRendererValue, FallbackRenderer extends ListrRendererValue = ListrFallbackRendererValue> { | ||
| * Useful for creating a single instance of Listr2 with pre-set settings. | ||
| * | ||
| * @see {@link https://listr2.kilic.dev/listr/manager.html} | ||
| */ | ||
@@ -1498,2 +1508,2 @@ declare class Manager<Ctx = ListrContext, Renderer extends ListrRendererValue = 'default', FallbackRenderer extends ListrRendererValue = 'verbose'> { | ||
| export { ANSI_ESCAPE, ANSI_ESCAPE_CODES, BaseEventMap, Concurrency, DefaultRenderer, EventData, EventManager, EventMap, Figures, LISTR_DEFAULT_RENDERER_STYLE, LISTR_LOGGER_STYLE, Listr, ListrBaseClassOptions, ListrContext, ListrDefaultRenderer, ListrDefaultRendererListrLogLevels, ListrDefaultRendererOptions, ListrDefaultRendererOptionsStyle, ListrDefaultRendererTask, ListrDefaultRendererTaskOptions, ListrDefaultRendererValue, ListrEnvironmentVariables, ListrError, ListrErrorTypes, ListrEventManager, ListrEventMap, ListrEventType, ListrFallbackRenderer, ListrFallbackRendererValue, ListrGetRendererClassFromValue, ListrGetRendererOptions, ListrGetRendererTaskOptions, ListrGetRendererValueFromClass, ListrLogLevels, ListrLogger, ListrLoggerOptions, ListrLoggerStyleMap, ListrOptions, ListrPrimaryRendererOptions, ListrRenderer, ListrRendererFactory, ListrRendererOptions, ListrRendererValue, ListrSecondaryRendererOptions, 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, ListrVerboseRendererOptions, ListrVerboseRendererTask, ListrVerboseRendererTaskOptions, 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, 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, ListrDefaultRendererLogLevels, ListrDefaultRendererOptions, ListrDefaultRendererOptionsStyle, ListrDefaultRendererTask, ListrDefaultRendererTaskOptions, ListrDefaultRendererValue, ListrEnvironmentVariables, ListrError, ListrErrorTypes, ListrEventManager, ListrEventMap, ListrEventType, ListrFallbackRenderer, ListrFallbackRendererValue, ListrGetRendererClassFromValue, ListrGetRendererOptions, ListrGetRendererTaskOptions, ListrGetRendererValueFromClass, ListrLogLevels, ListrLogger, ListrLoggerOptions, ListrLoggerStyleMap, ListrOptions, ListrPrimaryRendererOptions, ListrRenderer, ListrRendererFactory, ListrRendererOptions, ListrRendererValue, ListrSecondaryRendererOptions, 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, ListrVerboseRendererOptions, ListrVerboseRendererTask, ListrVerboseRendererTaskOptions, LoggerField, LoggerFieldFn, LoggerFieldOptions, LoggerFormat, Manager, PRESET_TIMER, PRESET_TIMESTAMP, PresetTimer, PresetTimestamp, ProcessOutput, ProcessOutputBuffer, ProcessOutputBufferEntry, ProcessOutputBufferOptions, ProcessOutputRendererOptions, ProcessOutputStream, 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 }; |
| { | ||
| "name": "listr2", | ||
| "version": "6.0.0-beta.18", | ||
| "version": "6.0.0-beta.19", | ||
| "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", |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis 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
LicenseThis 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
- increased by0.47%
204153
- Lines of code
- increased by0.29%
5588
No dependency changes