@forinda/kickjs-cli 2.0.1 → 2.2.0

package/dist/index.d.mts

@@ -0,0 +1,302 @@
+
+//#region src/config.d.ts
+/** A custom command that developers can register via kick.config.ts */
+interface KickCommandDefinition {
+  /** The command name (e.g. 'db:migrate', 'seed', 'proto:gen') */
+  name: string;
+  /** Description shown in --help */
+  description: string;
+  /**
+   * Shell command(s) to run. Can be a single string or an array of
+   * sequential steps. Use {args} as a placeholder for CLI arguments.
+   *
+   * @example
+   * 'npx drizzle-kit migrate'
+   * ['npx drizzle-kit generate', 'npx drizzle-kit migrate']
+   */
+  steps: string | string[];
+  /** Optional aliases (e.g. ['migrate'] for 'db:migrate') */
+  aliases?: string[];
+}
+/** 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;
+/**
+ * Supported schema validators for `kick typegen` body/query/params
+ * type extraction. Only `'zod'` ships built-in for now; other libraries
+ * (Joi, Yup, JSON Schema) will be added later as the adapter system
+ * grows. Set to `false` (or omit) to disable schema-driven body typing
+ * entirely (the route entries will keep `body: unknown`).
+ */
+type SchemaValidator = 'zod' | false;
+/** Typegen settings — controls .kickjs/types/* generation */
+interface TypegenConfig {
+  /**
+   * Source directory to scan for controllers and decorators.
+   * Defaults to `'src'`.
+   */
+  srcDir?: string;
+  /**
+   * Output directory for generated `.d.ts` files.
+   * Defaults to `'.kickjs/types'`.
+   */
+  outDir?: string;
+  /**
+   * Schema validator used to derive `body` types from route metadata.
+   *
+   * - `'zod'` — emit `z.infer<typeof <importedSchema>>` for any schema
+   *   referenced as a named identifier in `@Get/@Post/...({ body, query, params })`.
+   * - `false` — disable schema-driven body typing.
+   *
+   * Future: `'joi' | 'yup' | 'json-schema'` plus a `{ name; module }`
+   * escape hatch for custom adapters.
+   *
+   * @default 'zod'
+   */
+  schemaValidator?: SchemaValidator;
+  /**
+   * Path to the project's env schema file (relative to project root).
+   * Must default-export a `defineEnv(...)` schema for typegen to emit
+   * the typed `KickEnv` global registry.
+   *
+   * Set to `false` to disable env typing entirely.
+   *
+   * @default 'src/env.ts'
+   */
+  envFile?: string | false;
+}
+/** 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 {
+  /**
+   * Project pattern — controls default generator behavior.
+   * - 'rest' — Express + Swagger (default)
+   * - 'graphql' — GraphQL + GraphiQL
+   * - 'ddd' — Full DDD modules with use cases, entities, value objects
+   * - 'cqrs' — CQRS with commands, queries, events, WebSocket + queue
+   * - 'minimal' — Bare Express with no scaffolding
+   */
+  pattern?: ProjectPattern;
+  /**
+   * 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;
+  /** @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.
+   *
+   * @example
+   * ```ts
+   * copyDirs: [
+   *   'src/views',                          // copies to dist/src/views
+   *   { src: 'src/views', dest: 'dist/views' }, // custom dest
+   *   'src/emails',
+   * ]
+   * ```
+   */
+  copyDirs?: Array<string | {
+    src: string;
+    dest?: string;
+  }>;
+  /**
+   * Typegen settings — controls `.kickjs/types/*` generation including
+   * the schema validator used for body type extraction.
+   *
+   * @example
+   * ```ts
+   * typegen: {
+   *   schemaValidator: 'zod',
+   * }
+   * ```
+   */
+  typegen?: TypegenConfig;
+  /** Custom commands that extend the CLI */
+  commands?: KickCommandDefinition[];
+  /** Code style overrides (auto-detected from prettier when possible) */
+  style?: {
+    semicolons?: boolean;
+    quotes?: 'single' | 'double';
+    trailingComma?: 'all' | 'es5' | 'none';
+    indent?: number;
+  };
+}
+/** Helper to define a type-safe kick.config.ts */
+declare function defineConfig(config: KickConfig): KickConfig;
+/** Load kick.config.* from the project root */
+declare function loadKickConfig(cwd: string): Promise<KickConfig | null>;
+//#endregion
+//#region src/generators/module.d.ts
+type BuiltinRepoType = 'drizzle' | 'inmemory' | 'prisma';
+type RepoType = BuiltinRepoType | (string & {});
+interface GenerateModuleOptions {
+  name: string;
+  modulesDir: string;
+  noEntity?: boolean;
+  noTests?: boolean;
+  repo?: RepoType;
+  minimal?: boolean;
+  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.
+ *
+ * Patterns:
+ *   rest         — flat folder: controller + service + DTOs + repo
+ *   ddd          — nested DDD: presentation/ application/ domain/ infrastructure/
+ *   graphql      — flat folder: resolver + service + DTOs + repo (future)
+ *   cqrs         — commands, queries, events with WS/queue integration
+ *   minimal      — just controller + module index
+ */
+declare function generateModule(options: GenerateModuleOptions): Promise<string[]>;
+//#endregion
+//#region src/generators/adapter.d.ts
+interface GenerateAdapterOptions {
+  name: string;
+  outDir: string;
+}
+declare function generateAdapter(options: GenerateAdapterOptions): Promise<string[]>;
+//#endregion
+//#region src/generators/middleware.d.ts
+interface GenerateMiddlewareOptions {
+  name: string;
+  outDir?: string;
+  moduleName?: string;
+  modulesDir?: string;
+  pattern?: ProjectPattern;
+}
+declare function generateMiddleware(options: GenerateMiddlewareOptions): Promise<string[]>;
+//#endregion
+//#region src/generators/guard.d.ts
+interface GenerateGuardOptions {
+  name: string;
+  outDir?: string;
+  moduleName?: string;
+  modulesDir?: string;
+  pattern?: ProjectPattern;
+}
+declare function generateGuard(options: GenerateGuardOptions): Promise<string[]>;
+//#endregion
+//#region src/generators/service.d.ts
+interface GenerateServiceOptions {
+  name: string;
+  outDir?: string;
+  moduleName?: string;
+  modulesDir?: string;
+  pattern?: ProjectPattern;
+}
+declare function generateService(options: GenerateServiceOptions): Promise<string[]>;
+//#endregion
+//#region src/generators/controller.d.ts
+interface GenerateControllerOptions {
+  name: string;
+  outDir?: string;
+  moduleName?: string;
+  modulesDir?: string;
+  pattern?: ProjectPattern;
+}
+declare function generateController(options: GenerateControllerOptions): Promise<string[]>;
+//#endregion
+//#region src/generators/dto.d.ts
+interface GenerateDtoOptions {
+  name: string;
+  outDir?: string;
+  moduleName?: string;
+  modulesDir?: string;
+  pattern?: ProjectPattern;
+}
+declare function generateDto(options: GenerateDtoOptions): Promise<string[]>;
+//#endregion
+//#region src/generators/project.d.ts
+type ProjectTemplate = 'rest' | 'graphql' | 'ddd' | 'cqrs' | 'minimal';
+interface InitProjectOptions {
+  name: string;
+  directory: string;
+  packageManager?: 'pnpm' | 'npm' | 'yarn';
+  initGit?: boolean;
+  installDeps?: boolean;
+  template?: ProjectTemplate;
+  defaultRepo?: string;
+}
+/** Scaffold a new KickJS project */
+declare function initProject(options: InitProjectOptions): Promise<void>;
+//#endregion
+//#region src/utils/naming.d.ts
+/** Convert a name to PascalCase */
+declare function toPascalCase(name: string): string;
+/** Convert a name to camelCase */
+declare function toCamelCase(name: string): string;
+/** Convert a name to kebab-case */
+declare function toKebabCase(name: string): string;
+/**
+ * Pluralize a kebab-case name for directory/file names.
+ * If already plural (ends in 's'), returns as-is.
+ */
+declare function pluralize(name: string): string;
+//#endregion
+export { type KickCommandDefinition, type KickConfig, defineConfig, generateAdapter, generateController, generateDto, generateGuard, generateMiddleware, generateModule, generateService, initProject, loadKickConfig, pluralize, toCamelCase, toKebabCase, toPascalCase };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/config.ts","../src/generators/module.ts","../src/generators/adapter.ts","../src/generators/middleware.ts","../src/generators/guard.ts","../src/generators/service.ts","../src/generators/controller.ts","../src/generators/dto.ts","../src/generators/project.ts","../src/utils/naming.ts"],"mappings":";;;UAIiB,qBAAA;EAAqB;EAEpC,IAAA;EAFoC;EAIpC,WAAA;EAAA;;;;;AAeF;;;EANE,KAAA;EAMwB;EAJxB,OAAA;AAAA;;KAIU,cAAA;;KAGA,iBAAA;;UAKK,cAAA;EACf,IAAA;AAAA;;KAIU,cAAA,GAAiB,iBAAA,GAAkB,cAAA;;;AAS/C;;;;;KAAY,eAAA;;UAGK,aAAA;EAuBkB;;;;EAlBjC,MAAA;EA4BA;;;AAIF;EA3BE,MAAA;;;;;;;;;;;AAiEF;;EApDE,eAAA,GAAkB,eAAA;EA6DR;;;;;;;;;EAnDV,OAAA;AAAA;;UAIe,YAAA;EAiEf;EA/DA,GAAA;EAiEA;;;;;;;;;;;;;EAnDA,IAAA,GAAO,cAAA;EAuFL;EArFF,SAAA;EAqFQ;AAKV;;;;EApFE,SAAA;EAoF2B;;;;AA6B7B;;;;;EAvGE,gBAAA;AAAA;;UAIe,UAAA;;;;AC7GjB;;;;;EDsHE,OAAA,GAAU,cAAA;ECrHQ;;;;AAOnB;;;;;;;ED0HC,OAAA,GAAU,YAAA;ECnHV;EDuHA,UAAA;ECtHA;EDwHA,WAAA,GAAc,cAAA;ECtHd;EDwHA,SAAA;ECvHA;EDyHA,SAAA;ECrHA;;;AAwBF;;;;;;;;;;ED2GE,QAAA,GAAW,KAAA;IAAiB,GAAA;IAAa,IAAA;EAAA;;;;AE/J3C;;;;;;;;EF2KE,OAAA,GAAU,aAAA;;EAEV,QAAA,GAAW,qBAAA;;EAEX,KAAA;IACE,UAAA;IACA,MAAA;IACA,aAAA;IACA,MAAA;EAAA;AAAA;;iBAKY,YAAA,CAAa,MAAA,EAAQ,UAAA,GAAa,UAAA;;iBA6B5B,cAAA,CAAe,GAAA,WAAc,OAAA,CAAQ,UAAA;;;KChN/C,eAAA;AAAA,KACA,QAAA,GAAW,eAAA;AAAA,UASb,qBAAA;EACR,IAAA;EACA,UAAA;EACA,QAAA;EACA,OAAA;EACA,IAAA,GAAO,QAAA;EACP,OAAA;EACA,KAAA;EACA,OAAA,GAAU,cAAA;EACV,MAAA;EDVwB;ECYxB,SAAA;EDTyB;ECWzB,gBAAA;AAAA;;ADNF;;;;;AAKA;;;;iBCyBsB,cAAA,CAAe,OAAA,EAAS,qBAAA,GAAwB,OAAA;;;UCzD5D,sBAAA;EACR,IAAA;EACA,MAAA;AAAA;AAAA,iBAGoB,eAAA,CAAgB,OAAA,EAAS,sBAAA,GAAyB,OAAA;;;UCH9D,yBAAA;EACR,IAAA;EACA,MAAA;EACA,UAAA;EACA,UAAA;EACA,OAAA,GAAU,cAAA;AAAA;AAAA,iBAGU,kBAAA,CAAmB,OAAA,EAAS,yBAAA,GAA4B,OAAA;;;UCRpE,oBAAA;EACR,IAAA;EACA,MAAA;EACA,UAAA;EACA,UAAA;EACA,OAAA,GAAU,cAAA;AAAA;AAAA,iBAGU,aAAA,CAAc,OAAA,EAAS,oBAAA,GAAuB,OAAA;;;UCR1D,sBAAA;EACR,IAAA;EACA,MAAA;EACA,UAAA;EACA,UAAA;EACA,OAAA,GAAU,cAAA;AAAA;AAAA,iBAGU,eAAA,CAAgB,OAAA,EAAS,sBAAA,GAAyB,OAAA;;;UCR9D,yBAAA;EACR,IAAA;EACA,MAAA;EACA,UAAA;EACA,UAAA;EACA,OAAA,GAAU,cAAA;AAAA;AAAA,iBAGU,kBAAA,CAAmB,OAAA,EAAS,yBAAA,GAA4B,OAAA;;;UCRpE,kBAAA;EACR,IAAA;EACA,MAAA;EACA,UAAA;EACA,UAAA;EACA,OAAA,GAAU,cAAA;AAAA;AAAA,iBAGU,WAAA,CAAY,OAAA,EAAS,kBAAA,GAAqB,OAAA;;;KCkB3D,eAAA;AAAA,UAEK,kBAAA;EACR,IAAA;EACA,SAAA;EACA,cAAA;EACA,OAAA;EACA,WAAA;EACA,QAAA,GAAW,eAAA;EACX,WAAA;AAAA;;iBAIoB,WAAA,CAAY,OAAA,EAAS,kBAAA,GAAqB,OAAA;;;;iBC5ChD,YAAA,CAAa,IAAA;;iBAOb,WAAA,CAAY,IAAA;;iBAMZ,WAAA,CAAY,IAAA;;;;;iBAWZ,SAAA,CAAU,IAAA"}