buncargo 1.0.29 → 3.0.0

package/src/environment/index.ts

@@ -0,0 +1 @@
+export { createDevEnvironment } from "./create-dev-environment";

package/src/environment/logging.ts

@@ -0,0 +1,101 @@
+import pc from "picocolors";
+
+function formatUrl(url: string): string {
+	return pc.cyan(
+		url.replace(/:(\d+)(\/?)/, (_, port, slash) => `:${pc.bold(port)}${slash}`),
+	);
+}
+
+function formatLabel(label: string, value: string, arrow = "➜"): string {
+	return `  ${pc.green(arrow)}  ${pc.bold(label.padEnd(10))} ${value}`;
+}
+
+function formatDimLabel(label: string, value: string): string {
+	return `  ${pc.dim("•")}  ${pc.dim(label.padEnd(10))} ${pc.dim(value)}`;
+}
+
+export function logEnvironmentInfo(input: {
+	label: string;
+	projectName: string;
+	services: Record<string, unknown>;
+	apps: Record<string, unknown>;
+	ports: Record<string, number>;
+	localIp: string;
+	worktree: boolean;
+	portOffset: number;
+	projectSuffix?: string;
+}): void {
+	const {
+		label,
+		projectName,
+		services,
+		apps,
+		ports,
+		localIp,
+		worktree,
+		portOffset,
+		projectSuffix,
+	} = input;
+	const serviceNames = Object.keys(services);
+	const appNames = Object.keys(apps);
+
+	console.log("");
+	console.log(`  ${pc.cyan(pc.bold(`🐳 ${label}`))}`);
+	console.log(formatLabel("Project:", pc.white(projectName)));
+
+	if (serviceNames.length > 0) {
+		console.log("");
+		console.log(`  ${pc.dim("─── Services ───")}`);
+		for (const name of serviceNames) {
+			const port = ports[name];
+			const url = `localhost:${port}`;
+			console.log(formatLabel(`${name}:`, formatUrl(`http://${url}`)));
+		}
+	}
+
+	if (appNames.length > 0) {
+		console.log("");
+		console.log(`  ${pc.dim("─── Applications ───")}`);
+		for (const name of appNames) {
+			const port = ports[name];
+			const localUrl = `http://localhost:${port}`;
+			const networkUrl = `http://${localIp}:${port}`;
+
+			console.log(`  ${pc.green("➜")}  ${pc.bold(pc.cyan(name))}`);
+			console.log(`       ${pc.dim("Local:")}   ${formatUrl(localUrl)}`);
+			console.log(`       ${pc.dim("Network:")} ${formatUrl(networkUrl)}`);
+		}
+	}
+
+	console.log("");
+	console.log(`  ${pc.dim("─── Environment ───")}`);
+	console.log(formatDimLabel("Worktree:", worktree ? "yes" : "no"));
+	console.log(
+		formatDimLabel("Port offset:", portOffset > 0 ? `+${portOffset}` : "none"),
+	);
+	if (projectSuffix) {
+		console.log(formatDimLabel("Suffix:", projectSuffix));
+	}
+	console.log(formatDimLabel("Local IP:", localIp));
+	console.log("");
+}
+
+export function logPublicUrls(
+	tunnels: Array<{
+		kind: "service" | "app";
+		name: string;
+		publicUrl: string;
+		localUrl: string;
+	}>,
+): void {
+	if (tunnels.length === 0) return;
+
+	console.log("");
+	console.log(`  ${pc.dim("─── Public URLs (Quick Tunnel) ───")}`);
+	for (const tunnel of tunnels) {
+		const label = `${tunnel.name} (${tunnel.kind})`;
+		console.log(formatLabel(`${label}:`, formatUrl(tunnel.publicUrl), "🌐"));
+		console.log(formatDimLabel("Local target:", tunnel.localUrl));
+	}
+	console.log("");
+}

package/src/environment/seeding.ts

