@sorrell/cli-utilities 1.0.30 → 1.0.31
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -2,16 +2,23 @@ import type { DefaultRenderer, ListrDefaultRenderer, ListrGetRendererClassFromVa
|
|
|
2
2
|
export type ListrTaskWrapper<ContextType> = ListrTaskWrapperOriginal<ContextType, ListrDefaultRenderer, ListrDefaultRenderer>;
|
|
3
3
|
export type ListrConstructorTask<ContextType> = ListrTask<ContextType, ListrGetRendererClassFromValue<typeof DefaultRenderer>, ListrGetRendererClassFromValue<typeof DefaultRenderer>> | Array<ListrTask<ContextType, ListrGetRendererClassFromValue<typeof DefaultRenderer>, ListrGetRendererClassFromValue<typeof DefaultRenderer>>>;
|
|
4
4
|
export type TensedTitle = `${string}ing ${string}.`;
|
|
5
|
-
export
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
};
|
|
5
|
+
export declare namespace ListrTaskTensedCallbackReturnType {
|
|
6
|
+
type FailureOptions = {} | {
|
|
7
|
+
Throw: false;
|
|
8
|
+
} | {
|
|
9
|
+
Throw: true;
|
|
10
|
+
Message: string;
|
|
11
|
+
};
|
|
12
|
+
type Failure<ContextType> = {
|
|
13
|
+
(Options: FailureOptions, Result?: ListrTaskResult<ContextType>): ListrTaskResult<ContextType> | undefined;
|
|
14
|
+
};
|
|
15
|
+
type Success<ContextType> = {
|
|
16
|
+
(Result?: ListrTaskResult<ContextType>): ListrTaskResult<ContextType> | undefined;
|
|
17
|
+
};
|
|
18
|
+
type Exit<ContextType> = {
|
|
19
|
+
(Title: string, Result?: ListrTaskResult<ContextType>): ListrTaskResult<ContextType> | undefined;
|
|
20
|
+
};
|
|
21
|
+
}
|
|
15
22
|
/**
|
|
16
23
|
* The callbacks provided to a task wrapped by {@link ListrTaskTensed:function} to
|
|
17
24
|
* describe the state of your task when it completes (returns).
|
|
@@ -27,12 +34,12 @@ export type ListrTaskTensedReturnType<ContextType> = {
|
|
|
27
34
|
* your task succeeded, and carries the result of your task (if one exists).
|
|
28
35
|
*/
|
|
29
36
|
export type ListrTaskTensedCallbacks<ContextType> = {
|
|
30
|
-
Exit:
|
|
31
|
-
Fail:
|
|
32
|
-
Succeed:
|
|
37
|
+
Exit: ListrTaskTensedCallbackReturnType.Exit<ContextType>;
|
|
38
|
+
Fail: ListrTaskTensedCallbackReturnType.Failure<ContextType>;
|
|
39
|
+
Succeed: ListrTaskTensedCallbackReturnType.Success<ContextType>;
|
|
33
40
|
};
|
|
34
41
|
export type ListrTaskTensedFunction<ContextType> = {
|
|
35
|
-
(Context: ContextType, Task: ListrTaskWrapper<ContextType>, Callbacks: ListrTaskTensedCallbacks<ContextType>): Promise<
|
|
42
|
+
(Context: ContextType, Task: ListrTaskWrapper<ContextType>, Callbacks: ListrTaskTensedCallbacks<ContextType>): Promise<void> | Promise<ListrTaskResult<ContextType>>;
|
|
36
43
|
};
|
|
37
44
|
export type ListrTaskTensed<ContextType> = Omit<ListrTask<ContextType, ListrDefaultRenderer, ListrDefaultRenderer>, "task" | "title"> & {
|
|
38
45
|
task: ListrTaskTensedFunction<ContextType>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Listr.Types.d.ts","sourceRoot":"","sources":["../../Source/Listr/Listr.Types.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACR,eAAe,EACf,oBAAoB,EACpB,8BAA8B,EAC9B,SAAS,EACT,eAAe,IAAI,uBAAuB,EAC1C,eAAe,EACf,gBAAgB,IAAI,wBAAwB,EAAE,MAAM,QAAQ,CAAC;AAEjE,MAAM,MAAM,gBAAgB,CAAC,WAAW,IAAI,wBAAwB,CAChE,WAAW,EACX,oBAAoB,EACpB,oBAAoB,CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,WAAW,IACtC,SAAS,CACP,WAAW,EACX,8BAA8B,CAAC,OAAO,eAAe,CAAC,EACtD,8BAA8B,CAAC,OAAO,eAAe,CAAC,CAAC,GACzD,KAAK,CAAC,SAAS,CACb,WAAW,EACX,8BAA8B,CAAC,OAAO,eAAe,CAAC,EACtD,8BAA8B,CAAC,OAAO,eAAe,CAAC,CAAC,CAC1D,CAAC;AAEN,MAAM,MAAM,WAAW,GAAG,GAAI,MAAO,OAAQ,MAAO,GAAG,CAAC;AAExD,
|
|
1
|
+
{"version":3,"file":"Listr.Types.d.ts","sourceRoot":"","sources":["../../Source/Listr/Listr.Types.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACR,eAAe,EACf,oBAAoB,EACpB,8BAA8B,EAC9B,SAAS,EACT,eAAe,IAAI,uBAAuB,EAC1C,eAAe,EACf,gBAAgB,IAAI,wBAAwB,EAAE,MAAM,QAAQ,CAAC;AAEjE,MAAM,MAAM,gBAAgB,CAAC,WAAW,IAAI,wBAAwB,CAChE,WAAW,EACX,oBAAoB,EACpB,oBAAoB,CACvB,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,WAAW,IACtC,SAAS,CACP,WAAW,EACX,8BAA8B,CAAC,OAAO,eAAe,CAAC,EACtD,8BAA8B,CAAC,OAAO,eAAe,CAAC,CAAC,GACzD,KAAK,CAAC,SAAS,CACb,WAAW,EACX,8BAA8B,CAAC,OAAO,eAAe,CAAC,EACtD,8BAA8B,CAAC,OAAO,eAAe,CAAC,CAAC,CAC1D,CAAC;AAEN,MAAM,MAAM,WAAW,GAAG,GAAI,MAAO,OAAQ,MAAO,GAAG,CAAC;AAExD,yBAAiB,iCAAiC,CAClD;IACI,KAAY,cAAc,GACpB,EAAG,GACH;QACE,KAAK,EAAE,KAAK,CAAC;KAChB,GACC;QACE,KAAK,EAAE,IAAI,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC;KACnB,CAAA;IAEL,KAAY,OAAO,CAAC,WAAW,IAC3B;QACI,CAAC,OAAO,EAAE,cAAc,EAAE,MAAM,CAAC,EAAE,eAAe,CAAC,WAAW,CAAC,GAAG,eAAe,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;KAC9G,CAAC;IAEN,KAAY,OAAO,CAAC,WAAW,IAC3B;QACI,CAAC,MAAM,CAAC,EAAE,eAAe,CAAC,WAAW,CAAC,GAAG,eAAe,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;KACrF,CAAC;IAEN,KAAY,IAAI,CAAC,WAAW,IACxB;QACI,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,eAAe,CAAC,WAAW,CAAC,GAAG,eAAe,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;KACpG,CAAC;CACT;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,wBAAwB,CAAC,WAAW,IAC5C;IACI,IAAI,EAAE,iCAAiC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC1D,IAAI,EAAE,iCAAiC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC7D,OAAO,EAAE,iCAAiC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;CACnE,CAAC;AAEN,MAAM,MAAM,uBAAuB,CAAC,WAAW,IAC3C;IACI,CACI,OAAO,EAAE,WAAW,EACpB,IAAI,EAAE,gBAAgB,CAAC,WAAW,CAAC,EACnC,SAAS,EAAE,wBAAwB,CAAC,WAAW,CAAC,GACjD,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC;CAC5D,CAAC;AAEN,MAAM,MAAM,eAAe,CAAC,WAAW,IACnC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,oBAAoB,EAAE,oBAAoB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAC1F;IACI,IAAI,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;IAC3C,KAAK,EAAE,WAAW,CAAC;CACtB,CAAC;AAEN,MAAM,MAAM,eAAe,CAAC,WAAW,IACnC,uBAAuB,CACnB,WAAW,EACX,OAAO,eAAe,EACtB,OAAO,eAAe,CACzB,CAAC"}
|
|
@@ -77,7 +77,7 @@ export function NewListrTaskTensed(InTask) {
|
|
|
77
77
|
}
|
|
78
78
|
}
|
|
79
79
|
;
|
|
80
|
-
const TaskWrapper = (Context, Task) => {
|
|
80
|
+
const TaskWrapper = async (Context, Task) => {
|
|
81
81
|
/**
|
|
82
82
|
* Return a call to this function from your {@link InTask | Task} to tell
|
|
83
83
|
* {@link ListrTaskTensed:function} that your task *failed*. The `title` of the task
|
|
@@ -89,12 +89,17 @@ export function NewListrTaskTensed(InTask) {
|
|
|
89
89
|
* @returns An object describing to {@link ListrTaskTensed:function} whether your task succeeded, and
|
|
90
90
|
* what the result of your task was.
|
|
91
91
|
*/
|
|
92
|
-
function Fail(Result) {
|
|
92
|
+
function Fail(Options, Result) {
|
|
93
93
|
Task.title = GetResultTitle(false);
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
94
|
+
if ("Throws" in Options && Options.Throws) {
|
|
95
|
+
if ("Message" in Options) {
|
|
96
|
+
throw new Error(Options.Message);
|
|
97
|
+
}
|
|
98
|
+
else {
|
|
99
|
+
throw new Error();
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
return Result;
|
|
98
103
|
}
|
|
99
104
|
/**
|
|
100
105
|
* Return a call to this function from your {@link InTask | Task} to tell
|
|
@@ -109,10 +114,7 @@ export function NewListrTaskTensed(InTask) {
|
|
|
109
114
|
*/
|
|
110
115
|
function Succeed(Result) {
|
|
111
116
|
Task.title = GetResultTitle(true);
|
|
112
|
-
return
|
|
113
|
-
Result,
|
|
114
|
-
Success: true
|
|
115
|
-
};
|
|
117
|
+
return Result;
|
|
116
118
|
}
|
|
117
119
|
/**
|
|
118
120
|
* Return a call to this function from your {@link InTask | Task} to tell
|
|
@@ -133,12 +135,9 @@ export function NewListrTaskTensed(InTask) {
|
|
|
133
135
|
*/
|
|
134
136
|
function Exit(ExitTitle, Result) {
|
|
135
137
|
Task.title = ExitTitle;
|
|
136
|
-
return
|
|
137
|
-
Result,
|
|
138
|
-
Success: true
|
|
139
|
-
};
|
|
138
|
+
return Result;
|
|
140
139
|
}
|
|
141
|
-
InTask.task(Context, Task, { Exit, Fail, Succeed });
|
|
140
|
+
return InTask.task(Context, Task, { Exit, Fail, Succeed });
|
|
142
141
|
};
|
|
143
142
|
return {
|
|
144
143
|
...InTask,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Listr.js","sourceRoot":"","sources":["../../Source/Listr/Listr.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAKH,KAAK,IAAI,aAAa,EAAE,MAAM,QAAQ,CAAC;AAO3C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,yFAAyF;AACzF,MAAM,OAAO,WAAY,SAAQ,KAAK;IAElC,YAAmB,OAAe;QAE9B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;IAC9B,CAAC;IAEM,UAAU,CAAS;CAC7B;AAAA,CAAC;AAEF,MAAM,KACF,SAAQ,aAA0E;IAElF,YACI,IAAuC,EACvC,OAA4F,EAC5F,UAAqC;QAGrC,IAAI,OAAO,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EACrD,CAAC;YACG,KAAK,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC;aACI,IAAI,OAAO,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAC1D,CAAC;YACG,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACzB,CAAC;aACI,IAAI,OAAO,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAC1D,CAAC;YACG,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QACrC,CAAC;IACL,CAAC;CACJ;AAAA,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC1B,IAAuC,EACvC,mBAA2B,EAC3B,OAA4F,EAC5F,UAAqC;IAGrC,IACA,CAAC;QACG,MAAM,IAAI,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,UAAmB,EAC1B,CAAC;QACG,IAAI,UAAU,YAAY,WAAW,EACrC,CAAC;YACG,OAAO,CAAC,KAAK,CAAC,MAAO,UAAU,CAAC,UAAW,EAAE,CAAC,CAAC;QACnD,CAAC;aAED,CAAC;YACG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACxB,OAAO,CAAC,KAAK,CAAC,QAAS,mBAAoB,gCAAgC,CAAC,CAAC;QACjF,CAAC;IACL,CAAC;AACL,CAAC;AAWD,MAAM,UAAU,kBAAkB,CAC9B,MAAoC;IAGpC,kDAAkD;IAClD,SAAS,cAAc,CAAC,OAAgB;QAEpC,kGAAkG;QAClG,MAAM,KAAK,GAAkB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrD,MAAM,CAAE,sBAAsB,EAAE,GAAG,SAAS,CAAE,GAAG,KAAK,CAAC;QAEvD,IAAI,sBAAsB,KAAK,SAAS,EACxC,CAAC;YACG,OAAO,EAAE,CAAC;QACd,CAAC;QAED,IAAI,OAAO,EACX,CAAC;YACG,MAAM,SAAS,GAAW,IAAI,UAAU,CAAC,sBAAsB,CAAC,CAAC,MAAM,EAAE,CAAC;YAE1E,OAAO,CAAE,SAAS,EAAE,SAAS,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9C,CAAC;aAED,CAAC;YACG,MAAM,SAAS,GAAW,IAAI,UAAU,CAAC,sBAAsB,CAAC,CAAC,SAAS,EAAE,CAAC;YAC7E,MAAM,sBAAsB,GAAW,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAExF,OAAO,CAAE,WAAW,EAAE,sBAAsB,EAAE,SAAS,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxE,CAAC;IACL,CAAC;IAAA,CAAC;IAEF,MAAM,WAAW,GAAG,
|
|
1
|
+
{"version":3,"file":"Listr.js","sourceRoot":"","sources":["../../Source/Listr/Listr.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAKH,KAAK,IAAI,aAAa,EAAE,MAAM,QAAQ,CAAC;AAO3C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE3C,yFAAyF;AACzF,MAAM,OAAO,WAAY,SAAQ,KAAK;IAElC,YAAmB,OAAe;QAE9B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,UAAU,GAAG,OAAO,CAAC;IAC9B,CAAC;IAEM,UAAU,CAAS;CAC7B;AAAA,CAAC;AAEF,MAAM,KACF,SAAQ,aAA0E;IAElF,YACI,IAAuC,EACvC,OAA4F,EAC5F,UAAqC;QAGrC,IAAI,OAAO,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EACrD,CAAC;YACG,KAAK,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC;aACI,IAAI,OAAO,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAC1D,CAAC;YACG,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QACzB,CAAC;aACI,IAAI,OAAO,KAAK,SAAS,IAAI,UAAU,KAAK,SAAS,EAC1D,CAAC;YACG,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QACrC,CAAC;IACL,CAAC;CACJ;AAAA,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAC1B,IAAuC,EACvC,mBAA2B,EAC3B,OAA4F,EAC5F,UAAqC;IAGrC,IACA,CAAC;QACG,MAAM,IAAI,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,UAAmB,EAC1B,CAAC;QACG,IAAI,UAAU,YAAY,WAAW,EACrC,CAAC;YACG,OAAO,CAAC,KAAK,CAAC,MAAO,UAAU,CAAC,UAAW,EAAE,CAAC,CAAC;QACnD,CAAC;aAED,CAAC;YACG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACxB,OAAO,CAAC,KAAK,CAAC,QAAS,mBAAoB,gCAAgC,CAAC,CAAC;QACjF,CAAC;IACL,CAAC;AACL,CAAC;AAWD,MAAM,UAAU,kBAAkB,CAC9B,MAAoC;IAGpC,kDAAkD;IAClD,SAAS,cAAc,CAAC,OAAgB;QAEpC,kGAAkG;QAClG,MAAM,KAAK,GAAkB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrD,MAAM,CAAE,sBAAsB,EAAE,GAAG,SAAS,CAAE,GAAG,KAAK,CAAC;QAEvD,IAAI,sBAAsB,KAAK,SAAS,EACxC,CAAC;YACG,OAAO,EAAE,CAAC;QACd,CAAC;QAED,IAAI,OAAO,EACX,CAAC;YACG,MAAM,SAAS,GAAW,IAAI,UAAU,CAAC,sBAAsB,CAAC,CAAC,MAAM,EAAE,CAAC;YAE1E,OAAO,CAAE,SAAS,EAAE,SAAS,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9C,CAAC;aAED,CAAC;YACG,MAAM,SAAS,GAAW,IAAI,UAAU,CAAC,sBAAsB,CAAC,CAAC,SAAS,EAAE,CAAC;YAC7E,MAAM,sBAAsB,GAAW,SAAS,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAExF,OAAO,CAAE,WAAW,EAAE,sBAAsB,EAAE,SAAS,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxE,CAAC;IACL,CAAC;IAAA,CAAC;IAEF,MAAM,WAAW,GAAG,KAAK,EACrB,OAAoB,EACpB,IAAmC,EACS,EAAE;QAE9C;;;;;;;;;;WAUG;QACH,SAAS,IAAI,CACT,OAAyD,EACzD,MAAqC;YAGrC,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;YAEnC,IAAI,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,EACzC,CAAC;gBACG,IAAI,SAAS,IAAI,OAAO,EACxB,CAAC;oBACG,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACrC,CAAC;qBAED,CAAC;oBACG,MAAM,IAAI,KAAK,EAAE,CAAC;gBACtB,CAAC;YACL,CAAC;YAED,OAAO,MAAM,CAAC;QAClB,CAAC;QAED;;;;;;;;;;WAUG;QACH,SAAS,OAAO,CAAC,MAAqC;YAElD,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;YAElC,OAAO,MAAM,CAAC;QAClB,CAAC;QAED;;;;;;;;;;;;;;;;WAgBG;QACH,SAAS,IAAI,CACT,SAAiB,EACjB,MAAqC;YAGrC,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;YAEvB,OAAO,MAAM,CAAC;QAClB,CAAC;QAED,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC,CAAC;IAEF,OAAO;QACH,GAAG,MAAM;QACT,IAAI,EAAE,WAAW;KACpB,CAAC;AACN,CAAC"}
|