refactor: simplify command parameters and improve configuration handling in project and export commands

Author: thevuong

.changeset/free-wombats-train.md

@@ -0,0 +1,14 @@
+---
+"@codefast-ui/progress-circle": patch
+"@codefast-ui/checkbox-group": patch
+"@codefast-ui/input-number": patch
+"@codefast/typescript-config": patch
+"@codefast-ui/input": patch
+"@codefast/eslint-config": patch
+"@codefast/style-guide": patch
+"@codefast/hooks": patch
+"@codefast/cli": patch
+"@codefast/ui": patch
+---
+
+refactor: simplify command parameters and improve configuration handling in project and export commands

commitlint.config.mjs

@@ -2,6 +2,7 @@ const config = {
   extends: ["@commitlint/config-conventional"],
   rules: {
     "body-max-line-length": [2, "always", 350],
+    "header-max-length": [2, "always", 150],
   },
 };
 

packages/cli/src/application/commands/create-project.command.ts

@@ -3,7 +3,6 @@ import { inject, injectable } from "inversify";
 import process from "node:process";
 
 import type { CreateProjectUseCase } from "@/application/use-cases/create-project.use-case";
-import type { ConfigGroups } from "@/domain/entities/config-file";
 
 import { TYPES } from "@/ioc/types";
 