@@ -0,0 +1,57 @@
+import type {
+	AppConfig,
+	HookContext,
+	SeedCheckContext,
+	ServiceConfig,
+} from "../types";
+
+export function createCheckTableHelper<
+	TServices extends Record<string, ServiceConfig>,
+	TApps extends Record<string, AppConfig>,
+>(
+	urls: Record<string, string>,
+	exec: (
+		cmd: string,
+		options?: { throwOnError?: boolean },
+	) => Promise<{
+		exitCode: number;
+		stdout: string;
+		stderr: string;
+	}>,
+): SeedCheckContext<TServices, TApps>["checkTable"] {
+	return async (
+		tableName: string,
+		service?: keyof TServices,
+	): Promise<boolean> => {
+		const serviceName = (service ?? "postgres") as string;
+		const serviceUrl = urls[serviceName];
+		if (!serviceUrl) {
+			console.warn(`⚠️ Service "${serviceName}" not found for checkTable`);
+			return true;
+		}
+		const checkResult = await exec(
+			`psql "${serviceUrl}" -tAc 'SELECT COUNT(*) FROM "${tableName}" LIMIT 1'`,
+			{ throwOnError: false },
+		);
+		const count = checkResult.stdout.trim();
+		const shouldSeed =
+			checkResult.exitCode !== 0 || count === "0" || count === "";
+		if (!shouldSeed) {
+			console.log(`  📊 Table "${tableName}" has ${count} rows`);
+		}
+		return shouldSeed;
+	};
+}
+
+export function createSeedCheckContext<
+	TServices extends Record<string, ServiceConfig>,
+	TApps extends Record<string, AppConfig>,
+>(
+	baseContext: HookContext<TServices, TApps>,
+	checkTable: SeedCheckContext<TServices, TApps>["checkTable"],
+): SeedCheckContext<TServices, TApps> {
+	return {
+		...baseContext,
+		checkTable,
+	};
+}

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

@@ -3,25 +3,33 @@
 // ═══════════════════════════════════════════════════════════════════════════
 
 // CLI runner
-export { getFlagValue, hasFlag, runCli } from "./cli";
+export { getFlagValue, hasFlag, runCli } from "./cli/run-cli";
 // Config factory
 export {
 	assertValidConfig,
 	defineDevConfig,
 	mergeConfigs,
 	validateConfig,
-} from "./config";
+} from "./config/index";
+export type {
+	ClickhouseServiceOptions,
+	CustomServiceOptions,
+	PostgresServiceOptions,
+	RedisServiceOptions,
+} from "./docker-compose/services";
+// Service helpers
+export { service } from "./docker-compose/services";
 // Environment factory
-export { createDevEnvironment } from "./environment";
+export { createDevEnvironment } from "./environment/index";
+// Config loader (for programmatic access)
+export { clearDevEnvCache, getDevEnv, loadDevEnv } from "./loader/index";
 // Lint / Typecheck
 export {
 	runWorkspaceTypecheck,
 	type TypecheckResult,
 	type WorkspaceTypecheckOptions,
 	type WorkspaceTypecheckResult,
-} from "./lint";
-// Config loader (for programmatic access)
-export { clearDevEnvCache, getDevEnv, loadDevEnv } from "./loader";
+} from "./typecheck/index";
 
 // ═══════════════════════════════════════════════════════════════════════════
 // Types
