@tsed/cli-core 7.0.0-beta.12 → 7.0.0-beta.13

package/lib/esm/index.js

@@ -7,6 +7,7 @@ export * from "./packageManagers/index.js";
 export * from "./services/index.js";
 export * from "./utils/index.js";
 export * from "@tsed/cli-prompts";
+export * from "@tsed/cli-tasks";
 export * from "@tsed/core";
 export * from "@tsed/di";
 export * from "@tsed/logger";

package/lib/esm/interfaces/index.js

@@ -5,4 +5,3 @@ export * from "./CommandOptions.js";
 export * from "./CommandProvider.js";
 export * from "./PackageJson.js";
 export * from "./ProjectPreferences.js";
-export * from "./Tasks.js";

package/lib/esm/packageManagers/PackageManagersModule.js

@@ -1,4 +1,4 @@
-import { Inject, inject, injectable, injectMany } from "@tsed/di";
+import { inject, injectable, injectMany } from "@tsed/di";
 import { EMPTY, throwError } from "rxjs";
 import { catchError } from "rxjs/operators";
 import { ProjectPackageJson } from "../services/ProjectPackageJson.js";
@@ -39,6 +39,13 @@ export class PackageManagersModule {
         this.projectPackageJson.rewrite = true;
         return packageManager.init(options);
     }
+    task(title, ctx = {}) {
+        return {
+            title,
+            type: "progress",
+            task: () => this.install(ctx)
+        };
+    }
     install(options = {}) {
         const packageManager = this.get(options.packageManager);
         options.packageManager = packageManager.name;
@@ -52,16 +59,10 @@ export class PackageManagersModule {
                 GH_TOKEN: this.projectPackageJson.GH_TOKEN
             }
         };
-        const errorPipe = () => catchError((error) => {
-            if (error.stderr.startsWith("error Your lockfile needs to be updated")) {
-                return throwError(new Error(`yarn.lock file is outdated. Run ${packageManager.name}, commit the updated lockfile and try again.`));
-            }
-            return throwError(error);
-        });
         return [
             {
                 title: "Write package.json",
-                enabled: () => this.projectPackageJson.rewrite,
+                skip: () => !this.projectPackageJson.rewrite,
                 task: () => {
                     this.projectPackageJson.write();
                 }
@@ -69,22 +70,27 @@ export class PackageManagersModule {
             {
                 title: `Installing dependencies using ${packageManager.name}`,
                 skip: () => !this.projectPackageJson.reinstall,
-                task: () => packageManager.install(options) // .pipe(errorPipe())
+                task: () => packageManager.install(options)
             },
             {
                 title: `Add dependencies using ${packageManager.name}`,
-                skip: () => !deps.length,
-                task: () => packageManager.add(deps, options) //.pipe(errorPipe())
+                enabled: !!deps.length,
+                task: () => packageManager.add(deps, options)
             },
             {
                 title: `Add devDependencies using ${packageManager.name}`,
-                skip: () => !devDeps.length,
-                task: () => packageManager.addDev(devDeps, options) //.pipe(errorPipe())
+                enabled: !!devDeps.length,
+                task: () => packageManager.addDev(devDeps, options)
+            },
+            {
+                title: `Installing dependencies using ${packageManager.name}`,
+                skip: () => !this.projectPackageJson.reinstall,
+                task: () => packageManager.install(options)
             },
             {
                 title: "Refresh",
                 task: () => {
-                    this.projectPackageJson.refresh();
+                    return this.projectPackageJson.refresh();
                 }
             }
         ];

package/lib/esm/services/CliPlugins.js

@@ -2,9 +2,7 @@ import { constant, inject, injectable } from "@tsed/di";
 import { $asyncEmit } from "@tsed/hooks";
 import chalk from "chalk";
 import { PackageManagersModule } from "../packageManagers/PackageManagersModule.js";
-import { createSubTasks } from "../utils/createTasksRunner.js";
 import { loadPlugins } from "../utils/loadPlugins.js";
-import { CliHooks } from "./CliHooks.js";
 import { NpmRegistryClient } from "./NpmRegistryClient.js";
 import { ProjectPackageJson } from "./ProjectPackageJson.js";
 function mapPlugins({ package: { name, description = "", ...otherProps } }) {
@@ -36,15 +34,7 @@ export class CliPlugins {
                 }
             };
         });
