@forinda/kickjs-cli 1.2.12 → 1.3.0

package/dist/index.d.ts

@@ -18,6 +18,51 @@ interface KickCommandDefinition {
 }
 /** Project pattern — controls what generators produce and which deps are installed */
 type ProjectPattern = 'rest' | 'graphql' | 'ddd' | 'cqrs' | 'minimal';
+/** Built-in repository types with first-class code generation support */
+type BuiltinRepoType$1 = 'drizzle' | 'inmemory' | 'prisma';
+/** Custom repository type — generates a stub with TODO markers */
+interface CustomRepoType {
+    name: string;
+}
+/** Repository type — built-in string or custom object */
+type RepoTypeConfig = BuiltinRepoType$1 | CustomRepoType;
+/** Module generation settings — controls how `kick g module` produces code */
+interface ModuleConfig {
+    /** Where modules live (default: 'src/modules') */
+    dir?: string;
+    /**
+     * Default repository implementation for generators.
+     *
+     * Built-in types (string): `'drizzle'`, `'inmemory'`, `'prisma'`
+     * — generate fully working repository code.
+     *
+     * Custom types (object): `{ name: 'typeorm' }`
+     * — generate a stub repository with TODO markers.
+     *
+     * @example
+     * repo: 'prisma'                // built-in
+     * repo: { name: 'typeorm' }     // custom
+     */
+    repo?: RepoTypeConfig;
+    /** Schema output directory (e.g. 'src/db/schema' for Drizzle, 'prisma/' for Prisma) */
+    schemaDir?: string;
+    /**
+     * Whether to pluralize module names in generated code.
+     * When true (default), `kick g module user` creates `src/modules/users/`.
+     * When false, it creates `src/modules/user/` and uses singular names throughout.
+     */
+    pluralize?: boolean;
+    /**
+     * Import path for the Prisma generated client in `--repo prisma` templates.
+     * Must resolve within `src/` for path alias compatibility.
+     *
+     * @default '@prisma/client' (Prisma 5/6)
+     * @example
+     * prismaClientPath: '@/generated/prisma/client'  // Prisma 7+
+     * prismaClientPath: './generated/prisma/client'   // relative
+     */
+    prismaClientPath?: string;
+}
 /** Configuration for the kick.config.ts file */
 interface KickConfig {
     /**
@@ -29,12 +74,26 @@ interface KickConfig {
      * - 'minimal' — Bare Express with no scaffolding
      */
     pattern?: ProjectPattern;
-    /** Where modules live (default: 'src/modules') */
+    /**
+     * Module generation settings — directory, repo type, pluralization, schema dir.
+     *
+     * @example
+     * modules: {
+     *   dir: 'src/modules',
+     *   repo: 'prisma',
+     *   pluralize: false,
+     *   schemaDir: 'prisma/',
+     * }
+     */
+    modules?: ModuleConfig;
+    /** @deprecated Use `modules.dir` instead */
     modulesDir?: string;
-    /** Default repository implementation for generators */
-    defaultRepo?: 'drizzle' | 'inmemory' | 'prisma';
-    /** Drizzle schema output directory */
+    /** @deprecated Use `modules.repo` instead */
+    defaultRepo?: RepoTypeConfig;
+    /** @deprecated Use `modules.schemaDir` instead */
     schemaDir?: string;
+    /** @deprecated Use `modules.pluralize` instead */
+    pluralize?: boolean;
     /**
      * Directories to copy to dist/ after build.
      * Useful for EJS templates, email templates, static assets, etc.
@@ -67,7 +126,8 @@ declare function defineConfig(config: KickConfig): KickConfig;
 /** Load kick.config.* from the project root */
 declare function loadKickConfig(cwd: string): Promise<KickConfig | null>;
 
-type RepoType = 'drizzle' | 'inmemory' | 'prisma';
+type BuiltinRepoType = 'drizzle' | 'inmemory' | 'prisma';
+type RepoType = BuiltinRepoType | (string & {});
 interface GenerateModuleOptions {
     name: string;
     modulesDir: string;
@@ -78,6 +138,10 @@ interface GenerateModuleOptions {
     force?: boolean;
     pattern?: ProjectPattern;
     dryRun?: boolean;
+    /** When false, skip pluralization — use singular names for folders, routes, and classes */
+    pluralize?: boolean;
+    /** Prisma client import path (default: '@prisma/client', Prisma 7+: '@/generated/prisma/client') */
+    prismaClientPath?: string;
 }
 /**
  * Generate a module — structure depends on the project pattern.
@@ -150,6 +214,7 @@ interface InitProjectOptions {
     initGit?: boolean;
     installDeps?: boolean;
     template?: ProjectTemplate;
+    defaultRepo?: string;
 }
 /** Scaffold a new KickJS project */
 declare function initProject(options: InitProjectOptions): Promise<void>;