@@ -34,6 +42,7 @@ export type {
 	CliOptions,
 	// Computed types
 	ComputedPorts,
+	ComputedPublicUrls,
 	ComputedUrls,
 	// Main config
 	DevConfig,
@@ -42,6 +51,14 @@ export type {
 	DevHooks,
 	DevOptions,
 	DevServerPids,
+	DockerComposeGenerationOptions,
+	DockerComposeHealthcheckRaw,
+	DockerComposeNode,
+	DockerComposeServiceRaw,
+	DockerComposeVolumeRaw,
+	DockerPresetName,
+	DockerPresetServiceDefinition,
+	DockerServiceDefinition,
 	EnvVarsBuilder,
 	ExecOptions,
 	HealthCheckFn,
@@ -61,33 +78,22 @@ export type {
 	StopOptions,
 	UrlBuilderContext,
 	UrlBuilderFn,
-} from "./types";
+} from "./types/index";
 
 // ═══════════════════════════════════════════════════════════════════════════
 // Core Utilities (for advanced use cases)
 // ═══════════════════════════════════════════════════════════════════════════
 
-export {
-	areContainersRunning,
-	assertDockerRunning,
-	DOCKER_NOT_RUNNING_MESSAGE,
-	isContainerRunning,
-	isDockerRunning,
-	MAX_ATTEMPTS,
-	POLL_INTERVAL,
-} from "./core/docker";
-
 export { getLocalIp, isPortAvailable, waitForServer } from "./core/network";
 export {
-	computeDevIdentity,
 	calculatePortOffset,
+	computeDevIdentity,
 	findMonorepoRoot,
 	getProjectName,
-	getWorktreeProjectSuffix,
 	getWorktreeName,
+	getWorktreeProjectSuffix,
 	isWorktree,
 } from "./core/ports";
-
 export {
 	getProcessOnPort,
 	isPortInUse,
@@ -96,6 +102,13 @@ export {
 	killProcessOnPort,
 	killProcessOnPortAndWait,
 } from "./core/process";
+export {
+	type PublicExposeTarget,
+	type PublicTunnel,
+	resolveExposeTargets,
+	startPublicTunnels,
+	stopPublicTunnels,
+} from "./core/tunnel";
 export {
 	getEnvVar,
 	isCI,
@@ -113,3 +126,19 @@ export {
 	stopHeartbeat,
 	stopWatchdog,
 } from "./core/watchdog";
+export {
+	areContainersRunning,
+	assertDockerRunning,
+	DOCKER_NOT_RUNNING_MESSAGE,
+	isContainerRunning,
+	isDockerRunning,
+	MAX_ATTEMPTS,
+	POLL_INTERVAL,
+} from "./docker/index";
+export {
+	buildComposeModel,
+	composeToYaml,
+	DEFAULT_GENERATED_COMPOSE_FILE,
+	getGeneratedComposePath,
+	writeGeneratedComposeFile,
+} from "./docker-compose/index";

package/src/loader/cache.ts

@@ -0,0 +1,23 @@
+import type { AppConfig, DevEnvironment, ServiceConfig } from "../types";
+
+let cachedEnv: DevEnvironment<
+	Record<string, ServiceConfig>,
+	Record<string, AppConfig>
+> | null = null;
+
+export function setCachedDevEnv(
+	env: DevEnvironment<Record<string, ServiceConfig>, Record<string, AppConfig>>,
+): void {
+	cachedEnv = env;
+}
+
+export function getCachedDevEnv(): DevEnvironment<
+	Record<string, ServiceConfig>,
+	Record<string, AppConfig>
+> | null {
+	return cachedEnv;
+}
+
+export function clearDevEnvCache(): void {
+	cachedEnv = null;
+}

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,
@@ -269,8 +369,6 @@ export interface DevOptions {
 	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;
 }
@@ -284,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>;
 
 /**
@@ -308,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
 	 * })
 	 * ```
 	 */
@@ -327,6 +431,8 @@ export interface DevConfig<
 	prisma?: PrismaConfig;
 	/** Additional options (optional) */
 	options?: DevOptions;
+	/** Docker Compose generation options (optional) */
+	docker?: DockerComposeGenerationOptions;
 }
 
 // ═══════════════════════════════════════════════════════════════════════════
@@ -366,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
 // ═══════════════════════════════════════════════════════════════════════════
@@ -426,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) */
@@ -436,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
@@ -473,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";