@tsed/cli-core 7.0.0-alpha.1 → 7.0.0-alpha.10

package/lib/esm/CliCore.js

@@ -8,7 +8,6 @@ import { Command } from "commander";
 import semver from "semver";
 import updateNotifier from "update-notifier";
 import { CliError } from "./domains/CliError.js";
-import { CliConfiguration } from "./services/CliConfiguration.js";
 import { CliPackageJson } from "./services/CliPackageJson.js";
 import { CliService } from "./services/CliService.js";
 import { ProjectPackageJson } from "./services/ProjectPackageJson.js";
@@ -23,6 +22,19 @@ export class CliCore {
         this.injector = inject(InjectorService);
         this.cliService = inject(CliService);
     }
+    static checkPrecondition(settings) {
+        const { pkg } = settings;
+        this.checkPackage(pkg);
+        if (pkg?.engines?.node) {
+            this.checkNodeVersion(pkg.engines.node, pkg.name);
+        }
+    }
+    static checkPackage(pkg) {
+        if (!pkg) {
+            console.log(chalk.red(`settings.pkg is required. Require the package.json of your CLI when you bootstrap the CLI.`));
+            process.exit(1);
+        }
+    }
     static checkNodeVersion(wanted, id) {
         if (!semver.satisfies(process.version, wanted)) {
             console.log(chalk.red("You are using Node " +
@@ -45,11 +57,17 @@ export class CliCore {
         return inject(CliCore);
     }
     static async bootstrap(settings, module = CliCore) {
+        if (settings.checkPrecondition) {
+            this.checkPrecondition(settings);
+        }
+        if (settings.updateNotifier) {
+            await this.updateNotifier(settings.pkg);
+        }
         const cli = await this.create(settings, module);
         return cli.bootstrap();
     }
     static async loadInjector(injector, module = CliCore) {
-        await injector.emit("$beforeInit");
+        await $asyncEmit("$beforeInit");
         injector.addProvider(CliCore, {
             useClass: module
         });
@@ -93,4 +111,4 @@ export class CliCore {
         return this;
     }
 }
-injectable(CliCore).imports([CliPackageJson, ProjectPackageJson, CliService, CliConfiguration]);
+injectable(CliCore).imports([CliPackageJson, ProjectPackageJson, CliService]);

package/lib/esm/services/CliService.js

@@ -1,5 +1,5 @@
 import { classOf } from "@tsed/core";
-import { configuration, constant, destroyInjector, DIContext, getContext, inject, injectable, injector, logger, Provider, runInContext } from "@tsed/di";
+import { configuration, constant, context, 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";
@@ -134,7 +134,17 @@ export class CliService {
             ...(await instance.$exec(data)),
             ...(await this.hooks.emit(CommandStoreKeys.EXEC_HOOKS, cmdName, data)),
             ...(await $asyncAlter(`$alter${pascalCase(cmdName)}Tasks`, [], [data]))
-        ];
+        ].map((opts) => {
+            return {
+                ...opts,
+                task: async (arg, task) => {
+                    context().set("currentTask", task);
+                    const result = await opts.task(arg, task);
+                    context().delete("currentTask");
+                    return result;
+                }
+            };
+        });
     }
     async getPostInstallTasks(cmdName, data) {
         const provider = this.commands.get(cmdName);

package/lib/esm/services/index.js

@@ -1,4 +1,3 @@
-export * from "./CliConfiguration.js";
 export * from "./CliDockerComposeYaml.js";
 export * from "./CliExeca.js";
 export * from "./CliFs.js";

package/lib/esm/utils/createInjector.js

@@ -1,47 +1,50 @@
 import "@tsed/logger-std";
 import "@tsed/logger-pattern-layout";
-import { inject, injector, InjectorService } from "@tsed/di";
+import { injector } from "@tsed/di";
 import { Logger } from "@tsed/logger";
-import { CliConfiguration } from "../services/CliConfiguration.js";
 import { ProjectPackageJson } from "../services/ProjectPackageJson.js";
 let logger;
 export function getLogger() {
     return logger;
 }
-function createConfiguration(injector) {
-    injector.addProvider(CliConfiguration);
-    return inject(CliConfiguration);
-}
 export function createInjector(settings = {}) {
     const inj = injector();
-    inj.settings = createConfiguration(inj);
     logger = inj.logger = new Logger(settings.name || "CLI");
     inj.addProvider(ProjectPackageJson);
-    inj.settings.set(settings);
+    inj.settings.set({
+        ...settings,
+        project: {
+            root: process.cwd(),
+            srcDir: "src",
+            ...(settings.project || {})
+        }
+    });
     /* istanbul ignore next */
     if (inj.settings.env === "test") {
         inj.logger.stop();
     }
     else {
         /* istanbul ignore next */
-        inj.logger.level = inj.settings.logger?.level || "warn";
-        inj.logger.appenders
-            .set("stdout", {
-            type: "stdout",
-            layout: {
-                type: "pattern",
-                pattern: "[%d{hh:mm:ss}] %m"
-            },
-            levels: ["info", "debug"]
-        })
-            .set("stderr", {
-            type: "stderr",
-            layout: {
-                type: "pattern",
-                pattern: "[%d{hh:mm:ss}][%p] %m"
-            },
-            levels: ["trace", "fatal", "error", "warn"]
-        });
+        if (!settings.logger?.disableCliFormat) {
+            inj.logger.level = inj.settings.logger?.level || "warn";
+            inj.logger.appenders
+                .set("stdout", {
+                type: "stdout",
+                layout: {
+                    type: "pattern",
+                    pattern: "[%d{hh:mm:ss}] %m"
+                },
+                levels: ["info", "debug"]
+            })
+                .set("stderr", {
+                type: "stderr",
+                layout: {
+                    type: "pattern",
+                    pattern: "[%d{hh:mm:ss}][%p] %m"
+                },
+                levels: ["trace", "fatal", "error", "warn"]
+            });
+        }
     }
     return inj;
 }

package/lib/types/CliCore.d.ts

@@ -5,6 +5,8 @@ import { CliService } from "./services/CliService.js";
 export declare class CliCore {
     readonly injector: InjectorService;
     readonly cliService: CliService;
+    static checkPrecondition(settings: any): void;
+    static checkPackage(pkg: any): void;
     static checkNodeVersion(wanted: string, id: string): typeof CliCore;
     static create<Cli extends CliCore = CliCore>(settings: Partial<TsED.Configuration>, module?: Type): Promise<Cli>;
     static bootstrap(settings: Partial<TsED.Configuration>, module?: Type): Promise<CliCore>;

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

@@ -33,7 +33,7 @@ declare global {
              */
             templateDir?: string;
             /**
-             *
+             * A function that return default projet settings set in fresh project.
              * @param pkg
              */
             defaultProjectPreferences?: (pkg?: any) => Record<string, any>;
@@ -50,6 +50,14 @@ declare global {
              * Enable plugins loading
              */
             plugins: boolean;
+            /**
+             * Check version and node version before running a command
+             */
+            checkPrecondition?: boolean;
+            /**
+             * Display available update on terminal before running a command
+             */
+            updateNotifier?: boolean;
         }
     }
 }

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

@@ -1,4 +1,3 @@
-export * from "./CliConfiguration.js";
 export * from "./CliDockerComposeYaml.js";
 export * from "./CliExeca.js";
 export * from "./CliFs.js";

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

@@ -1,6 +1,15 @@
 import "@tsed/logger-std";
 import "@tsed/logger-pattern-layout";
-import { type DIConfigurationOptions, InjectorService } from "@tsed/di";
 import { Logger } from "@tsed/logger";
+declare global {
+    namespace TsED {
+        interface Configuration {
+            logger?: LoggerConfiguration;
+        }
+        interface LoggerConfiguration {
+            disableCliFormat?: boolean;
+        }
+    }
+}
 export declare function getLogger(): Logger;
-export declare function createInjector(settings?: Partial<DIConfigurationOptions>): InjectorService;
+export declare function createInjector(settings?: Partial<TsED.Configuration>): import("@tsed/di").InjectorService;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tsed/cli-core",
   "description": "Build your CLI with TypeScript and Decorators",
-  "version": "7.0.0-alpha.1",
+  "version": "7.0.0-alpha.10",
   "type": "module",
   "main": "./lib/esm/index.js",
   "source": "./src/index.ts",
@@ -32,6 +32,7 @@
     "listr"
   ],
   "dependencies": {
+    "@ts-morph/common": "0.28.0",
     "@tsed/logger": ">=8.0.3",
     "@tsed/logger-pattern-layout": ">=8.0.3",
     "@tsed/logger-std": ">=8.0.3",
@@ -64,7 +65,7 @@
     "uuid": "^10.0.0"
   },
   "devDependencies": {
-    "@tsed/typescript": "7.0.0-alpha.1",
+    "@tsed/typescript": "7.0.0-alpha.10",
     "@types/commander": "2.12.2",
     "@types/figures": "3.0.1",
     "@types/fs-extra": "^11.0.4",

package/lib/esm/services/CliConfiguration.js

@@ -1,12 +0,0 @@
-import { DIConfiguration, injectable } from "@tsed/di";
-export class CliConfiguration extends DIConfiguration {
-    constructor() {
-        super({
-            project: {
-                root: process.cwd(),
-                srcDir: "src"
-            }
-        });
-    }
-}
-injectable(CliConfiguration);

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

@@ -1,4 +0,0 @@
-import { DIConfiguration } from "@tsed/di";
-export declare class CliConfiguration extends DIConfiguration {
-    constructor();
-}