@listr2/manager 3.0.0 → 3.0.2
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.
- package/dist/index.cjs +79 -72
- package/dist/index.d.cts +16 -14
- package/dist/index.d.ts +16 -14
- package/dist/index.js +63 -54
- package/package.json +7 -5
package/dist/index.cjs
CHANGED
|
@@ -1,82 +1,89 @@
|
|
|
1
|
-
|
|
1
|
+
//#region rolldown:runtime
|
|
2
|
+
var __create = Object.create;
|
|
2
3
|
var __defProp = Object.defineProperty;
|
|
3
4
|
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
5
|
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
+
var __getProtoOf = Object.getPrototypeOf;
|
|
5
7
|
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
-
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
7
|
-
var __export = (target, all) => {
|
|
8
|
-
for (var name in all)
|
|
9
|
-
__defProp(target, name, { get: all[name], enumerable: true });
|
|
10
|
-
};
|
|
11
8
|
var __copyProps = (to, from, except, desc) => {
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
9
|
+
if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
|
|
10
|
+
key = keys[i];
|
|
11
|
+
if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
|
|
12
|
+
get: ((k) => from[k]).bind(null, key),
|
|
13
|
+
enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
|
|
14
|
+
});
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
18
17
|
};
|
|
19
|
-
var
|
|
18
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
|
|
19
|
+
value: mod,
|
|
20
|
+
enumerable: true
|
|
21
|
+
}) : target, mod));
|
|
20
22
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
__export(index_exports, {
|
|
24
|
-
Manager: () => Manager
|
|
25
|
-
});
|
|
26
|
-
module.exports = __toCommonJS(index_exports);
|
|
23
|
+
//#endregion
|
|
24
|
+
const listr2 = __toESM(require("listr2"));
|
|
27
25
|
|
|
28
|
-
|
|
29
|
-
|
|
26
|
+
//#region src/manager.ts
|
|
27
|
+
/**
|
|
28
|
+
* Creates a new Listr2 task manager.
|
|
29
|
+
*
|
|
30
|
+
* Useful for creating a single instance of Listr2 with pre-set settings.
|
|
31
|
+
*
|
|
32
|
+
* @see {@link https://listr2.kilic.dev/listr/manager.html}
|
|
33
|
+
*/
|
|
30
34
|
var Manager = class {
|
|
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
|
-
|
|
35
|
+
errors = [];
|
|
36
|
+
tasks = [];
|
|
37
|
+
constructor(options) {
|
|
38
|
+
this.options = options;
|
|
39
|
+
}
|
|
40
|
+
get ctx() {
|
|
41
|
+
return this.options.ctx;
|
|
42
|
+
}
|
|
43
|
+
set ctx(ctx) {
|
|
44
|
+
this.options.ctx = ctx;
|
|
45
|
+
}
|
|
46
|
+
add(tasks, options) {
|
|
47
|
+
this.tasks = [...this.tasks, this.indent(tasks, options)];
|
|
48
|
+
}
|
|
49
|
+
async runAll(options) {
|
|
50
|
+
options = {
|
|
51
|
+
...this.options,
|
|
52
|
+
...options
|
|
53
|
+
};
|
|
54
|
+
const tasks = [...this.tasks];
|
|
55
|
+
this.tasks = [];
|
|
56
|
+
const ctx = await this.run(tasks, options);
|
|
57
|
+
return ctx;
|
|
58
|
+
}
|
|
59
|
+
newListr(tasks, options) {
|
|
60
|
+
return new listr2.Listr(tasks, options);
|
|
61
|
+
}
|
|
62
|
+
indent(tasks, options, taskOptions) {
|
|
63
|
+
options = {
|
|
64
|
+
...this.options,
|
|
65
|
+
...options
|
|
66
|
+
};
|
|
67
|
+
if (typeof tasks === "function") return {
|
|
68
|
+
...taskOptions,
|
|
69
|
+
task: (ctx) => this.newListr(tasks(ctx), options)
|
|
70
|
+
};
|
|
71
|
+
return {
|
|
72
|
+
...taskOptions,
|
|
73
|
+
task: () => this.newListr(tasks, options)
|
|
74
|
+
};
|
|
75
|
+
}
|
|
76
|
+
async run(tasks, options) {
|
|
77
|
+
options = {
|
|
78
|
+
...this.options,
|
|
79
|
+
...options
|
|
80
|
+
};
|
|
81
|
+
const task = this.newListr(tasks, options);
|
|
82
|
+
const ctx = await task.run();
|
|
83
|
+
this.errors.push(...task.errors);
|
|
84
|
+
return ctx;
|
|
85
|
+
}
|
|
78
86
|
};
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
});
|
|
87
|
+
|
|
88
|
+
//#endregion
|
|
89
|
+
exports.Manager = Manager;
|
package/dist/index.d.cts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Listr, ListrBaseClassOptions, ListrContext, ListrError, ListrGetRendererClassFromValue, ListrPrimaryRendererValue, ListrRendererValue, ListrSecondaryRendererValue, ListrSubClassOptions, ListrTask } from "listr2";
|
|
2
|
+
|
|
3
|
+
//#region src/manager.d.ts
|
|
2
4
|
|
|
3
5
|
/**
|
|
4
6
|
* Creates a new Listr2 task manager.
|
|
@@ -8,17 +10,17 @@ import { ListrContext, ListrRendererValue, ListrPrimaryRendererValue, ListrSecon
|
|
|
8
10
|
* @see {@link https://listr2.kilic.dev/listr/manager.html}
|
|
9
11
|
*/
|
|
10
12
|
declare class Manager<Ctx = ListrContext, Renderer extends ListrRendererValue = ListrPrimaryRendererValue, FallbackRenderer extends ListrRendererValue = ListrSecondaryRendererValue> {
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
13
|
+
options?: ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>;
|
|
14
|
+
errors: ListrError[];
|
|
15
|
+
tasks: ListrTask<ListrContext, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[];
|
|
16
|
+
constructor(options?: ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>);
|
|
17
|
+
get ctx(): Ctx;
|
|
18
|
+
set ctx(ctx: Ctx);
|
|
19
|
+
add<InjectCtx = Ctx>(tasks: ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[] | ((ctx?: InjectCtx) => ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[]), options?: ListrSubClassOptions<InjectCtx, Renderer, FallbackRenderer>): void;
|
|
20
|
+
runAll<InjectCtx = Ctx>(options?: ListrBaseClassOptions<InjectCtx, Renderer, FallbackRenderer>): Promise<InjectCtx>;
|
|
21
|
+
newListr<InjectCtx = Ctx, InjectRenderer extends ListrRendererValue = Renderer, InjectFallbackRenderer extends ListrRendererValue = FallbackRenderer>(tasks: ListrTask<InjectCtx, ListrGetRendererClassFromValue<InjectRenderer>, ListrGetRendererClassFromValue<InjectFallbackRenderer>>[], options?: ListrBaseClassOptions<InjectCtx, InjectRenderer, InjectFallbackRenderer>): Listr<InjectCtx, InjectRenderer, InjectFallbackRenderer>;
|
|
22
|
+
indent<InjectCtx = Ctx>(tasks: ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[] | ((ctx?: InjectCtx) => ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[]), options?: ListrBaseClassOptions<InjectCtx, Renderer, FallbackRenderer>, taskOptions?: Omit<ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>, 'task'>): ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>;
|
|
23
|
+
run<InjectCtx = Ctx>(tasks: ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[], options?: ListrBaseClassOptions<InjectCtx, Renderer, FallbackRenderer>): Promise<InjectCtx>;
|
|
22
24
|
}
|
|
23
|
-
|
|
24
|
-
export { Manager };
|
|
25
|
+
//#endregion
|
|
26
|
+
export { Manager };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Listr, ListrBaseClassOptions, ListrContext, ListrError, ListrGetRendererClassFromValue, ListrPrimaryRendererValue, ListrRendererValue, ListrSecondaryRendererValue, ListrSubClassOptions, ListrTask } from "listr2";
|
|
2
|
+
|
|
3
|
+
//#region src/manager.d.ts
|
|
2
4
|
|
|
3
5
|
/**
|
|
4
6
|
* Creates a new Listr2 task manager.
|
|
@@ -8,17 +10,17 @@ import { ListrContext, ListrRendererValue, ListrPrimaryRendererValue, ListrSecon
|
|
|
8
10
|
* @see {@link https://listr2.kilic.dev/listr/manager.html}
|
|
9
11
|
*/
|
|
10
12
|
declare class Manager<Ctx = ListrContext, Renderer extends ListrRendererValue = ListrPrimaryRendererValue, FallbackRenderer extends ListrRendererValue = ListrSecondaryRendererValue> {
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
13
|
+
options?: ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>;
|
|
14
|
+
errors: ListrError[];
|
|
15
|
+
tasks: ListrTask<ListrContext, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[];
|
|
16
|
+
constructor(options?: ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>);
|
|
17
|
+
get ctx(): Ctx;
|
|
18
|
+
set ctx(ctx: Ctx);
|
|
19
|
+
add<InjectCtx = Ctx>(tasks: ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[] | ((ctx?: InjectCtx) => ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[]), options?: ListrSubClassOptions<InjectCtx, Renderer, FallbackRenderer>): void;
|
|
20
|
+
runAll<InjectCtx = Ctx>(options?: ListrBaseClassOptions<InjectCtx, Renderer, FallbackRenderer>): Promise<InjectCtx>;
|
|
21
|
+
newListr<InjectCtx = Ctx, InjectRenderer extends ListrRendererValue = Renderer, InjectFallbackRenderer extends ListrRendererValue = FallbackRenderer>(tasks: ListrTask<InjectCtx, ListrGetRendererClassFromValue<InjectRenderer>, ListrGetRendererClassFromValue<InjectFallbackRenderer>>[], options?: ListrBaseClassOptions<InjectCtx, InjectRenderer, InjectFallbackRenderer>): Listr<InjectCtx, InjectRenderer, InjectFallbackRenderer>;
|
|
22
|
+
indent<InjectCtx = Ctx>(tasks: ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[] | ((ctx?: InjectCtx) => ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[]), options?: ListrBaseClassOptions<InjectCtx, Renderer, FallbackRenderer>, taskOptions?: Omit<ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>, 'task'>): ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>;
|
|
23
|
+
run<InjectCtx = Ctx>(tasks: ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[], options?: ListrBaseClassOptions<InjectCtx, Renderer, FallbackRenderer>): Promise<InjectCtx>;
|
|
22
24
|
}
|
|
23
|
-
|
|
24
|
-
export { Manager };
|
|
25
|
+
//#endregion
|
|
26
|
+
export { Manager };
|
package/dist/index.js
CHANGED
|
@@ -1,57 +1,66 @@
|
|
|
1
|
-
var __defProp = Object.defineProperty;
|
|
2
|
-
var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
|
|
3
|
-
|
|
4
|
-
// src/manager.ts
|
|
5
1
|
import { Listr } from "listr2";
|
|
2
|
+
|
|
3
|
+
//#region src/manager.ts
|
|
4
|
+
/**
|
|
5
|
+
* Creates a new Listr2 task manager.
|
|
6
|
+
*
|
|
7
|
+
* Useful for creating a single instance of Listr2 with pre-set settings.
|
|
8
|
+
*
|
|
9
|
+
* @see {@link https://listr2.kilic.dev/listr/manager.html}
|
|
10
|
+
*/
|
|
6
11
|
var Manager = class {
|
|
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
|
-
|
|
12
|
+
errors = [];
|
|
13
|
+
tasks = [];
|
|
14
|
+
constructor(options) {
|
|
15
|
+
this.options = options;
|
|
16
|
+
}
|
|
17
|
+
get ctx() {
|
|
18
|
+
return this.options.ctx;
|
|
19
|
+
}
|
|
20
|
+
set ctx(ctx) {
|
|
21
|
+
this.options.ctx = ctx;
|
|
22
|
+
}
|
|
23
|
+
add(tasks, options) {
|
|
24
|
+
this.tasks = [...this.tasks, this.indent(tasks, options)];
|
|
25
|
+
}
|
|
26
|
+
async runAll(options) {
|
|
27
|
+
options = {
|
|
28
|
+
...this.options,
|
|
29
|
+
...options
|
|
30
|
+
};
|
|
31
|
+
const tasks = [...this.tasks];
|
|
32
|
+
this.tasks = [];
|
|
33
|
+
const ctx = await this.run(tasks, options);
|
|
34
|
+
return ctx;
|
|
35
|
+
}
|
|
36
|
+
newListr(tasks, options) {
|
|
37
|
+
return new Listr(tasks, options);
|
|
38
|
+
}
|
|
39
|
+
indent(tasks, options, taskOptions) {
|
|
40
|
+
options = {
|
|
41
|
+
...this.options,
|
|
42
|
+
...options
|
|
43
|
+
};
|
|
44
|
+
if (typeof tasks === "function") return {
|
|
45
|
+
...taskOptions,
|
|
46
|
+
task: (ctx) => this.newListr(tasks(ctx), options)
|
|
47
|
+
};
|
|
48
|
+
return {
|
|
49
|
+
...taskOptions,
|
|
50
|
+
task: () => this.newListr(tasks, options)
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
async run(tasks, options) {
|
|
54
|
+
options = {
|
|
55
|
+
...this.options,
|
|
56
|
+
...options
|
|
57
|
+
};
|
|
58
|
+
const task = this.newListr(tasks, options);
|
|
59
|
+
const ctx = await task.run();
|
|
60
|
+
this.errors.push(...task.errors);
|
|
61
|
+
return ctx;
|
|
62
|
+
}
|
|
57
63
|
};
|
|
64
|
+
|
|
65
|
+
//#endregion
|
|
66
|
+
export { Manager };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@listr2/manager",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.2",
|
|
4
4
|
"description": "Extension for Listr2 to easily create sane defaults for task lists.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": "https://github.com/listr2/listr2",
|
|
@@ -33,8 +33,8 @@
|
|
|
33
33
|
"node": ">=20.0.0"
|
|
34
34
|
},
|
|
35
35
|
"scripts": {
|
|
36
|
-
"build": "
|
|
37
|
-
"dev:start": "
|
|
36
|
+
"build": "tsdown",
|
|
37
|
+
"dev:start": "tsdown --watch",
|
|
38
38
|
"format": "prettier --log-level warn --write src/ tests/ && pnpm run lint --fix",
|
|
39
39
|
"lint": "eslint --flag v10_config_lookup_from_file src/ tests/",
|
|
40
40
|
"test": "NO_COLOR=1 TS_NODE_PROJECT=tests/tsconfig.json NODE_OPTIONS='--no-warnings --experimental-specifier-resolution=node --experimental-vm-modules' jest --config tests/jest.config.ts",
|
|
@@ -71,7 +71,9 @@
|
|
|
71
71
|
],
|
|
72
72
|
"dependencies": {},
|
|
73
73
|
"devDependencies": {
|
|
74
|
-
"listr2": "9.0.
|
|
74
|
+
"listr2": "9.0.2"
|
|
75
75
|
},
|
|
76
|
-
"peerDependencies": {
|
|
76
|
+
"peerDependencies": {
|
|
77
|
+
"listr2": "9.0.2"
|
|
78
|
+
}
|
|
77
79
|
}
|