93 lines
5.8 KiB
TypeScript
93 lines
5.8 KiB
TypeScript
import { Subject } from 'rxjs';
|
|
import { Task } from '../lib/task';
|
|
import { DefaultRenderer } from '../renderer/default.renderer';
|
|
import { SilentRenderer } from '../renderer/silent.renderer';
|
|
import { SimpleRenderer } from '../renderer/simple.renderer';
|
|
import { VerboseRenderer } from '../renderer/verbose.renderer';
|
|
/** The default renderer value used in Listr2 applications */
|
|
export declare type ListrDefaultRendererValue = 'default';
|
|
/** Type of default renderer */
|
|
export declare type ListrDefaultRenderer = typeof DefaultRenderer;
|
|
/** Name of default fallback renderer */
|
|
export declare type ListrFallbackRendererValue = 'verbose';
|
|
/** Type of default fallback renderer */
|
|
export declare type ListrFallbackRenderer = typeof VerboseRenderer;
|
|
/** Silent rendere for internal usage */
|
|
export declare type ListrSilentRendererValue = 'silent';
|
|
/** Typeof silent renderer */
|
|
export declare type ListrSilentRenderer = typeof SilentRenderer;
|
|
/** Simple renderer that simplifies things */
|
|
export declare type ListrSimpleRendererValue = 'simple';
|
|
/** Typeof simple renderer */
|
|
export declare type ListrSimpleRenderer = typeof SimpleRenderer;
|
|
/**
|
|
* Listr2 can process either the integrated renderers as string aliases,
|
|
* or utilize a compatible style renderer that extends the ListrRenderer abstract class.
|
|
*/
|
|
export declare type ListrRendererValue = ListrSilentRendererValue | ListrDefaultRendererValue | ListrSimpleRendererValue | ListrFallbackRendererValue | ListrRendererFactory;
|
|
/**
|
|
* Returns the class type from friendly names of the renderers.
|
|
*/
|
|
export declare type ListrGetRendererClassFromValue<T extends ListrRendererValue> = T extends ListrDefaultRendererValue ? ListrDefaultRenderer : T extends ListrSimpleRendererValue ? ListrSimpleRenderer : T extends ListrFallbackRendererValue ? ListrFallbackRenderer : T extends ListrSilentRenderer ? ListrSilentRenderer : T extends ListrRendererFactory ? T : never;
|
|
/**
|
|
* Returns the friendly names from the type of renderer classes.
|
|
*/
|
|
export declare type ListrGetRendererValueFromClass<T extends ListrRendererFactory> = T extends DefaultRenderer ? ListrDefaultRendererValue : T extends SimpleRenderer ? ListrSimpleRendererValue : T extends VerboseRenderer ? ListrFallbackRendererValue : T extends SilentRenderer ? ListrSilentRenderer : T extends ListrRendererFactory ? T : never;
|
|
/**
|
|
* Returns renderer global options depending on the renderer type.
|
|
*/
|
|
export declare type ListrGetRendererOptions<T extends ListrRendererValue> = T extends ListrDefaultRendererValue ? ListrDefaultRenderer['rendererOptions'] : T extends ListrSimpleRendererValue ? ListrSimpleRenderer['rendererOptions'] : T extends ListrFallbackRendererValue ? ListrFallbackRenderer['rendererOptions'] : T extends ListrSilentRenderer ? ListrSilentRenderer['rendererOptions'] : T extends ListrRendererFactory ? T['rendererOptions'] : never;
|
|
/**
|
|
* Returns renderer per task options depending on the renderer type.
|
|
*/
|
|
export declare type ListrGetRendererTaskOptions<T extends ListrRendererValue> = T extends ListrDefaultRendererValue ? ListrDefaultRenderer['rendererTaskOptions'] : T extends ListrSimpleRendererValue ? ListrSimpleRenderer : T extends ListrFallbackRendererValue ? ListrFallbackRenderer['rendererTaskOptions'] : T extends ListrSilentRenderer ? ListrSilentRenderer['rendererTaskOptions'] : T extends ListrRendererFactory ? T['rendererTaskOptions'] : never;
|
|
/** Select renderer as default renderer */
|
|
export interface ListrDefaultRendererOptions<T extends ListrRendererValue> {
|
|
/** the default renderer */
|
|
renderer?: T;
|
|
/** Renderer options depending on the current renderer */
|
|
rendererOptions?: ListrGetRendererOptions<T>;
|
|
}
|
|
/** Select a fallback renderer to fallback to in non-tty conditions */
|
|
export interface ListrDefaultNonTTYRendererOptions<T extends ListrRendererValue> {
|
|
/** the fallback renderer to fallback to on non-tty conditions */
|
|
nonTTYRenderer?: T;
|
|
/** Renderer options depending on the current renderer */
|
|
nonTTYRendererOptions?: ListrGetRendererOptions<T>;
|
|
}
|
|
/** Renderer options for the base class, including setup for selecting default and fallback renderers. */
|
|
export declare type ListrRendererOptions<Renderer extends ListrRendererValue, FallbackRenderer extends ListrRendererValue> = ListrDefaultRendererOptions<Renderer> & ListrDefaultNonTTYRendererOptions<FallbackRenderer>;
|
|
/** The bones of a listr renderer. */
|
|
export declare class ListrRenderer {
|
|
/** designate renderer global options that is specific to the current renderer */
|
|
static rendererOptions: Record<string, any>;
|
|
/** designate renderer per task options that is specific to the current renderer */
|
|
static rendererTaskOptions: Record<string, any>;
|
|
/** designate whether this renderer can work in non-tty environments */
|
|
static nonTTY: boolean;
|
|
/** A function to what to do on render */
|
|
render: () => void;
|
|
/** A function to what to do on end of the render */
|
|
end: (err?: Error) => void;
|
|
/** create a new renderer */
|
|
constructor(tasks: readonly Task<any, ListrRendererFactory>[], options: typeof ListrRenderer.rendererOptions, renderHook$?: Subject<void>);
|
|
}
|
|
/** Exported for javascript applications to extend the base renderer */
|
|
export declare class ListrBaseRenderer implements ListrRenderer {
|
|
static rendererOptions: Record<string, any>;
|
|
static rendererTaskOptions: Record<string, any>;
|
|
static nonTTY: boolean;
|
|
tasks: Task<any, typeof ListrBaseRenderer>[];
|
|
options: typeof ListrBaseRenderer.rendererOptions;
|
|
render: () => void;
|
|
end: (err?: Error) => void;
|
|
constructor(tasks: Task<any, typeof ListrBaseRenderer>[], options: typeof ListrBaseRenderer.rendererOptions);
|
|
}
|
|
/** A renderer factory from the current type */
|
|
export declare type ListrRendererFactory = typeof ListrRenderer;
|
|
/** Supported type of renderers for each type in the listr. */
|
|
export interface SupportedRenderer {
|
|
renderer: ListrRendererFactory;
|
|
nonTTY: boolean;
|
|
}
|