@listr2/manager 1.0.0-beta.2

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Cenk Kilic <cenk@kilic.dev> (https://srcs.kilic.dev)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,15 @@
+# @listr2/manager
+
+[![Pipeline](https://gitlab.kilic.dev/libraries/listr2/badges/master/pipeline.svg?style=flat-square&ignore_skipped=true)](https://gitlab.kilic.dev/libraries/listr2/-/commits/master) [![Version](https://img.shields.io/npm/v/listr2.svg?style=flat-square&logo=npm)](https://www.npmjs.com/package/listr2?activeTab=versions) [![Downloads](https://img.shields.io/npm/dm/listr2.svg?style=flat-square&logo=npm)](https://www.npmjs.com/package/listr2) [![Size](https://img.shields.io/bundlephobia/min/listr2?style=flat-square&logo=npm)](https://www.npmjs.com/package/listr2) [![Dependencies](https://img.shields.io/librariesio/release/npm/listr2?style=flat-square&logo=npm)](https://www.npmjs.com/package/listr2?activeTab=dependencies) [![codecov](https://codecov.io/gh/listr2/listr2/branch/master/graph/badge.svg?style=flat-square)](https://codecov.io/gh/listr2/listr2)
+
+[![github sponsors](https://img.shields.io/github/sponsors/cenk1cenk2?style=flat-square&logo=github)](https://github.com/sponsors/cenk1cenk2) [![opencollective](https://img.shields.io/opencollective/sponsors/listr2?label=open%20collective&logo=opencollective)](https://opencollective.com/listr2)
+
+**Create beautiful CLI interfaces via easy and logical to-implement task lists that feel alive and interactive.**
+
+---
+
+## Documentation
+
+This is an extension to [`listr2`](https://listr2.kilic.dev/) to generate a generic task manager.
+
+**[Read the documentation...](https://listr2.kilic.dev/listr/manager.html)**

package/dist/index.cjs

@@ -0,0 +1,82 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Manager: () => Manager
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/manager.ts
+var import_listr2 = require("listr2");
+var _Manager = class _Manager {
+  constructor(options) {
+    this.options = options;
+    this.errors = [];
+    this.tasks = [];
+  }
+  get ctx() {
+    return this.options.ctx;
+  }
+  set ctx(ctx) {
+    this.options.ctx = ctx;
+  }
+  add(tasks, options) {
+    options = { ...this.options, ...options };
+    this.tasks = [...this.tasks, this.indent(tasks, options)];
+  }
+  async runAll(options) {
+    options = { ...this.options, ...options };
+    const tasks = [...this.tasks];
+    this.tasks = [];
+    const ctx = await this.run(tasks, options);
+    return ctx;
+  }
+  newListr(tasks, options) {
+    return new import_listr2.Listr(tasks, options);
+  }
+  indent(tasks, options, taskOptions) {
+    options = { ...this.options, ...options };
+    if (typeof tasks === "function") {
+      return {
+        ...taskOptions,
+        task: (ctx) => this.newListr(tasks(ctx), options)
+      };
+    }
+    return {
+      ...taskOptions,
+      task: () => this.newListr(tasks, options)
+    };
+  }
+  async run(tasks, options) {
+    options = { ...this.options, ...options };
+    const task = this.newListr(tasks, options);
+    const ctx = await task.run();
+    this.errors.push(...task.errors);
+    return ctx;
+  }
+};
+__name(_Manager, "Manager");
+var Manager = _Manager;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Manager
+});

package/dist/index.d.cts

@@ -0,0 +1,24 @@
+import { ListrContext, ListrRendererValue, ListrPrimaryRendererValue, ListrSecondaryRendererValue, ListrBaseClassOptions, ListrError, ListrTask, ListrGetRendererClassFromValue, ListrSubClassOptions, Listr } from 'listr2';
+
+/**
+ * Creates a new Listr2 task manager.
+ *
+ * Useful for creating a single instance of Listr2 with pre-set settings.
+ *
+ * @see {@link https://listr2.kilic.dev/listr/manager.html}
+ */
+declare class Manager<Ctx = ListrContext, Renderer extends ListrRendererValue = ListrPrimaryRendererValue, FallbackRenderer extends ListrRendererValue = ListrSecondaryRendererValue> {
+    options?: ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>;
+    errors: ListrError[];
+    tasks: ListrTask<ListrContext, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[];
+    constructor(options?: ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>);
+    get ctx(): Ctx;
+    set ctx(ctx: Ctx);
+    add<InjectCtx = Ctx>(tasks: ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[] | ((ctx?: InjectCtx) => ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[]), options?: ListrSubClassOptions<InjectCtx, Renderer, FallbackRenderer>): void;
+    runAll<InjectCtx = Ctx>(options?: ListrBaseClassOptions<InjectCtx, Renderer, FallbackRenderer>): Promise<InjectCtx>;
+    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>;
+    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>>;
+    run<InjectCtx = Ctx>(tasks: ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[], options?: ListrBaseClassOptions<InjectCtx, Renderer, FallbackRenderer>): Promise<InjectCtx>;
+}
+
+export { Manager };

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import { ListrContext, ListrRendererValue, ListrPrimaryRendererValue, ListrSecondaryRendererValue, ListrBaseClassOptions, ListrError, ListrTask, ListrGetRendererClassFromValue, ListrSubClassOptions, Listr } from 'listr2';
+
+/**
+ * Creates a new Listr2 task manager.
+ *
+ * Useful for creating a single instance of Listr2 with pre-set settings.
+ *
+ * @see {@link https://listr2.kilic.dev/listr/manager.html}
+ */
+declare class Manager<Ctx = ListrContext, Renderer extends ListrRendererValue = ListrPrimaryRendererValue, FallbackRenderer extends ListrRendererValue = ListrSecondaryRendererValue> {
+    options?: ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>;
+    errors: ListrError[];
+    tasks: ListrTask<ListrContext, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[];
+    constructor(options?: ListrBaseClassOptions<Ctx, Renderer, FallbackRenderer>);
+    get ctx(): Ctx;
+    set ctx(ctx: Ctx);
+    add<InjectCtx = Ctx>(tasks: ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[] | ((ctx?: InjectCtx) => ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[]), options?: ListrSubClassOptions<InjectCtx, Renderer, FallbackRenderer>): void;
+    runAll<InjectCtx = Ctx>(options?: ListrBaseClassOptions<InjectCtx, Renderer, FallbackRenderer>): Promise<InjectCtx>;
+    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>;
+    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>>;
+    run<InjectCtx = Ctx>(tasks: ListrTask<InjectCtx, ListrGetRendererClassFromValue<Renderer>, ListrGetRendererClassFromValue<FallbackRenderer>>[], options?: ListrBaseClassOptions<InjectCtx, Renderer, FallbackRenderer>): Promise<InjectCtx>;
+}
+
+export { Manager };

package/dist/index.js

@@ -0,0 +1,57 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+// src/manager.ts
+import { Listr } from "listr2";
+var _Manager = class _Manager {
+  constructor(options) {
+    this.options = options;
+    this.errors = [];
+    this.tasks = [];
+  }
+  get ctx() {
+    return this.options.ctx;
+  }
+  set ctx(ctx) {
+    this.options.ctx = ctx;
+  }
+  add(tasks, options) {
+    options = { ...this.options, ...options };
+    this.tasks = [...this.tasks, this.indent(tasks, options)];
+  }
+  async runAll(options) {
+    options = { ...this.options, ...options };
+    const tasks = [...this.tasks];
+    this.tasks = [];
+    const ctx = await this.run(tasks, options);
+    return ctx;
+  }
+  newListr(tasks, options) {
+    return new Listr(tasks, options);
+  }
+  indent(tasks, options, taskOptions) {
+    options = { ...this.options, ...options };
+    if (typeof tasks === "function") {
+      return {
+        ...taskOptions,
+        task: (ctx) => this.newListr(tasks(ctx), options)
+      };
+    }
+    return {
+      ...taskOptions,
+      task: () => this.newListr(tasks, options)
+    };
+  }
+  async run(tasks, options) {
+    options = { ...this.options, ...options };
+    const task = this.newListr(tasks, options);
+    const ctx = await task.run();
+    this.errors.push(...task.errors);
+    return ctx;
+  }
+};
+__name(_Manager, "Manager");
+var Manager = _Manager;
+export {
+  Manager
+};

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@listr2/manager",
+  "version": "1.0.0-beta.2",
+  "description": "Extension for Listr2 to easily create sane defaults for task lists.",
+  "license": "MIT",
+  "repository": "https://github.com/listr2/listr2",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "author": {
+    "name": "Cenk Kilic",
+    "email": "cenk@kilic.dev",
+    "url": "https://cenk.kilic.dev"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "scripts": {
+    "build": "tsup-node",
+    "dev:start": "tsup-node --watch",
+    "format": "prettier --log-level warn --write src/ tests/ && pnpm run lint --fix",
+    "lint": "eslint --ext .ts,.js,.tsx,.jsx src/ tests/",
+    "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",
+    "test:cov": "pnpm run test --coverage",
+    "test:dev": "NODE_OPTIONS='--no-warnings --experimental-specifier-resolution=node --experimental-vm-modules --inspect=0.0.0.0:9229' pnpm run test --verbose --watchAll"
+  },
+  "lint-staged": {
+    "{src,tests}/**/*.{ts,js,tsx,jsx,spec.ts}": [
+      "prettier --log-level warn --write",
+      "eslint --fix"
+    ],
+    "*.{json,md}": [
+      "prettier --log-level warn --write"
+    ]
+  },
+  "keywords": [
+    "listr",
+    "listr2",
+    "cli",
+    "task",
+    "list",
+    "tasklist",
+    "terminal",
+    "term",
+    "console",
+    "ascii",
+    "unicode",
+    "loading",
+    "indicator",
+    "progress",
+    "busy",
+    "wait",
+    "idle"
+  ],
+  "dependencies": {},
+  "devDependencies": {
+    "listr2": "7.0.0-beta.5"
+  },
+  "peerDependencies": {
+    "listr2": "7.0.0-beta.5"
+  }
+}