@@ -13,16 +12,16 @@ export class CreateProjectCommand {
 
   /**
    * Returns a Commander.js command for creating or configuring a project.
-   * @param configGroups - Configuration groups for project files.
+   *
    * @returns Configured Commander.js command.
    */
-  getCommand(configGroups: ConfigGroups): Command {
+  getCommand(): Command {
     return new Command()
       .name("create-project")
       .description("Create a new Next.js project with TypeScript, TailwindCSS, and linting setup")
       .argument("[project-name]", "Name of the project to create")
       .action(async (projectName: string) => {
-        await this.createProjectUseCase.execute(projectName, configGroups);
+        await this.createProjectUseCase.execute(projectName);
 
         process.exit(0);
       });

packages/cli/src/application/use-cases/create-project.use-case.ts

@@ -8,6 +8,7 @@ import type { Project } from "@/domain/entities/project";
 import type { ProjectRepositoryInterface } from "@/domain/interfaces/project.repository";
 
 import { handleError } from "@/application/utilities/error-handler";
+import { ConfigService } from "@/infrastructure/services/config.service";
 import { TYPES } from "@/ioc/types";
 
 @injectable()
@@ -17,18 +18,20 @@ export class CreateProjectUseCase {
     @inject(TYPES.FileSystemPort) private fileSystemPort: FileSystemPort,
     @inject(TYPES.CommandExecutorPort) private commandExecutorPort: CommandExecutorPort,
     @inject(TYPES.PromptPort) private promptPort: PromptPort,
+    @inject(TYPES.ConfigService) private configService: ConfigService,
   ) {}
 
   /**
    * Executes the project creation or configuration process.
-   * @param projectNameArg - Optional project name provided via CLI.
-   * @param configGroups - Configuration groups for project files.
+   * @param projectName - Optional project name provided via CLI.
+   *
    * @returns The created or configured project.
    */
-  async execute(projectNameArg?: string, configGroups: ConfigGroups = {}): Promise<Project> {
+  async execute(projectName?: string): Promise<Project> {
     try {
       this.commandExecutorPort.checkEnvironment();
-      const project = await this.checkExistingProject(projectNameArg);
+      const project = await this.checkExistingProject(projectName);
+      const configGroups = this.configService.getConfigGroups();
 
       this.createOrConfigureProject(project, configGroups);
       this.displaySuccessMessage(project);

packages/cli/src/application/use-cases/update-exports.use-case.ts

@@ -21,7 +21,7 @@ export class UpdateExportsUseCase {
   ): Promise<void> {
     try {
       console.info("Searching for packages...");
-      const packageJsonPaths = await this.packageRepository.findAllPackages(config.defaultPackageConfig);
+      const packageJsonPaths = await this.packageRepository.findAllPackages(config);
 
       if (packageJsonPaths.length === 0) {
         console.warn("No packages found.");

packages/cli/src/domain/entities/config-file.ts

@@ -1,17 +1,15 @@
 import { z } from "zod";
 
-export const ConfigFileSchema = z.object({
+export const configFileSchema = z.object({
   path: z.string().describe("Relative path to the configuration file"),
   content: z.string().describe("Content of the configuration file"),
   description: z.string().optional().describe("Description of the configuration file's purpose"),
 });
 
-export const ConfigCategorySchema = z.array(ConfigFileSchema).describe("Array of configuration files for a category");
+export const ConfigCategorySchema = z.array(configFileSchema).describe("Array of configuration files for a category");
 
 export const ConfigGroupsSchema = z
   .record(z.string(), ConfigCategorySchema)
   .describe("Configuration groups by category");
 
-export type ConfigFile = z.infer<typeof ConfigFileSchema>;
-
 export type ConfigGroups = z.infer<typeof ConfigGroupsSchema>;

packages/cli/src/domain/entities/package-config.ts

@@ -45,21 +45,23 @@ export const exportConfigSchema = z.object({
 
 export const PackageExportsSchema = z.record(z.string(), z.union([exportConfigSchema, z.string()]));
 
-export const packageJsonSchema = z.object({
-  dependencies: z
-    .record(z.string(), z.string())
-    .optional()
-    .describe("List of runtime dependencies with their versions"),
-  devDependencies: z
-    .record(z.string(), z.string())
-    .optional()
-    .describe("List of development dependencies with their versions"),
-  exports: PackageExportsSchema.optional().describe("Export mappings for the package"),
-  name: z.string().describe("Name of the package"),
-  scripts: z.record(z.string(), z.string()).describe("Script commands defined for the package"),
-  "simple-git-hooks": z.record(z.string(), z.string()).optional().describe("Git hooks configuration for the package"),
-  version: z.string().optional().describe("Version of the package"),
-});
+export const packageJsonSchema = z
+  .object({
+    dependencies: z
+      .record(z.string(), z.string())
+      .optional()
+      .describe("List of runtime dependencies with their versions"),
+    devDependencies: z
+      .record(z.string(), z.string())
+      .optional()
+      .describe("List of development dependencies with their versions"),
+    exports: PackageExportsSchema.optional().describe("Export mappings for the package"),
+    name: z.string().describe("Name of the package"),
+    scripts: z.record(z.string(), z.string()).describe("Script commands defined for the package"),
+    "simple-git-hooks": z.record(z.string(), z.string()).optional().describe("Git hooks configuration for the package"),
+    version: z.string().optional().describe("Version of the package"),
+  })
+  .catchall(z.unknown());
 
 export type PackageConfig = z.infer<typeof packageConfigSchema>;
 

packages/cli/src/domain/entities/project.ts

@@ -4,7 +4,7 @@ import { z } from "zod";
  * Schema for validating project configuration.
  * Ensures the project name is URL-friendly, not reserved, and the directory is valid.
  */
-export const ProjectSchema = z.object({
+export const projectSchema = z.object({
   name: z
     .string()
     .min(1, "Project name cannot be empty")
@@ -23,4 +23,4 @@ export const ProjectSchema = z.object({
   packageJsonExists: z.boolean().describe("Whether package.json exists in the project directory"),
 });
 
-export type Project = z.infer<typeof ProjectSchema>;
+export type Project = z.infer<typeof projectSchema>;

packages/cli/src/domain/interfaces/config.service.ts

@@ -1,11 +1,9 @@
 import type { ConfigGroups } from "@/domain/entities/config-file";
-import type { ScriptConfig } from "@/domain/entities/package-config";
 
 /**
  * Interface for accessing CLI configuration, including config groups for a create-project
  * and script configuration for update-exports.
  */
 export interface ConfigServiceInterface {
   getConfigGroups: () => ConfigGroups;
-  getScriptConfig: () => ScriptConfig;
 }

packages/cli/src/domain/interfaces/package.repository.ts

@@ -5,7 +5,7 @@ import type { AnalysisResult, PackageConfig, PackageExports, ScriptConfig } from
  */
 export interface PackageRepository {
   analyzeImports: (indexFilePath: string, packageConfig: PackageConfig) => AnalysisResult;
-  findAllPackages: (config: PackageConfig) => Promise<string[]>;
+  findAllPackages: (configPath?: string) => Promise<string[]>;
   generateExports: (
     packageName: string,
     imports: AnalysisResult["imports"],

packages/cli/src/infrastructure/adapters/cli.adapter.ts

@@ -1,7 +1,6 @@
 import { Command } from "commander";
 import { inject, injectable } from "inversify";
 
-import type { ConfigServiceInterface } from "@/domain/interfaces/config.service";
 import type { PackageInfoServiceInterface } from "@/domain/interfaces/package-info.service";
 
 import { CreateProjectCommand } from "@/application/commands/create-project.command";
@@ -14,7 +13,6 @@ export class CLIAdapter {
     @inject(TYPES.CreateProjectCommand) private createProjectCommand: CreateProjectCommand,
     @inject(TYPES.UpdateExportsCommand) private updateExportsCommand: UpdateExportsCommand,
     @inject(TYPES.PackageInfoService) private packageInfoService: PackageInfoServiceInterface,
-    @inject(TYPES.ConfigService) private configService: ConfigServiceInterface,
   ) {}
 
   /**
@@ -27,8 +25,8 @@ export class CLIAdapter {
       .name("codefast")
       .description("CodeFast CLI - A development toolkit for CodeFast.")
       .version(this.packageInfoService.getPackageVersion(), "-v, --version", "display CLI version")
-      .addCommand(this.createProjectCommand.getCommand(this.configService.getConfigGroups()))
-      .addCommand(this.updateExportsCommand.getCommand(this.configService.getScriptConfig()))
+      .addCommand(this.createProjectCommand.getCommand())
+      .addCommand(this.updateExportsCommand.getCommand())
       .parse(process.argv);
   }
 }

packages/cli/src/infrastructure/repositories/file-system-package.repository.ts

@@ -42,8 +42,8 @@ export class FileSystemPackageRepository implements PackageRepository {
     @inject(TYPES.FileSystemUtility) private fileSystemUtility: FileSystemUtility,
   ) {}
 
-  async findAllPackages(config: PackageConfig): Promise<string[]> {
-    return await glob(config.packageJsonPath, {
+  async findAllPackages(config: ScriptConfig): Promise<string[]> {
+    return await glob(config.packagesGlob, {
       ignore: this.DEFAULT_IGNORE_PATTERN,
     });
   }
@@ -140,12 +140,12 @@ export class FileSystemPackageRepository implements PackageRepository {
     const exports: PackageExports = {
       ".": existingExports["."] ?? {
         import: {
-          types: "./dist/types/index.d.ts",
           default: "./dist/esm/index.js",
+          types: "./dist/types/index.d.ts",
         },
         require: {
-          types: "./dist/types/index.d.cts",
           default: "./dist/cjs/index.cjs",
+          types: "./dist/types/index.d.cts",
         },
       },
     };
@@ -163,12 +163,12 @@ export class FileSystemPackageRepository implements PackageRepository {
 
       exports[exportPath] = {
         import: {
-          types: typesOutput,
           default: esmOutput,
+          types: typesOutput,
         },
         require: {
-          types: typesCjsOutput,
           default: cjsOutput,
+          types: typesCjsOutput,
         },
       };
     }

packages/cli/src/infrastructure/repositories/file-system-project.repository.ts

@@ -9,7 +9,7 @@ import type { ProjectRepositoryInterface } from "@/domain/interfaces/project.rep
 import type { FileSystemUtility } from "@/infrastructure/utilities/file-system-utility";
 
 import { PackageJson, packageJsonSchema } from "@/domain/entities/package-config";
-import { ProjectSchema } from "@/domain/entities/project";
+import { projectSchema } from "@/domain/entities/project";
 import { TYPES } from "@/ioc/types";
 
 @injectable()
@@ -21,26 +21,26 @@ export class FileSystemProjectRepository implements ProjectRepositoryInterface {
     @inject(TYPES.FileSystemUtility) private fileSystemUtility: FileSystemUtility,
   ) {}
 
-  async checkExistingProject(projectNameArg?: string): Promise<Project> {
+  async checkExistingProject(projectName?: string): Promise<Project> {
     let fullPath = process.cwd();
-    let projectName = "";
+    let name = "";
     const packageJsonPath = path.join(process.cwd(), "package.json");
     const packageJsonExists = this.fileSystemPort.exists(packageJsonPath);
 
     if (packageJsonExists) {
       const result = packageJsonSchema.safeParse(JSON.parse(this.fileSystemPort.readFile(packageJsonPath)));
 
       if (result.success) {
-        projectName = result.data.name;
+        name = result.data.name;
       }
     } else {
-      projectName = await this.getValidProjectName(projectNameArg);
+      name = await this.getValidProjectName(projectName);
 
-      fullPath = path.resolve(process.cwd(), projectName);
+      fullPath = path.resolve(process.cwd(), name);
     }
 
     return {
-      name: projectName,
+      name,
       directory: fullPath,
       packageJsonExists,
     };
@@ -210,7 +210,7 @@ import "@/app/globals.css";`;
 
   private async getValidProjectName(initialName?: string, attempts = 0, maxAttempts = 3): Promise<string> {
     const projectName = initialName ?? (await this.promptPort.prompt("Enter project name: "));
-    const result = ProjectSchema.safeParse({ name: projectName, directory: "", packageJsonExists: false });
+    const result = projectSchema.safeParse({ name: projectName, directory: "", packageJsonExists: false });
 
     if (result.success) {
       const fullPath = path.resolve(process.cwd(), projectName);

packages/cli/src/infrastructure/services/config.service.ts

@@ -1,7 +1,6 @@
 import { injectable } from "inversify";
 
 import type { ConfigGroups } from "@/domain/entities/config-file";
-import type { ScriptConfig } from "@/domain/entities/package-config";
 import type { ConfigServiceInterface } from "@/domain/interfaces/config.service";
 
 @injectable()
@@ -155,6 +154,7 @@ const config = {
   extends: ["@commitlint/config-conventional"],
   rules: {
     "body-max-line-length": [2, "always", 350],
+    "header-max-length": [2, "always", 150],
   },
 };
 
@@ -316,31 +316,7 @@ export const fontVariables = cn(fontGeistSans.variable, fontGeistMono.variable);
     ],
   };
 
-  private readonly scriptConfig: ScriptConfig = {
-    packagesGlob: "./packages/**/package.json",
-    defaultPackageConfig: {
-      cjsOutputPattern: "./dist/cjs/{dir}/{name}.cjs",
-      esmOutputPattern: "./dist/esm/{dir}/{name}.js",
-      packageJsonPath: "package.json",
-      srcIndexPath: "src/index.ts",
-      typesOutputCjsPattern: "./dist/types/{dir}/{name}.d.ts",
-      typesOutputPattern: "./dist/types/{dir}/{name}.d.ts",
-    },
-    customPackageConfigs: {
-      "@codefast/ui": {
-        exportPathPrefixesToRemove: ["components"],
-      },
-      "@codefast/style-guide": {
-        exportPathPrefixesToRemove: ["configs"],
-      },
-    },
-  };
-
   getConfigGroups(): ConfigGroups {
     return this.configGroups;
   }
-
-  getScriptConfig(): ScriptConfig {
-    return this.scriptConfig;
-  }
 }

packages/cli/src/ioc/container.ts

@@ -32,6 +32,7 @@ const container = new Container();
 // Domain bindings
 container.bind<ProjectRepositoryInterface>(TYPES.ProjectRepository).to(FileSystemProjectRepository).inSingletonScope(); // Handles project creation and file updates
 container.bind<PackageRepository>(TYPES.PackageRepository).to(FileSystemPackageRepository).inSingletonScope(); // Manages package.json exports
+
 container.bind<PackageInfoServiceInterface>(TYPES.PackageInfoService).to(NodePackageInfoService).inSingletonScope(); // Provides package version
 container
   .bind<DependencyConfigServiceInterface>(TYPES.DependencyConfigService)
@@ -44,13 +45,16 @@ container.bind<FileSystemPort>(TYPES.FileSystemPort).to(NodeFileSystemAdapter).i
 container.bind<CommandExecutorPort>(TYPES.CommandExecutorPort).to(NodeCommandExecutorAdapter).inSingletonScope(); // Command execution
 container.bind<PromptPort>(TYPES.PromptPort).to(NodePromptAdapter).inSingletonScope(); // User input prompting
 container.bind<AnalysisPort>(TYPES.AnalysisPort).to(TsMorphAnalysisAdapter).inSingletonScope(); // Import analysis
+
 container.bind<CreateProjectUseCase>(TYPES.CreateProjectUseCase).to(CreateProjectUseCase).inSingletonScope(); // Project creation logic
 container.bind<UpdateExportsUseCase>(TYPES.UpdateExportsUseCase).to(UpdateExportsUseCase).inSingletonScope(); // Export update logic
+
 container.bind<CreateProjectCommand>(TYPES.CreateProjectCommand).to(CreateProjectCommand).inSingletonScope(); // CLI command for project creation
 container.bind<UpdateExportsCommand>(TYPES.UpdateExportsCommand).to(UpdateExportsCommand).inSingletonScope(); // CLI command for export updates
 
 // Infrastructure bindings
 container.bind<CLIAdapter>(TYPES.CLIAdapter).to(CLIAdapter).inSingletonScope(); // CLI setup and command registration
+
 container.bind<FileSystemUtility>(TYPES.FileSystemUtility).to(FileSystemUtility).inSingletonScope(); // File system utility functions
 
 export { container };