buncargo 1.0.26 → 3.0.0

package/src/loader/find-config-file.ts

@@ -0,0 +1,29 @@
+import { existsSync } from "node:fs";
+import { dirname, join } from "node:path";
+
+export const CONFIG_FILES = [
+	"dev.config.ts",
+	"dev.config.js",
+	"dev-tools.config.ts",
+	"dev-tools.config.js",
+];
+
+export function findConfigFile(startDir: string): string | null {
+	let currentDir = startDir;
+
+	while (true) {
+		for (const file of CONFIG_FILES) {
+			const configPath = join(currentDir, file);
+			if (existsSync(configPath)) {
+				return configPath;
+			}
+		}
+
+		const parentDir = dirname(currentDir);
+		if (parentDir === currentDir) {
+			return null;
+		}
+
+		currentDir = parentDir;
+	}
+}

package/src/loader/index.ts

@@ -0,0 +1,17 @@
+import type { AppConfig, DevEnvironment, ServiceConfig } from "../types";
+import { getCachedDevEnv } from "./cache";
+
+export { clearDevEnvCache } from "./cache";
+export { CONFIG_FILES, findConfigFile } from "./find-config-file";
+export { loadDevEnv } from "./load-dev-env";
+
+export function getDevEnv(): DevEnvironment<
+	Record<string, ServiceConfig>,
+	Record<string, AppConfig>
+> {
+	const env = getCachedDevEnv();
+	if (!env) {
+		throw new Error("Dev environment not loaded. Call loadDevEnv() first.");
+	}
+	return env;
+}

package/src/loader/load-dev-env.ts

@@ -0,0 +1,38 @@
+import { createDevEnvironment } from "../environment";
+import type { AppConfig, DevEnvironment, ServiceConfig } from "../types";
+import { getCachedDevEnv, setCachedDevEnv } from "./cache";
+import { findConfigFile } from "./find-config-file";
+
+export async function loadDevEnv(options?: {
+	cwd?: string;
+	reload?: boolean;
+}): Promise<
+	DevEnvironment<Record<string, ServiceConfig>, Record<string, AppConfig>>
+> {
+	if (!options?.reload) {
+		const cached = getCachedDevEnv();
+		if (cached) return cached;
+	}
+
+	const cwd = options?.cwd ?? process.cwd();
+	const configPath = findConfigFile(cwd);
+
+	if (configPath) {
+		const mod = await import(configPath);
+		const config = mod.default;
+
+		if (!config?.projectPrefix || !config?.services) {
+			throw new Error(
+				`Invalid config in "${configPath}". Use defineDevConfig() and export as default.`,
+			);
+		}
+
+		const env = createDevEnvironment(config);
+		setCachedDevEnv(env);
+		return env;
+	}
+
+	throw new Error(
+		"No config file found. Create dev.config.ts with: export default defineDevConfig({ ... })",
+	);
+}

package/src/prisma/index.ts

@@ -0,0 +1 @@
+export * from "./prisma";

package/{prisma.ts → src/prisma/prisma.ts}

@@ -28,7 +28,7 @@ import {
 	isContainerRunning,
 	startService,
 	waitForServiceByType,
-} from "./core/docker";
+} from "../docker/runtime";
 import type {
 	AppConfig,
 	BuiltInHealthCheck,
@@ -36,7 +36,7 @@ import type {
 	PrismaConfig,
 	PrismaRunner,
 	ServiceConfig,
-} from "./types";
+} from "../types";
 
 /**
  * Create a Prisma runner from config (used internally by createDevEnvironment).
@@ -80,9 +80,11 @@ export function createPrismaRunner<
 
 		console.log(`🐳 Starting ${service}...`);
 
+		const composeFile = env.ensureComposeFile();
 		const envVars = env.buildEnvVars();
 		startService(env.root, env.projectName, service, envVars, {
 			verbose: false,
+			composeFile,
 		});
 
 		const port = (env.ports as Record<string, number>)[service];

package/src/typecheck/index.ts

@@ -0,0 +1 @@
+export * from "./typecheck";

package/{types.ts → src/types/all-types.ts}

@@ -27,12 +27,106 @@ export interface UrlBuilderContext {
  */
 export type UrlBuilderFn = (ctx: UrlBuilderContext) => string;
 
