/
listr.ts
207 lines (174 loc) · 6.94 KB
/
listr.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
import { ListrRendererSelection, ListrEnvironmentVariables, ListrTaskState } from '@constants'
import type {
ListrBaseClassOptions,
ListrContext,
ListrError,
ListrGetRendererClassFromValue,
ListrGetRendererOptions,
ListrGetRendererTaskOptions,
ListrPrimaryRendererValue,
ListrRenderer,
ListrRendererFactory,
ListrRendererValue,
ListrSecondaryRendererValue,
ListrTask
} from '@interfaces'
import { ListrEventManager, Task, TaskWrapper } from '@lib'
import { Concurrency, getRenderer } from '@utils'
/**
* Create a new task list with Listr.
*
* @see {@link https://listr2.kilic.dev/listr/listr.html}
*/
export class Listr<
Ctx = ListrContext,
Renderer extends ListrRendererValue = ListrPrimaryRendererValue,
FallbackRenderer extends ListrRendererValue = ListrSecondaryRendererValue
> {
public tasks: Task<Ctx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[] = []
public errors: ListrError<Ctx>[] = []
public ctx: Ctx
public events: ListrEventManager
public path: string[] = []
public rendererClass: ListrRendererFactory
public rendererClassOptions: ListrGetRendererOptions<ListrGetRendererClassFromValue<Renderer> | ListrGetRendererClassFromValue<FallbackRenderer>>
public rendererSelection: ListrRendererSelection
public boundSignalHandler: () => void
private concurrency: Concurrency
private renderer: ListrRenderer
constructor (
public task:
| ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>
| ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<Renderer>>[],
public options?: ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>,
public parentTask?: Task<any, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>
) {
// assign over default options
this.options = {
concurrent: false,
renderer: 'default',
fallbackRenderer: 'simple',
exitOnError: true,
exitAfterRollback: true,
collectErrors: false,
registerSignalListeners: true,
...this.parentTask?.options ?? {},
...options
} as ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>
// define parallel options
if (this.options.concurrent === true) {
this.options.concurrent = Infinity
} else if (typeof this.options.concurrent !== 'number') {
this.options.concurrent = 1
}
this.concurrency = new Concurrency({ concurrency: this.options.concurrent as number })
// Update currentPath
if (parentTask) {
this.path = [ ...parentTask.listr.path, parentTask.title ]
this.errors = parentTask.listr.errors
}
if (this.parentTask?.listr.events instanceof ListrEventManager) {
this.events = this.parentTask.listr.events
} else {
this.events = new ListrEventManager()
}
// get renderer class
const renderer = getRenderer({
renderer: this.options.renderer,
rendererOptions: this.options.rendererOptions,
fallbackRenderer: this.options.fallbackRenderer,
fallbackRendererOptions: this.options.fallbackRendererOptions,
fallbackRendererCondition: this.options?.fallbackRendererCondition,
silentRendererCondition: this.options?.silentRendererCondition
})
this.rendererClass = renderer.renderer
this.rendererClassOptions = renderer.options as ListrGetRendererOptions<ListrGetRendererClassFromValue<Renderer> | ListrGetRendererClassFromValue<FallbackRenderer>>
this.rendererSelection = renderer.selection
// parse and add tasks
/* istanbul ignore next */
this.add(task ?? [])
// Graceful interrupt for render cleanup
/* istanbul ignore if */
if (this.options.registerSignalListeners) {
this.boundSignalHandler = this.signalHandler.bind(this)
process.once('SIGINT', this.boundSignalHandler).setMaxListeners(0)
}
/* istanbul ignore if */
if (this.options?.forceTTY || process.env[ListrEnvironmentVariables.FORCE_TTY]) {
process.stdout.isTTY = true
process.stderr.isTTY = true
}
/* istanbul ignore if */
if (this.options?.forceUnicode) {
process.env[ListrEnvironmentVariables.FORCE_UNICODE] = '1'
}
}
public add (tasks: ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>> | ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>>[]): void {
this.tasks.push(...this.generate(tasks))
}
public async run (context?: Ctx): Promise<Ctx> {
// start the renderer
if (!this.renderer) {
this.renderer = new this.rendererClass(this.tasks, this.rendererClassOptions, this.events)
}
await this.renderer.render()
// create a new context
this.ctx = this.options?.ctx ?? context ?? ({} as Ctx)
// check if the items are enabled
await Promise.all(this.tasks.map((task) => task.check(this.ctx)))
// run tasks
try {
await Promise.all(this.tasks.map((task) => this.concurrency.add(() => this.runTask(task))))
this.renderer.end()
process.removeListener('SIGINT', this.boundSignalHandler)
} catch (err: any) {
if (this.options.exitOnError !== false) {
this.renderer.end(err)
process.removeListener('SIGINT', this.boundSignalHandler)
// Do not exit when explicitly set to `false`
throw err
}
}
return this.ctx
}
private generate (
tasks: ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>> | ListrTask<Ctx, ListrGetRendererClassFromValue<Renderer>>[]
): Task<Ctx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[] {
tasks = Array.isArray(tasks) ? tasks : [ tasks ]
return tasks.map((task) => {
let rendererTaskOptions:
| ListrGetRendererTaskOptions<ListrGetRendererClassFromValue<Renderer>>
| ListrGetRendererTaskOptions<ListrGetRendererClassFromValue<FallbackRenderer>>
if (this.rendererSelection === ListrRendererSelection.PRIMARY) {
rendererTaskOptions = task.rendererOptions
} else if (this.rendererSelection === ListrRendererSelection.SECONDARY) {
rendererTaskOptions = task.fallbackRendererOptions
}
return new Task<Ctx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>(
this as Listr<Ctx, any, any>,
task,
this.options,
this.rendererClassOptions,
rendererTaskOptions
)
})
}
private async runTask (task: Task<Ctx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>): Promise<void> {
if (!await task.check(this.ctx)) {
return
}
return new TaskWrapper(task).run(this.ctx)
}
private signalHandler (): void {
this.tasks?.forEach(async (task) => {
if (task.isPending()) {
task.state$ = ListrTaskState.FAILED
}
})
// only the parent task shall exit
if (!this.parentTask) {
this.renderer.end(new Error('Interrupted.'))
process.exit(127)
}
}
}