refactor: replace Command decorator with command function for improved consistency

Author: Romakita

packages/cli-core/src/CliCore.ts

@@ -1,6 +1,5 @@
 import "@tsed/logger-std";
 
-// import "@tsed/logger/layouts/ColoredLayout";
 import {join, resolve} from "node:path";
 
 import {Type} from "@tsed/core";

packages/cli-core/src/index.ts

@@ -4,6 +4,7 @@ import Inquirer from "inquirer";
 
 export * from "./CliCore.js";
 export * from "./decorators/index.js";
+export * from "./fn/command.js";
 export * from "./interfaces/index.js";
 export * from "./packageManagers/index.js";
 export * from "./services/index.js";

packages/cli-generate-http-client/src/commands/GenerateHttpClientCmd.ts

@@ -1,6 +1,6 @@
-import path, {join, resolve} from "node:path";
+import {join, resolve} from "node:path";
 
-import {CliFs, Command, type CommandProvider, constant, inject, Type} from "@tsed/cli-core";
+import {CliFs, command, type CommandProvider, constant, inject, Type} from "@tsed/cli-core";
 import {isString} from "@tsed/core";
 import {InjectorService} from "@tsed/di";
 import {camelCase} from "change-case";
@@ -19,35 +19,6 @@ export interface GenerateHttpClientOpts {
   transformOperationId?(operationId: string, routeNameInfo: RouteNameInfo, raw: RawRouteInfo): string;
 }
 
-@Command({
-  name: "generate-http-client",
-  description: "Generate the client API from swagger spec",
-  options: {
-    "-s, --suffix <suffix>": {
-      required: false,
-      type: String,
-      defaultValue: "Model",
-      description: "The suffix applied on model"
-    },
-    "-t, --type <type>": {
-      required: false,
-      type: String,
-      defaultValue: "axios",
-      description: "The client type by the Http client (axios or fetch)"
-    },
-    "-n, --name <name>": {
-      required: false,
-      type: String,
-      defaultValue: "ApiClient",
-      description: "The class name of the generated client"
-    },
-    "-o, --output <output>": {
-      required: true,
-      type: String,
-      description: "Path to generate files"
-    }
-  }
-})
 export class GenerateHttpClientCmd implements CommandProvider {
   protected fs = inject(CliFs);
   protected serverModule = constant<Type<any>>("server");
@@ -195,3 +166,33 @@ export class GenerateHttpClientCmd implements CommandProvider {
     return routeNameInfo;
   }
 }
+
+command(GenerateHttpClientCmd, {
+  name: "generate-http-client",
+  description: "Generate the client API from swagger spec",
+  options: {
+    "-s, --suffix <suffix>": {
+      required: false,
+      type: String,
+      defaultValue: "Model",
+      description: "The suffix applied on model"
+    },
+    "-t, --type <type>": {
+      required: false,
+      type: String,
+      defaultValue: "axios",
+      description: "The client type by the Http client (axios or fetch)"
+    },
+    "-n, --name <name>": {
+      required: false,
+      type: String,
+      defaultValue: "ApiClient",
+      description: "The class name of the generated client"
+    },
+    "-o, --output <output>": {
+      required: true,
+      type: String,
+      description: "Path to generate files"
+    }
+  }
+});

packages/cli-generate-swagger/src/commands/GenerateSwaggerCmd.ts

@@ -1,22 +1,11 @@
 import path, {join, resolve} from "node:path";
 
-import {CliFs, CliYaml, Command, type CommandProvider, Constant, constant, Inject, inject, InjectorService, Type} from "@tsed/cli-core";
+import {CliFs, CliYaml, command, type CommandProvider, constant, inject, InjectorService, Type} from "@tsed/cli-core";
 
 export interface GenerateSwaggerCtx {
   output: string;
 }
 
-@Command({
-  name: "generate-swagger",
-  description: "Generate the client API from swagger spec",
-  options: {
-    "-o, --output <output>": {
-      required: true,
-      type: String,
-      description: "Path to generate files"
-    }
-  }
-})
 export class GenerateSwaggerCmd implements CommandProvider {
   protected fs = inject(CliFs);
   protected cliYaml = inject(CliYaml);
@@ -103,3 +92,15 @@ export class GenerateSwaggerCmd implements CommandProvider {
     await Promise.all([this.fs.writeJson(fileJson, spec), this.cliYaml.write(fileYaml, spec)]);
   }
 }
+
+command(GenerateSwaggerCmd, {
+  name: "generate-swagger",
+  description: "Generate the client API from swagger spec",
+  options: {
+    "-o, --output <output>": {
+      required: true,
+      type: String,
+      description: "Path to generate files"
+    }
+  }
+});

packages/cli-plugin-eslint/src/CliPluginEslintModule.ts