+// ═══════════════════════════════════════════════════════════════════════════
+// Docker Compose Configuration
+// ═══════════════════════════════════════════════════════════════════════════
+
+/**
+ * Recursive YAML-safe value used for Docker Compose objects.
+ */
+export type DockerComposeNode =
+	| string
+	| number
+	| boolean
+	| null
+	| DockerComposeNode[]
+	| { [key: string]: DockerComposeNode | undefined };
+
+/**
+ * Built-in Docker service presets.
+ */
+export type DockerPresetName = "postgres" | "redis" | "clickhouse";
+
+/**
+ * Docker Compose healthcheck object.
+ */
+export interface DockerComposeHealthcheckRaw {
+	test?: string[] | string;
+	interval?: string;
+	timeout?: string;
+	retries?: number;
+	start_period?: string;
+	disable?: boolean;
+	[composeKey: string]: DockerComposeNode | undefined;
+}
+
+/**
+ * Docker Compose service (raw escape hatch).
+ * Includes common fields plus index signature for advanced keys.
+ */
+export interface DockerComposeServiceRaw {
+	image?: string;
+	container_name?: string;
+	ports?: string[];
+	volumes?: string[];
+	environment?: Record<string, string | number | boolean>;
+	command?: string | string[];
+	entrypoint?: string | string[];
+	depends_on?: string[] | Record<string, DockerComposeNode>;
+	healthcheck?: DockerComposeHealthcheckRaw;
+	ulimits?: Record<string, number | { soft: number; hard: number }>;
+	restart?: string;
+	working_dir?: string;
+	[composeKey: string]: DockerComposeNode | undefined;
+}
+
+/**
+ * Docker Compose volume object.
+ */
+export interface DockerComposeVolumeRaw {
+	driver?: string;
+	driver_opts?: Record<string, string | number | boolean>;
+	[composeKey: string]: DockerComposeNode | undefined;
+}
+
+/**
+ * Helper-friendly preset service definition.
+ */
+export interface DockerPresetServiceDefinition {
+	kind: "preset";
+	preset: DockerPresetName;
+	service?: DockerComposeServiceRaw;
+}
+
+/**
+ * Docker service definition accepted by service config.
+ * - raw object is the manual escape hatch
+ * - helper mode returns `kind`-based definitions
+ */
+export type DockerServiceDefinition =
+	| DockerComposeServiceRaw
+	| DockerPresetServiceDefinition;
+
+/**
+ * Docker Compose generation configuration.
+ */
+export interface DockerComposeGenerationOptions {
+	/** Path to generated compose file relative to root. Default: '.buncargo/docker-compose.generated.yml' */
+	generatedFile?: string;
+	/** Write strategy for generated compose file. Default: 'always' */
+	writeStrategy?: "always" | "if-missing";
+	/** Extra top-level named volumes */
+	volumes?: Record<string, DockerComposeVolumeRaw>;
+}
+
 /**
  * Configuration for a Docker Compose service (e.g., postgres, redis).
  */
 export interface ServiceConfig {
 	/** Base port for the service (before offset is applied) */
 	port: number;
+	/** Whether this service can be exposed publicly via tunnel */
+	expose?: boolean;
 	/** Optional secondary port (e.g., ClickHouse native protocol) */
 	secondaryPort?: number;
 	/** Health check: built-in name, custom function, or disabled (false) */
@@ -53,6 +147,8 @@ export interface ServiceConfig {
 	user?: string;
 	/** Password (default: 'postgres' for postgres, 'root' for mysql, 'clickhouse' for clickhouse) */
 	password?: string;
+	/** Docker Compose service definition (preset helper or raw escape hatch) */
+	docker?: DockerServiceDefinition;
 }
 
 // ═══════════════════════════════════════════════════════════════════════════
@@ -65,6 +161,8 @@ export interface ServiceConfig {
 export interface AppConfig {
 	/** Base port for the app (before offset is applied) */
 	port: number;
+	/** Whether this app can be exposed publicly via tunnel */
+	expose?: boolean;
 	/** Command to start the dev server */
 	devCommand: string;
 	/** Command to start production server (optional) */
@@ -110,6 +208,8 @@ export interface HookContext<
 	ports: ComputedPorts<TServices, TApps>;
 	/** Computed URLs for all services and apps */
 	urls: ComputedUrls<TServices, TApps>;
+	/** Public tunnel URLs for exposed services/apps (when active) */
+	publicUrls: ComputedPublicUrls<TServices, TApps>;
 	/** Execute a shell command with environment variables set */
 	exec: (
 		cmd: string,
@@ -259,12 +359,16 @@ export interface SeedConfig<
  * Options for the dev environment.
  */
 export interface DevOptions {
-	/** Enable worktree isolation (unique ports per worktree). Default: true */
+	/**
+	 * Enable worktree isolation. When true (default), each worktree gets:
+	 * - unique ports (offset)
+	 * - unique Docker Compose project name (separate containers/networks/volumes)
+	 *
+	 * Set to false to intentionally share Docker state across worktrees.
+	 */
 	worktreeIsolation?: boolean;
 	/** Auto-shutdown after idle time in ms. Set to false to disable. Default: false */
 	autoShutdown?: number | false;
-	/** Path to docker-compose.yml relative to root. Default: 'docker-compose.yml' */
-	composeFile?: string;
 	/** Default verbose setting for all operations. Default: true */
 	verbose?: boolean;
 }
@@ -278,7 +382,12 @@ export type EnvVarsBuilder<
 > = (
 	ports: ComputedPorts<TServices, TApps>,
 	urls: ComputedUrls<TServices, TApps>,
-	ctx: { projectName: string; localIp: string; portOffset: number },
+	ctx: {
+		projectName: string;
+		localIp: string;
+		portOffset: number;
+		publicUrls: ComputedPublicUrls<TServices, TApps>;
+	},
 ) => Record<string, string | number>;
 
 /**
@@ -302,11 +411,12 @@ export interface DevConfig<
 	 *
 	 * @example
 	 * ```typescript
-	 * envVars: (ports, urls, { localIp }) => ({
+	 * envVars: (ports, urls, { localIp, publicUrls }) => ({
 	 *   DATABASE_URL: urls.postgres,
 	 *   BASE_URL: urls.api,
 	 *   VITE_PORT: ports.platform,
-	 *   EXPO_API_URL: `http://${localIp}:${ports.api}`
+	 *   EXPO_API_URL: `http://${localIp}:${ports.api}`,
+	 *   WEBHOOK_URL: publicUrls.api
 	 * })
 	 * ```
 	 */
@@ -321,6 +431,8 @@ export interface DevConfig<
 	prisma?: PrismaConfig;
 	/** Additional options (optional) */
 	options?: DevOptions;
+	/** Docker Compose generation options (optional) */
+	docker?: DockerComposeGenerationOptions;
 }
 
 // ═══════════════════════════════════════════════════════════════════════════
@@ -360,6 +472,13 @@ export type ComputedUrls<
 	[K in keyof TApps]: string;
 };
 
+export type ComputedPublicUrls<
+	TServices extends Record<string, ServiceConfig>,
+	TApps extends Record<string, AppConfig>,
+> = Partial<{
+	[K in keyof TServices | keyof TApps]: string;
+}>;
+
 // ═══════════════════════════════════════════════════════════════════════════
 // Start/Stop Options
 // ═══════════════════════════════════════════════════════════════════════════
@@ -420,6 +539,10 @@ export interface DevEnvironment<
 	readonly ports: ComputedPorts<TServices, TApps>;
 	/** Computed URLs for all services and apps */
 	readonly urls: ComputedUrls<TServices, TApps>;
+	/** Public tunnel URLs for exposed services/apps (when active) */
+	readonly publicUrls: ComputedPublicUrls<TServices, TApps>;
+	/** Services configuration */
+	readonly services: TServices;
 	/** Apps configuration (for CLI to build commands) */
 	readonly apps: TApps;
 	/** Port offset applied (0 for main, > 0 for worktrees) */
@@ -430,6 +553,8 @@ export interface DevEnvironment<
 	readonly localIp: string;
 	/** Path to monorepo root */
 	readonly root: string;
+	/** Path passed to docker compose -f */
+	readonly composeFile: string;
 
 	// ─────────────────────────────────────────────────────────────────────────
 	// Container Management
@@ -467,6 +592,12 @@ export interface DevEnvironment<
 
 	/** Build environment variables for shell commands */
 	buildEnvVars(production?: boolean): Record<string, string>;
+	/** Set public tunnel URLs used by envVars and *_PUBLIC_URL injection */
+	setPublicUrls(urls: ComputedPublicUrls<TServices, TApps>): void;
+	/** Clear all public tunnel URLs */
+	clearPublicUrls(): void;
+	/** Ensure generated docker compose file exists and return path used with -f */
+	ensureComposeFile(): string;
 	/** Execute a command with environment variables set */
 	exec(
 		cmd: string,

package/src/types/index.ts

@@ -0,0 +1 @@
+export * from "./all-types";

package/bin.ts

@@ -1,191 +0,0 @@
-#!/usr/bin/env bun
-
-/**
- * CLI Entry Point for buncargo
- *
- * Usage:
- *   bunx buncargo dev           # Start containers + dev servers
- *   bunx buncargo dev --down    # Stop containers
- *   bunx buncargo dev --reset   # Stop + remove volumes
- *   bunx buncargo typecheck     # Run TypeScript typecheck
- *   bunx buncargo prisma ...    # Run prisma commands
- *   bunx buncargo help          # Show help
- */
-
-import { runCli } from "./cli";
-import { loadDevEnv } from "./loader";
-
-/**
- * Load the dev environment with CLI-friendly error output.
- */
-async function loadEnv() {
-	try {
-		return await loadDevEnv();
-	} catch (error) {
-		console.error(`❌ ${error instanceof Error ? error.message : error}`);
-		process.exit(1);
-	}
-}
-
-// ═══════════════════════════════════════════════════════════════════════════
-// Command Handlers
-// ═══════════════════════════════════════════════════════════════════════════
-
-async function handleDev(args: string[]): Promise<void> {
-	const env = await loadEnv();
-	await runCli(env, { args });
-}
-
-async function handlePrisma(args: string[]): Promise<void> {
-	const env = await loadEnv();
-
-	if (!env.prisma) {
-		console.error("❌ Prisma is not configured in your dev config.");
-		console.error("");
-		console.error("   Add prisma to your config:");
-		console.error("");
-		console.error("   export default defineDevConfig({");
-		console.error("     ...");
-		console.error("     prisma: {");
-		console.error("       cwd: 'packages/prisma'");
-		console.error("     }");
-		console.error("   })");
-		process.exit(1);
-	}
-
-	// Ensure database is running
-	const running = await env.isRunning();
-	if (!running) {
-		console.log("🐳 Starting database container...");
-		await env.start({ startServers: false, wait: true });
-	}
-
-	const exitCode = await env.prisma.run(args);
-	process.exit(exitCode);
-}
-
-async function handleEnv(): Promise<void> {
-	const env = await loadEnv();
-	console.log(
-		JSON.stringify(
-			{
-				projectName: env.projectName,
-				ports: env.ports,
-				urls: env.urls,
-				portOffset: env.portOffset,
-				isWorktree: env.isWorktree,
-				localIp: env.localIp,
-				root: env.root,
-			},
-			null,
-			2,
-		),
-	);
-}
-
-async function handleTypecheck(): Promise<void> {
-	const env = await loadEnv();
-	const { runWorkspaceTypecheck } = await import("./lint");
-	const result = await runWorkspaceTypecheck({
-		root: env.root,
-		verbose: true,
-	});
-	process.exit(result.success ? 0 : 1);
-}
-
-function showHelp(): void {
-	console.log(`
-buncargo - Development environment CLI
-
-USAGE:
-  bunx buncargo <command> [options]
-
-COMMANDS:
-  dev                 Start the development environment
-  typecheck           Run TypeScript typecheck across workspaces
-  prisma <args>       Run Prisma CLI with correct DATABASE_URL
-  env                 Print environment info as JSON
-  help                Show this help message
-  version             Show version
-
-EXAMPLES:
-  bunx buncargo dev              # Start everything
-  bunx buncargo dev --help       # Show dev command options
-  bunx buncargo dev --down       # Stop containers
-  bunx buncargo typecheck        # Run typecheck
-  bunx buncargo prisma studio    # Open Prisma Studio
-  bunx buncargo env              # Get ports/urls as JSON
-
-CONFIG:
-  Create a dev.config.ts with a default export:
-
-  import { defineDevConfig } from 'buncargo'
-
-  export default defineDevConfig({
-    projectPrefix: 'myapp',
-    services: { ... },
-    apps: { ... }
-  })
-
-Run "bunx buncargo dev --help" for dev command options.
-`);
-}
-
-function showVersion(): void {
-	const pkg = require("./package.json");
-	console.log(`buncargo v${pkg.version}`);
-}
-
-// ═══════════════════════════════════════════════════════════════════════════
-// Main
-// ═══════════════════════════════════════════════════════════════════════════
-
-async function main(): Promise<void> {
-	const args = process.argv.slice(2);
-	const command = args[0];
-	const commandArgs = args.slice(1);
-
-	if (
-		!command ||
-		command === "help" ||
-		command === "--help" ||
-		command === "-h"
-	) {
-		showHelp();
-		process.exit(0);
-	}
-
-	if (command === "version" || command === "--version" || command === "-v") {
-		showVersion();
-		process.exit(0);
-	}
-
-	switch (command) {
-		case "dev":
-			await handleDev(commandArgs);
-			break;
-
-		case "typecheck":
-			await handleTypecheck();
-			break;
-
-		case "prisma":
-			await handlePrisma(commandArgs);
-			break;
-
-		case "env":
-			await handleEnv();
-			break;
-
-		default:
-			console.error(`❌ Unknown command: ${command}`);
-			console.error("");
-			console.error('   Run "bunx buncargo help" for available commands.');
-			process.exit(1);
-	}
-}
-
-main().catch((error) => {
-	console.error("❌ Fatal error:", error);
-	process.exit(1);
-});