feat: introduce CommandData interface and enhance command handling with optional properties

Author: Romakita

packages/cli-core/src/interfaces/CommandData.ts

@@ -0,0 +1,12 @@
+declare global {
+  namespace TsED {
+    interface InitialCommandData {}
+  }
+}
+
+export interface CommandData extends TsED.InitialCommandData {
+  commandName?: string;
+  verbose?: boolean;
+  bindLogger?: boolean;
+  rawArgs?: string[];
+}

packages/cli-core/src/interfaces/CommandMetadata.ts

@@ -14,7 +14,7 @@ export interface CommandMetadata extends CommandParameters {
     [key: string]: CommandOptions;
   };
 
-  allowUnknownOption: boolean;
+  allowUnknownOption?: boolean;
 
   enableFeatures: string[];
 

packages/cli-core/src/interfaces/CommandProvider.ts

@@ -1,7 +1,16 @@
+import "inquirer-autocomplete-prompt";
+
 import type {Answers, QuestionCollection} from "inquirer";
+import AutocompletePrompt from "inquirer-autocomplete-prompt";
 
 import type {Tasks} from "./Tasks.js";
 
+declare module "inquirer" {
+  export interface QuestionMap<T extends Answers = Answers> {
+    autocomplete: AutocompletePrompt.AutocompleteQuestionOptions<T>;
+  }
+}
+
 export type QuestionOptions<T extends Answers = Answers> = QuestionCollection<T>;
 
 export interface CommandProvider<Ctx = any> {

packages/cli-core/src/interfaces/index.ts

@@ -4,6 +4,7 @@ import type {CommandProvider} from "./CommandProvider.js";
 import type {PackageJson} from "./PackageJson.js";
 
 export * from "./CliDefaultOptions.js";
+export * from "./CommandData.js";
 export * from "./CommandMetadata.js";
 export * from "./CommandParameters.js";
 export * from "./CommandProvider.js";

packages/cli-core/src/services/CliDockerComposeYaml.ts

@@ -8,6 +8,8 @@ import {CliFs} from "./CliFs.js";
 import {CliYaml} from "./CliYaml.js";
 import {ProjectPackageJson} from "./ProjectPackageJson.js";
 
+export type CliDatabases = "mysql" | "mariadb" | "sqlite" | "better-sqlite3" | "postgres" | "cockroachdb" | "mssql" | "oracle" | "mongodb";
+
 export class CliDockerComposeYaml {
   protected cliYaml = inject(CliYaml);
   protected fs = inject(CliFs);
@@ -31,7 +33,7 @@ export class CliDockerComposeYaml {
     return this.cliYaml.write(file, obj);
   }
 
-  async addDatabaseService(name: string, database: string) {
+  async addDatabaseService(name: string, database: CliDatabases | undefined) {
     const dockerCompose: any = await this.read();
     if (dockerCompose) {
       let value: any;

packages/cli-core/src/services/CliService.ts

@@ -12,17 +12,19 @@ import {
   Provider,
   runInContext
 } from "@tsed/di";
-import {$asyncEmit} from "@tsed/hooks";
+import {$asyncAlter, $asyncEmit} from "@tsed/hooks";
+import {pascalCase} from "change-case";
 import {Argument, Command} from "commander";
 import Inquirer from "inquirer";
-// @ts-ignore
 import inquirer_autocomplete_prompt from "inquirer-autocomplete-prompt";
 import {v4} from "uuid";
 
 import {CommandStoreKeys} from "../domains/CommandStoreKeys.js";
+import type {CommandData} from "../interfaces/CommandData.js";
 import type {CommandMetadata} from "../interfaces/CommandMetadata.js";
 import type {CommandArg, CommandOptions} from "../interfaces/CommandParameters.js";
 import type {CommandProvider} from "../interfaces/CommandProvider.js";
+import type {Task} from "../interfaces/index.js";
 import {PackageManagersModule} from "../packageManagers/index.js";
 import {createSubTasks, createTasksRunner} from "../utils/createTasksRunner.js";
 import {getCommandMetadata} from "../utils/getCommandMetadata.js";
@@ -63,7 +65,7 @@ export class CliService {
    * @param data
    * @param $ctx
    */
-  public runLifecycle(cmdName: string, data: any = {}, $ctx: DIContext) {
+  public runLifecycle(cmdName: string, data: CommandData = {}, $ctx: DIContext) {
     return runInContext($ctx, async () => {
       await $asyncEmit("$loadPackageJson");
 
@@ -76,7 +78,7 @@ export class CliService {
     });
   }
 
-  public async dispatch(cmdName: string, data: any, $ctx: DIContext) {
+  public async dispatch(cmdName: string, data: CommandData, $ctx: DIContext) {
     try {
       $ctx.set("dispatchCmd", cmdName);
       $ctx.set("data", data);
@@ -113,27 +115,27 @@ export class CliService {
   /**
    * Run prompt for a given command
    * @param cmdName
-   * @param ctx Initial data
+   * @param data Initial data
    */
-  public async beforePrompt(cmdName: string, ctx: any = {}) {
+  public async beforePrompt(cmdName: string, data: CommandData = {}) {
     const provider = this.commands.get(cmdName);
     const instance = inject<CommandProvider>(provider.useClass)!;
-    const verbose = ctx.verbose;
+    const verbose = data.verbose;
 
     if (instance.$beforePrompt) {
-      ctx = await instance.$beforePrompt(JSON.parse(JSON.stringify(ctx)));
-      ctx.verbose = verbose;
+      data = await instance.$beforePrompt(JSON.parse(JSON.stringify(data)));
+      data.verbose = verbose;
     }
 
-    return ctx;
+    return data;
   }
 
   /**
    * Run prompt for a given command
    * @param cmdName
    * @param ctx Initial data
    */
-  public async prompt(cmdName: string, ctx: any = {}) {
+  public async prompt(cmdName: string, ctx: CommandData = {}) {
     const provider = this.commands.get(cmdName);
     const instance = inject<CommandProvider>(provider.useClass)!;
 
@@ -159,7 +161,7 @@ export class CliService {
    * @param cmdName
    * @param data
    */
-  public async getTasks(cmdName: string, data: any) {
+  public async getTasks(cmdName: string, data: any): Promise<Task[]> {
     const $ctx = getContext()!;
     const provider = this.commands.get(cmdName);
     const instance = inject<CommandProvider>(provider.token)!;
@@ -170,7 +172,11 @@ export class CliService {
       await instance.$beforeExec(data);
     }
 
-    return [...(await instance.$exec(data)), ...(await this.hooks.emit(CommandStoreKeys.EXEC_HOOKS, cmdName, data))];
+    return [
+      ...(await instance.$exec(data)),
+      ...(await this.hooks.emit(CommandStoreKeys.EXEC_HOOKS, cmdName, data)),
+      ...(await $asyncAlter(`$alter${pascalCase(cmdName)}Tasks`, [], [data]))
+    ];
   }
 
   public async getPostInstallTasks(cmdName: string, data: any) {
@@ -182,6 +188,7 @@ export class CliService {
     return [
       ...(instance.$postInstall ? await instance.$postInstall(data) : []),
       ...(await this.hooks.emit(CommandStoreKeys.POST_INSTALL_HOOKS, cmdName, data)),
+      ...(await $asyncAlter(`$alter${pascalCase(cmdName)}PostInstallTasks`, [] as Task[], [data])),
       ...(instance.$afterPostInstall ? await instance.$afterPostInstall(data) : [])
     ];
   }
@@ -203,7 +210,7 @@ export class CliService {
       );
       const allOpts = mapCommanderOptions(commandName, this.program.commands);
 
-      const data = {
+      const data: CommandData = {
         ...allOpts,
         verbose: !!this.program.opts().verbose,
         ...mappedArgs,
@@ -250,11 +257,13 @@ export class CliService {
       .forEach((provider) => this.build(provider));
   }
 
-  private mapData(cmdName: string, data: any, $ctx: DIContext) {
+  private mapData(cmdName: string, data: CommandData, $ctx: DIContext) {
     const provider = this.commands.get(cmdName);
     const instance = inject<CommandProvider>(provider.useClass)!;
     const verbose = data.verbose;
 
+    data.commandName ||= cmdName;
+
     if (instance.$mapContext) {
       data = instance.$mapContext(JSON.parse(JSON.stringify(data)));
       data.verbose = verbose;
@@ -266,7 +275,7 @@ export class CliService {
       logger().level = "info";
     }
 
-    data.bindLogger = $ctx.get("command").bindLogger;
+    data.bindLogger = $ctx.get("command")?.bindLogger;
 
     $ctx.set("data", data);
 

packages/cli-core/src/services/ProjectPackageJson.ts

@@ -110,6 +110,16 @@ export class ProjectPackageJson {
     return this.raw[constant<string>("name")!];
   }
 
+  fillWithPreferences<T extends {}>(ctx: T) {
+    return {
+      ...ctx,
+      packageManager: this.preferences.packageManager,
+      runtime: this.preferences.runtime,
+      architecture: this.preferences.architecture,
+      convention: this.preferences.convention
+    };
+  }
+
   $loadPackageJson() {
     return this.read();
   }

packages/cli-core/test/integrations/command.integration.spec.ts

@@ -40,6 +40,7 @@ describe("Command", () => {
     });
 
     expect(TestCommand.prototype.$exec).toHaveBeenCalledWith({
+      commandName: "test",
       bindLogger: true,
       argument: "subcmd",
       rawArgs: [],