@@ -1,8 +1,7 @@
-import {Module} from "@tsed/cli-core";
+import {injectable} from "@tsed/di";
 
 import {EslintInitHook} from "./hooks/EslintInitHook.js";
 
-@Module({
-  imports: [EslintInitHook]
-})
 export class CliPluginEslintModule {}
+
+injectable(CliPluginEslintModule).imports([EslintInitHook]);

packages/cli/src/commands/add/AddCmd.ts

@@ -1,7 +1,7 @@
 import {
   type CliDefaultOptions,
   CliPlugins,
-  Command,
+  command,
   type CommandProvider,
   createSubTasks,
   inject,
@@ -15,16 +15,6 @@ export interface AddCmdOptions extends CliDefaultOptions {
   name: string;
 }
 
-@Command({
-  name: "add",
-  description: "Add cli plugin to the current project",
-  args: {
-    name: {
-      description: "Npm package name of the cli plugin",
-      type: String
-    }
-  }
-})
 export class AddCmd implements CommandProvider {
   protected cliPlugins = inject(CliPlugins);
   protected packageJson = inject(ProjectPackageJson);
@@ -64,3 +54,14 @@ export class AddCmd implements CommandProvider {
     ];
   }
 }
+
+command(AddCmd, {
+  name: "add",
+  description: "Add cli plugin to the current project",
+  args: {
+    name: {
+      description: "Npm package name of the cli plugin",
+      type: String
+    }
+  }
+});

packages/cli/src/commands/generate/GenerateCmd.ts

@@ -1,6 +1,6 @@
 import {basename, dirname, join} from "node:path";
 
-import {type CliDefaultOptions, Command, type CommandProvider, Inject, inject, ProjectPackageJson} from "@tsed/cli-core";
+import {type CliDefaultOptions, command, type CommandProvider, inject, ProjectPackageJson} from "@tsed/cli-core";
 import {normalizePath} from "@tsed/normalize-path";
 import {kebabCase, pascalCase} from "change-case";
 import {globbySync} from "globby";
@@ -52,53 +52,15 @@ const searchFactory = (list: any) => {
   };
 };
 
-@Command({
-  name: "generate",
-  alias: "g",
-  description: "Generate a new provider class",
-  args: {
-    type: {
-      description: "Type of the provider (Injectable, Controller, Pipe, etc...)",
-      type: String
-    },
-    name: {
-      description: "Name of the class",
-      type: String
-    }
-  },
-  options: {
-    "--route <route>": {
-      type: String,
-      description: "The route for the controller generated file"
-    },
-    "-d, --directory <directory>": {
-      description: "Directory where the file must be generated",
-      type: String
-    },
-    "-t, --template-type <templateType>": {
-      description: "Directory where the file must be generated",
-      type: String
-    },
-    "-m, --middleware-position <templateType>": {
-      description: "Middleware position (before, after)",
-      type: String
-    }
-  }
-})
 export class GenerateCmd implements CommandProvider {
-  @Inject()
-  classNamePipe: ClassNamePipe;
-
-  @Inject()
-  outputFilePathPipe: OutputFilePathPipe;
-
-  @Inject()
-  routePipe: RoutePipe;
+  protected classNamePipe = inject(ClassNamePipe);
+  protected outputFilePathPipe = inject(OutputFilePathPipe);
+  protected routePipe = inject(RoutePipe);
+  protected srcRenderService = inject(SrcRendererService);
+  protected projectPackageJson = inject(ProjectPackageJson);
+  protected providersList = inject(ProvidersInfoService);
 
-  srcRenderService = inject(SrcRendererService);
-  projectPackageJson = inject(ProjectPackageJson);
-
-  constructor(private providersList: ProvidersInfoService) {
+  constructor() {
     PROVIDER_TYPES.forEach((info) => {
       this.providersList.add(
         {
@@ -288,3 +250,37 @@ export class GenerateCmd implements CommandProvider {
     return [...set];
   }
 }
+
+command(GenerateCmd, {
+  name: "generate",
+  alias: "g",
+  description: "Generate a new provider class",
+  args: {
+    type: {
+      description: "Type of the provider (Injectable, Controller, Pipe, etc...)",
+      type: String
+    },
+    name: {
+      description: "Name of the class",
+      type: String
+    }
+  },
+  options: {
+    "--route <route>": {
+      type: String,
+      description: "The route for the controller generated file"
+    },
+    "-d, --directory <directory>": {
+      description: "Directory where the file must be generated",
+      type: String
+    },
+    "-t, --template-type <templateType>": {
+      description: "Directory where the file must be generated",
+      type: String
+    },
+    "-m, --middleware-position <templateType>": {
+      description: "Middleware position (before, after)",
+      type: String
+    }
+  }
+});