-        return [
-            ...tasks,
-            {
-                title: "Install",
-                task: createSubTasks(() => {
-                    return this.packageManagers.install(ctx);
-                }, { ...ctx, concurrent: false })
-            }
-        ];
+        return [...tasks, this.packageManagers.task("Install dependencies", ctx)];
     }
     getKeyword(keyword) {
         return `@${this.name}/cli-plugin-${this.cleanKeyword(keyword)}`;

package/lib/esm/services/CliService.js

@@ -1,12 +1,12 @@
 import { PromptRunner } from "@tsed/cli-prompts";
+import { concat, tasks as tasksRunner } from "@tsed/cli-tasks";
 import { classOf, isArrowFn } from "@tsed/core";
-import { configuration, constant, context, destroyInjector, DIContext, getContext, inject, injectable, injector, logger, Provider, runInContext } from "@tsed/di";
+import { configuration, constant, destroyInjector, DIContext, getContext, inject, injectable, injector, logger, Provider, runInContext } from "@tsed/di";
 import { $asyncAlter, $asyncEmit } from "@tsed/hooks";
 import { pascalCase } from "change-case";
 import { Argument, Command } from "commander";
 import { v4 } from "uuid";
 import { PackageManagersModule } from "../packageManagers/index.js";
-import { createSubTasks, createTasksRunner } from "../utils/createTasksRunner.js";
 import { getCommandMetadata } from "../utils/getCommandMetadata.js";
 import { mapCommanderOptions, validate } from "../utils/index.js";
 import { mapCommanderArgs } from "../utils/mapCommanderArgs.js";
@@ -63,14 +63,11 @@ export class CliService {
         $ctx.set("data", data);
         if (tasks.length) {
             if (this.reinstallAfterRun && (this.projectPkg.rewrite || this.projectPkg.reinstall)) {
-                tasks.push({
-                    title: "Install dependencies",
-                    task: createSubTasks(() => this.packageManagers.install(data), { ...data, concurrent: false })
-                }, ...(await this.getPostInstallTasks(cmdName, data)));
+                tasks.push(this.packageManagers.task("Install dependencies", data), ...(await this.getPostInstallTasks(cmdName, data)));
             }
             data = this.mapData(cmdName, data, $ctx);
             $ctx.set("data", data);
-            return createTasksRunner(tasks, data);
+            return tasksRunner(tasks, data);
         }
     }
     /**
@@ -106,30 +103,13 @@ export class CliService {
         const provider = this.commands.get(cmdName);
         const instance = inject(provider.token);
         data = this.mapData(cmdName, data, $ctx);
-        const tasks = [];
-        tasks.push(...((await instance.$exec(data)) || []));
-        tasks.push(...(await $asyncAlter(`$alter${pascalCase(cmdName)}Tasks`, [], [data])));
-        return tasks.map((opts) => {
-            return {
-                ...opts,
-                task: async (arg, task) => {
-                    context().set("currentTask", task);
-                    const result = await opts.task(arg, task);
-                    context().delete("currentTask");
-                    return result;
-                }
-            };
-        });
+        return concat(await instance.$exec(data), await $asyncAlter(`$alter${pascalCase(cmdName)}Tasks`, [], [data]));
     }
     async getPostInstallTasks(cmdName, data) {
         const provider = this.commands.get(cmdName);
         const instance = inject(provider.token);
         data = this.mapData(cmdName, data, getContext());
-        return [
-            ...(instance.$postInstall ? await instance.$postInstall(data) : []),
-            ...(await $asyncAlter(`$alter${pascalCase(cmdName)}PostInstallTasks`, [], [data])),
-            ...(instance.$afterPostInstall ? await instance.$afterPostInstall(data) : [])
-        ];
+        return concat(await instance.$postInstall?.(data), await $asyncAlter(`$alter${pascalCase(cmdName)}PostInstallTasks`, [], [data]), await instance.$afterPostInstall?.(data));
     }
     createCommand(metadata) {
         const { name, description, alias, inputSchema } = metadata;
@@ -207,7 +187,7 @@ export class CliService {
         else {
             logger().level = "info";
         }
-        data.bindLogger = $ctx.get("command")?.bindLogger;
+        data.logger = logger();
         $ctx.set("data", data);
         return data;
     }

package/lib/esm/utils/getCommandMetadata.js

@@ -1,6 +1,6 @@
 import { isArrowFn, Store } from "@tsed/core";
 export function getCommandMetadata(token) {
-    const { name, alias, args = {}, description, options = {}, enableFeatures, disableReadUpPkg, inputSchema, bindLogger = true, ...opts } = Store.from(token)?.get("command");
+    const { name, alias, args = {}, description, options = {}, enableFeatures, disableReadUpPkg, inputSchema, ...opts } = Store.from(token)?.get("command");
     return {
         name,
         inputSchema,
@@ -8,7 +8,6 @@ export function getCommandMetadata(token) {
         description,
         enableFeatures: enableFeatures || [],
         disableReadUpPkg: !!disableReadUpPkg,
-        bindLogger,
         ...opts,
         getOptions() {
             if (inputSchema) {

package/lib/esm/utils/index.js

@@ -1,5 +1,4 @@
 export * from "./createInjector.js";
-export * from "./createTasksRunner.js";
 export * from "./getCommandMetadata.js";
 export * from "./getTemplateDirectory.js";
 export * from "./loadPlugins.js";

package/lib/esm/utils/loadPlugins.js

@@ -1,3 +1,4 @@
+import { taskLogger } from "@tsed/cli-tasks";
 import { injector, lazyInject, logger } from "@tsed/di";
 import chalk from "chalk";
 import figures from "figures";
@@ -14,13 +15,13 @@ export async function loadPlugins() {
         .map(async (mod) => {
         try {
             if ($inj.settings.get("loaded")) {
-                logger().info("Try to load ", mod);
+                taskLogger().info(`Try to load ${mod}`);
                 await lazyInject(() => fs.importModule(mod, projectPackageJson.cwd));
             }
-            logger().info(chalk.green(figures.tick), mod, "module loaded");
+            taskLogger().info(`${mod} module loaded`);
         }
         catch (er) {
-            logger().warn(chalk.red(figures.cross), "Fail to load plugin", mod, er.message);
+            taskLogger().warn(`Fail to load plugin ${mod} ${er.message}`);
         }
     });
     await all(promises);

package/lib/types/fn/command.d.ts

@@ -34,11 +34,10 @@ export declare function command<Input>(options: CommandOptions<Input>): TsED.Pro
     allowUnknownOption?: boolean;
     enableFeatures?: string[];
     disableReadUpPkg?: boolean;
-    bindLogger?: boolean;
 } | {
     $prompt: any;
     $exec: any;
-    handler: (data: Input) => import("../interfaces/Tasks.js").Tasks | Promise<import("../interfaces/Tasks.js").Tasks> | any | Promise<any>;
+    handler: (data: Input) => import("@tsed/cli-tasks").MaybePromise<void | import("../interfaces/index.js").Task<Input>[]>;
     prompt?(initialOptions: Partial<Input>): import("@tsed/cli-prompts").PromptQuestion[] | Promise<import("@tsed/cli-prompts").PromptQuestion[]>;
     name: string;
     alias?: string;
@@ -53,6 +52,5 @@ export declare function command<Input>(options: CommandOptions<Input>): TsED.Pro
     allowUnknownOption?: boolean;
     enableFeatures?: string[];
     disableReadUpPkg?: boolean;
-    bindLogger?: boolean;
 }>> | TsED.ClassProviderBuilder<Type<CommandProvider<Input>>>;
 export {};

package/lib/types/index.d.ts

@@ -7,6 +7,7 @@ export * from "./packageManagers/index.js";
 export * from "./services/index.js";
 export * from "./utils/index.js";
 export * from "@tsed/cli-prompts";
+export * from "@tsed/cli-tasks";
 export * from "@tsed/core";
 export * from "@tsed/di";
 export * from "@tsed/logger";

package/lib/types/interfaces/CommandData.d.ts

@@ -7,7 +7,6 @@ declare global {
 export interface CommandData extends TsED.InitialCommandData {
     commandName?: string;
     verbose?: boolean;
-    bindLogger?: boolean;
     rawArgs?: string[];
     [key: string]: any;
 }

package/lib/types/interfaces/CommandMetadata.d.ts

@@ -2,7 +2,6 @@ import type { BaseCommandOptions, CommandArg, CommandOpts } from "./CommandOptio
 export interface CommandMetadata extends Omit<BaseCommandOptions<any>, "args" | "options" | "allowUnknownOption"> {
     enableFeatures: string[];
     disableReadUpPkg: boolean;
-    bindLogger: boolean;
     getOptions(): {
         /**
          * CommandProvider arguments

package/lib/types/interfaces/CommandOptions.d.ts

@@ -1,9 +1,9 @@
 import type { PromptQuestion } from "@tsed/cli-prompts";
+import type { MaybePromise, Task } from "@tsed/cli-tasks";
 import { Type } from "@tsed/core";
 import type { TokenProvider } from "@tsed/di";
 import type { JsonSchema } from "@tsed/schema";
 import type { CommandProvider } from "./CommandProvider.js";
-import type { Tasks } from "./Tasks.js";
 export interface CommandArg {
     /**
      * Description of the argument
@@ -79,10 +79,9 @@ export interface BaseCommandOptions<Input> {
     allowUnknownOption?: boolean;
     enableFeatures?: string[];
     disableReadUpPkg?: boolean;
-    bindLogger?: boolean;
 }
 interface FunctionalCommandOptions<Input> extends BaseCommandOptions<Input> {
-    handler: (data: Input) => Tasks | Promise<Tasks> | any | Promise<any>;
+    handler: (data: Input) => MaybePromise<Task<Input>[] | void>;
     prompt?(initialOptions: Partial<Input>): PromptQuestion[] | Promise<PromptQuestion[]>;
     [key: string]: any;
 }

package/lib/types/interfaces/CommandProvider.d.ts

@@ -1,5 +1,5 @@
 import type { PromptQuestion } from "@tsed/cli-prompts";
-import type { Tasks } from "./Tasks.js";
+import type { MaybePromise, Task } from "@tsed/cli-tasks";
 export interface CommandProvider<Ctx = any> {
     /**
      * Hook to create the main prompt for the command. Refer to {@link PromptQuestion}
@@ -16,11 +16,11 @@ export interface CommandProvider<Ctx = any> {
      * Run a command
      * @param ctx
      */
-    $exec(ctx: Ctx): Tasks | Promise<Tasks> | any | Promise<any>;
+    $exec(ctx: Ctx): MaybePromise<Task<Ctx>[] | void>;
     /**
      * Run commands after the npm/yarn install
      * @param ctx
      */
-    $postInstall?(ctx: Ctx): Tasks | Promise<Tasks> | any | Promise<any>;
-    $afterPostInstall?(ctx: Ctx): Tasks | Promise<Tasks> | any | Promise<any>;
+    $postInstall?(ctx: Ctx): MaybePromise<Task<Ctx>[] | void>;
+    $afterPostInstall?(ctx: Ctx): MaybePromise<Task<Ctx>[] | void>;
 }

