kavoru 0.8.9 → 0.8.11

package/README.md

@@ -55,6 +55,7 @@ During setup you can pick which integrations to scaffold. Core is always include
 | `resend`    | Resend email           |
 | `cron`      | Cron jobs              |
 | `docker`    | Dockerfile + Compose     |
+| `cli`       | Project CLI (`kavoru module`, bin, root shims) |
 
 Interactive mode (TTY) shows a checkbox menu (↑↓ move, Space toggle, Enter confirm). Non-interactive runs use the full stack unless you pass flags.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kavoru",
-  "version": "0.8.9",
+  "version": "0.8.11",
   "description": "Scaffold a new Kavoru (Elysia + Bun) backend from the official template",
   "type": "module",
   "bin": {

package/src/args.ts

@@ -15,9 +15,13 @@ export type CliOptions = {
 
 const HELP = `\
 Usage: kavoru [options] [directory]
+       kavoru module <module-name> [options]
 
 Create a new project from the Kavoru Elysia + Bun template.
 
+Commands:
+  module <name>      Generate src/modules/<name> (routes, service, types)
+
 Arguments:
   directory          Project folder (use "." for current directory)
 
@@ -33,14 +37,15 @@ Options:
   --no-features <list>  Comma-separated features to exclude
 
 Features:
-  auth, postgres, otel, sentry, kafka, websocket, resend, cron, docker
-  (prisma is accepted as an alias for postgres)
+  auth, postgres, otel, sentry, kafka, websocket, resend, cron, docker, cli
+  (prisma is accepted as an alias for postgres; kavoru-cli for cli)
 
 Examples:
   bunx kavoru@latest my-api
   bunx kavoru@latest my-api --minimal
   bunx kavoru@latest my-api --features auth,postgres,otel
   bunx kavoru@latest my-api --no-features kafka,docker,resend
+  bunx kavoru@latest module users
 `;
 
 export function parseArgs(argv: string[]): CliOptions {

package/src/cli.ts

@@ -21,6 +21,7 @@ import {
   customizeProject,
   fetchTemplate,
   installDependencies,
+  linkProjectCli,
   removeGitMetadata,
   resolveTemplateSource,
 } from "./template";
@@ -136,6 +137,9 @@ export async function runCli(options: CliOptions): Promise<void> {
 
     if (options.install) {
       await installDependencies(targetDir);
+      if (featureSelection.cli) {
+        await linkProjectCli(targetDir);
+      }
     }
   } finally {
     await rm(tempDir, { recursive: true, force: true }).catch(() => undefined);
@@ -150,6 +154,12 @@ export async function runCli(options: CliOptions): Promise<void> {
   if (!options.install) {
     console.log("  bun install");
   }
+  if (featureSelection.cli) {
+    if (!options.install) {
+      console.log("  bun run link-cli       # once: put kavoru on PATH");
+    }
+    console.log("  kavoru module <name>");
+  }
   console.log("  bun run dev");
   console.log();
   console.log("  API:     http://localhost:3131");

package/src/features.ts

@@ -11,10 +11,12 @@ export type FeatureId =
   | "websocket"
   | "resend"
   | "cron"
-  | "docker";
+  | "docker"
+  | "cli";
 
 const FEATURE_ALIASES: Record<string, FeatureId> = {
   prisma: "postgres",
+  "kavoru-cli": "cli",
 };
 
 export type FeatureSelection = Record<FeatureId, boolean>;
@@ -71,6 +73,11 @@ export const FEATURES: FeatureDef[] = [
     label: "Docker",
     description: "Dockerfile and Docker Compose stack",
   },
+  {
+    id: "cli",
+    label: "Project CLI",
+    description: "kavoru module command, bin, and module scaffolds",
+  },
 ];
 
 export const FEATURE_IDS = FEATURES.map((feature) => feature.id);
@@ -113,6 +120,17 @@ const FEATURE_PATHS: Record<FeatureId, string[]> = {
   resend: ["src/infra/resend"],
   cron: ["src/schedules"],
   docker: ["docker-compose.yaml", "docker"],
+  cli: [
+    "bin/kavoru.js",
+    "kavoru",
+    "kavoru.cmd",
+    "scripts/kavoru-cli.ts",
+    "scripts/generate-module.ts",
+    "scripts/link-cli.ts",
+    "__tests__/generate-module.test.ts",
+    "__tests__/kavoru-cli.test.ts",
+    "__tests__/link-cli.test.ts",
+  ],
 };
 
 const FEATURE_DEPENDENCIES: Partial<
@@ -141,6 +159,7 @@ const FEATURE_SCRIPTS: Partial<Record<FeatureId, string[]>> = {
   otel: ["otel:view", "otel:tui"],
   sentry: ["sentry:spotlight"],
   postgres: ["seed"],
+  cli: ["link-cli"],
 };
 
 function resolveFeatureId(raw: string): FeatureId | null {
@@ -446,6 +465,7 @@ async function patchPackageJson(
   if (!(await pkgFile.exists())) return;
 
   const pkg = (await pkgFile.json()) as {
+    bin?: Record<string, string>;
     dependencies?: Record<string, string>;
     devDependencies?: Record<string, string>;
     scripts?: Record<string, string>;
@@ -476,6 +496,12 @@ async function patchPackageJson(
     pkg.scripts.start = "bun run src/index.ts";
   }
 
+  if (!selection.cli) {
+    delete pkg.bin;
+  } else {
+    pkg.bin = { kavoru: "./bin/kavoru.js" };
+  }
+
   await Bun.write(pkgPath, `${JSON.stringify(pkg, null, 2)}\n`);
 }
 

package/src/index.ts

@@ -3,10 +3,23 @@
 import { parseArgs, printHelp, printVersion } from "./args";
 import { runCli } from "./cli";
 import { log } from "./log";
+import { printModuleHelp, runModuleCommand } from "./module-cli";
 
 async function main(): Promise<void> {
   try {
-    const options = parseArgs(process.argv.slice(2));
+    const argv = process.argv.slice(2);
+
+    if (argv[0] === "module") {
+      if (argv.includes("-h") || argv.includes("--help")) {
+        printModuleHelp();
+        return;
+      }
+
+      await runModuleCommand(argv.slice(1));
+      return;
+    }
+
+    const options = parseArgs(argv);
 
     if (options.help) {
       printHelp();

package/src/module-cli.ts

@@ -0,0 +1,79 @@
+import { existsSync } from "node:fs";
+import path from "node:path";
+import { log } from "./log";
+
+function findProjectRoot(cwd: string): string {
+  let current = path.resolve(cwd);
+
+  while (true) {
+    const packageJson = path.join(current, "package.json");
+    const localCli = path.join(current, "scripts/kavoru-cli.ts");
+    const moduleScript = path.join(current, "scripts/generate-module.ts");
+    if (
+      existsSync(packageJson) &&
+      (existsSync(localCli) || existsSync(moduleScript))
+    ) {
+      return current;
+    }
+
+    const parent = path.dirname(current);
+    if (parent === current) {
+      break;
+    }
+    current = parent;
+  }
+
+  throw new Error(
+    "Could not find a Kavoru project with the Project CLI enabled. Scaffold with the cli feature or run from a project that includes scripts/kavoru-cli.ts.",
+  );
+}
+
+export async function runModuleCommand(argv: string[]): Promise<void> {
+  const force = argv.includes("--force") || argv.includes("-f");
+  const name = argv.find((arg) => !arg.startsWith("-"));
+
+  if (!name) {
+    throw new Error("Usage: kavoru module <module-name> [--force]");
+  }
+
+  const projectDir = findProjectRoot(process.cwd());
+  const localCli = path.join(projectDir, "scripts/kavoru-cli.ts");
+  const scriptPath = existsSync(localCli)
+    ? localCli
+    : path.join(projectDir, "scripts/generate-module.ts");
+  const cmd = existsSync(localCli)
+    ? ["bun", scriptPath, "module", name]
+    : ["bun", scriptPath, name];
+  if (force) cmd.push("--force");
+
+  log.info(`Generating module "${name}" in ${projectDir}`);
+
+  const proc = Bun.spawn(cmd, {
+    cwd: projectDir,
+    stdout: "inherit",
+    stderr: "inherit",
+  });
+
+  const exitCode = await proc.exited;
+  if (exitCode !== 0) {
+    process.exit(exitCode ?? 1);
+  }
+}
+
+export function printModuleHelp(): void {
+  console.log(`\
+Usage: kavoru module <module-name> [options]
+
+Generate a feature module under src/modules/<module-name>/ with:
+  routes.ts, service.ts, types.ts
+  src/models/schemas/<module-name>.ts (query, body, params schemas)
+
+Options:
+  -f, --force   Overwrite an existing module folder
+  -h, --help    Show help
+
+Examples:
+  kavoru module users
+  kavoru module user-profile --force
+`);
+}

package/src/template.ts

@@ -1,3 +1,4 @@
+import { existsSync } from "node:fs";
 import { cp, mkdir, rm } from "node:fs/promises";
 import path from "node:path";
 import { TEMPLATE_BRANCH } from "./constants";
@@ -149,6 +150,16 @@ export async function installDependencies(projectDir: string): Promise<void> {
   await runCommand(["bun", "install"], projectDir);
 }
 
+export async function linkProjectCli(projectDir: string): Promise<void> {
+  const script = path.join(projectDir, "scripts/link-cli.ts");
+  if (!existsSync(script)) {
+    return;
+  }
+
+  log.step("Linking kavoru to PATH (~/.bun/bin)");
+  await runCommand(["bun", script], projectDir);
+}
+
 export function resolveTemplateSource(
   repo: string,
   branch: string,