package/lib/types/interfaces/index.d.ts

@@ -8,7 +8,7 @@ export * from "./CommandOptions.js";
 export * from "./CommandProvider.js";
 export * from "./PackageJson.js";
 export * from "./ProjectPreferences.js";
-export * from "./Tasks.js";
+export type { Task } from "@tsed/cli-tasks";
 declare global {
     namespace TsED {
         interface Configuration {

package/lib/types/packageManagers/PackageManagersModule.d.ts

@@ -1,3 +1,4 @@
+import type { Task } from "@tsed/cli-tasks";
 import { ProjectPackageJson } from "../services/ProjectPackageJson.js";
 import { BaseManager, type ManagerCmdOpts } from "./supports/BaseManager.js";
 export interface InstallOptions {
@@ -8,22 +9,8 @@ export declare class PackageManagersModule {
     protected projectPackageJson: ProjectPackageJson;
     protected packageManagers: BaseManager[];
     init(options?: InstallOptions): Promise<void>;
-    install(options?: InstallOptions): ({
-        title: string;
-        enabled: () => boolean;
-        task: () => void;
-        skip?: undefined;
-    } | {
-        title: string;
-        skip: () => boolean;
-        task: () => import("rxjs").Observable<any>;
-        enabled?: undefined;
-    } | {
-        title: string;
-        task: () => void;
-        enabled?: undefined;
-        skip?: undefined;
-    })[];
+    task(title: string, ctx?: InstallOptions): Task;
+    install(options?: InstallOptions): Task[];
     list(): string[];
     get(name?: string): BaseManager;
     runScript(scriptName: string, { ignoreError, ...opts }?: {

package/lib/types/services/CliService.d.ts

@@ -28,7 +28,7 @@ export declare class CliService {
      * @param $ctx
      */
     runLifecycle(cmdName: string, data: CommandData | undefined, $ctx: DIContext): Promise<Promise<void>>;
-    exec(cmdName: string, data: any, $ctx: DIContext): Promise<any>;
+    exec(cmdName: string, data: any, $ctx: DIContext): Promise<void>;
     /**
      * Run prompt for a given command
      * @param cmdName
@@ -42,7 +42,7 @@ export declare class CliService {
      * @param data
      */
     getTasks(cmdName: string, data: any): Promise<Task[]>;
-    getPostInstallTasks(cmdName: string, data: any): Promise<any[]>;
+    getPostInstallTasks(cmdName: string, data: any): Promise<Task<any>[]>;
     createCommand(metadata: CommandMetadata): any;
     load(): void;
     private mapData;

package/lib/types/utils/index.d.ts

@@ -1,5 +1,4 @@
 export * from "./createInjector.js";
-export * from "./createTasksRunner.js";
 export * from "./getCommandMetadata.js";
 export * from "./getTemplateDirectory.js";
 export * from "./loadPlugins.js";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tsed/cli-core",
   "description": "Build your CLI with TypeScript and Decorators",
-  "version": "7.0.0-beta.12",
+  "version": "7.0.0-beta.13",
   "type": "module",
   "main": "./lib/esm/index.js",
   "source": "./src/index.ts",
@@ -29,11 +29,12 @@
     "decorators",
     "commander.js",
     "prompts",
-    "listr"
+    "clack"
   ],
   "dependencies": {
     "@ts-morph/common": "0.28.0",
-    "@tsed/cli-prompts": "7.0.0-beta.12",
+    "@tsed/cli-prompts": "7.0.0-beta.13",
+    "@tsed/cli-tasks": "7.0.0-beta.13",
     "@tsed/logger": ">=8.0.3",
     "@tsed/logger-pattern-layout": ">=8.0.3",
     "@tsed/logger-std": ">=8.0.3",
@@ -48,7 +49,6 @@
     "fs-extra": "^11.2.0",
     "globby": "^14.0.2",
     "js-yaml": "^4.1.0",
-    "listr2": "^8.2.4",
     "read-pkg-up": "^11.0.0",
     "registry-auth-token": "^5.1.0",
     "registry-url": "^6.0.1",
@@ -62,7 +62,7 @@
     "uuid": "^10.0.0"
   },
   "devDependencies": {
-    "@tsed/typescript": "7.0.0-beta.12",
+    "@tsed/typescript": "7.0.0-beta.13",
     "@types/commander": "2.12.2",
     "@types/figures": "3.0.1",
     "@types/fs-extra": "^11.0.4",

package/readme.md

@@ -152,7 +152,7 @@ export class GenerateCmd implements CommandProvider {
   }
 
   /**
-   * Perform action like generate files. The tasks returned by $exec method is based on Listr configuration (see Listr documentation on npm)
+   * Perform action like generate files. The tasks returned by $exec method rely on the @clack/prompts-powered @tsed/cli-tasks helpers.
    */
   async $exec(options: GenerateCmdContext) {
     const {outputFile, ...data} = options;

package/lib/esm/interfaces/Tasks.js

@@ -1 +0,0 @@
-import {} from "listr2";

package/lib/esm/utils/createTasksRunner.js

@@ -1,40 +0,0 @@
-// @ts-ignore
-import { isFunction } from "@tsed/core";
-import { DefaultRenderer, Listr, ListrLogger, VerboseRenderer } from "listr2";
-import { getLogger } from "./createInjector.js";
-class CustomLogger extends ListrLogger {
-    log(level, message, options) {
-        if (["FAILED"].includes(level)) {
-            getLogger()?.error(`[${level}]`, message);
-        }
-        else {
-            getLogger()?.info(`[${level}]`, message);
-        }
-    }
-}
-function getOptions({ bindLogger = true, ...ctx }) {
-    const useRawRenderer = !(!ctx.verbose && !process.env.CI);
-    return {
-        silentRendererCondition: process.env.NODE_ENV === "test",
-        renderer: useRawRenderer ? VerboseRenderer : DefaultRenderer,
-        rendererOptions: useRawRenderer && bindLogger
-            ? {
-                logger: new CustomLogger()
-            }
-            : undefined
-    };
-}
-export function createTasks(tasks, ctx) {
-    return new Listr(tasks, getOptions(ctx));
-}
-export function createSubTasks(tasks, opts) {
-    return async (ctx, task) => {
-        if (isFunction(tasks)) {
-            tasks = await tasks(ctx, task);
-        }
-        return task.newListr(tasks, getOptions(opts));
-    };
-}
-export function createTasksRunner(tasks, ctx) {
-    return createTasks(tasks, ctx).run(ctx);
-}

package/lib/types/interfaces/Tasks.d.ts

@@ -1,8 +0,0 @@
-import { type ListrBaseClassOptions, type ListrContext, type ListrTask } from "listr2";
-export interface TaskOptions<Ctx = ListrContext> extends ListrBaseClassOptions<Ctx> {
-    concurrent?: boolean | number;
-    verbose?: boolean;
-    bindLogger?: boolean;
-}
-export type Task = ListrTask<any, any>;
-export type Tasks = Task[];

package/lib/types/utils/createTasksRunner.d.ts

@@ -1,5 +0,0 @@
-import { Listr, type ListrTaskWrapper } from "listr2";
-import type { TaskOptions, Tasks } from "../interfaces/Tasks.js";
-export declare function createTasks(tasks: Tasks, ctx: TaskOptions): Listr<any, any, any>;
-export declare function createSubTasks(tasks: Tasks | ((ctx: any, task: any) => Tasks | Promise<Tasks>), opts: TaskOptions): (ctx: any, task: ListrTaskWrapper<any, any, any>) => Promise<Listr<any, any, any>>;
-export declare function createTasksRunner(tasks: Tasks, ctx: TaskOptions): Promise<any>;