@beignet/cli 0.0.9 → 0.0.10

package/src/choices.ts

@@ -1,7 +1,8 @@
 /**
- * Choice lists and string-literal types shared by the CLI entrypoint and the
- * heavier scaffold/generator modules. Keeping them here lets the bin define
- * flag enums without loading templates or generators at startup.
+ * Choice lists, string-literal types, and small pure helpers shared by the
+ * CLI entrypoint and the heavier scaffold/generator modules. Keeping them
+ * here lets the bin define flag enums and next steps without loading
+ * templates or generators at startup.
  */
 
 /**
@@ -19,6 +20,10 @@ export type TemplateName = "next";
  * integrations that add an external service remain selectable.
  */
 export type IntegrationName = "inngest" | "resend" | "upstash-rate-limit";
+/**
+ * Databases supported by the starter's Drizzle persistence layer.
+ */
+export type DatabaseName = "sqlite" | "postgres" | "mysql";
 
 /**
  * Supported scaffold template choices.
@@ -46,6 +51,68 @@ export const integrationChoices = [
   "upstash-rate-limit",
 ] as const satisfies readonly IntegrationName[];
 
+/**
+ * Supported scaffold database choices.
+ */
+export const databaseChoices = [
+  "sqlite",
+  "postgres",
+  "mysql",
+] as const satisfies readonly DatabaseName[];
+
+/**
+ * Local database name derived from the app name.
+ *
+ * Postgres and MySQL database identifiers are stricter than project names,
+ * so dashes and dots become underscores. Used by `.env.example`, the
+ * generated drizzle config, and the create command's next steps, which must
+ * all point at the same local database.
+ */
+export function databaseLocalName(appName: string): string {
+  return appName.replaceAll(/[^a-z0-9_]/g, "_");
+}
+
+/**
+ * Docker one-liner that starts a local database matching the generated
+ * `.env.example` connection URL. Returns undefined for SQLite, which needs
+ * no server.
+ */
+export function databaseStartCommand(
+  database: DatabaseName,
+  appName: string,
+): string | undefined {
+  const databaseName = databaseLocalName(appName);
+
+  switch (database) {
+    case "postgres":
+      return `docker run --rm -d -e POSTGRES_USER=beignet -e POSTGRES_PASSWORD=beignet -e POSTGRES_DB=${databaseName} -p 5432:5432 postgres:17-alpine`;
+    case "mysql":
+      return `docker run --rm -d -e MYSQL_ROOT_PASSWORD=beignet -e MYSQL_DATABASE=${databaseName} -p 3306:3306 mysql:8.4`;
+    default:
+      return undefined;
+  }
+}
+
+/**
+ * Local development connection URL matching `databaseStartCommand`.
+ * Used as the `.env.example` value and the generated env defaults.
+ */
+export function databaseLocalUrl(
+  database: DatabaseName,
+  appName: string,
+): string {
+  const databaseName = databaseLocalName(appName);
+
+  switch (database) {
+    case "postgres":
+      return `postgres://beignet:beignet@127.0.0.1:5432/${databaseName}`;
+    case "mysql":
+      return `mysql://root:beignet@127.0.0.1:3306/${databaseName}`;
+    default:
+      return "file:local.db";
+  }
+}
+
 /**
  * Shells supported by `beignet completion install` and `uninstall`.
  */

package/src/create-prompts.ts

@@ -7,6 +7,8 @@
  */
 
 import {
+  type DatabaseName,
+  databaseChoices,
   type IntegrationName,
   integrationChoices,
   type PackageManager,
@@ -18,6 +20,7 @@ import {
 export type CreateSelections = {
   directory?: string;
   api?: boolean;
+  db?: DatabaseName;
   integrations?: readonly IntegrationName[];
   packageManager?: PackageManager;
 };
@@ -35,9 +38,9 @@ type CreatePromptTty = {
  * Decide whether `beignet create` should run the interactive prompt flow.
  *
  * Prompts run only on a full TTY, only when `--yes` is absent, and only when
- * no selection flag was passed. Any explicit api, integration, or package
- * manager selection means the invocation is scripted, so the non-interactive
- * path stays byte-identical for agents and CI.
+ * no selection flag was passed. Any explicit api, database, integration, or
+ * package manager selection means the invocation is scripted, so the
+ * non-interactive path stays byte-identical for agents and CI.
  */
 export function shouldPromptInteractively(
   flags: CreatePromptFlags,
@@ -48,6 +51,7 @@ export function shouldPromptInteractively(
 
   const selectionFlagPassed =
     flags.api !== undefined ||
+    flags.db !== undefined ||
     (flags.integrations?.length ?? 0) > 0 ||
     flags.packageManager !== undefined;
 
@@ -60,6 +64,12 @@ const integrationHints: Record<IntegrationName, string> = {
   "upstash-rate-limit": "Upstash-backed rate limiting",
 };
 
+const databaseHints: Record<DatabaseName, string> = {
+  sqlite: "libSQL/Turso, zero setup — default",
+  postgres: "node-postgres, requires a Postgres 14+ server",
+  mysql: "mysql2, requires MySQL 8.0+",
+};
+
 /**
  * Run the interactive `beignet create` prompt flow.
  *
@@ -92,6 +102,17 @@ export async function promptCreateSelections(
   });
   if (prompts.isCancel(api)) return undefined;
 
+  const db = await prompts.select<DatabaseName>({
+    message: "Which database?",
+    options: databaseChoices.map((database) => ({
+      value: database,
+      label: database,
+      hint: databaseHints[database],
+    })),
+    initialValue: initial.db ?? "sqlite",
+  });
+  if (prompts.isCancel(db)) return undefined;
+
   const integrations = await prompts.multiselect<IntegrationName>({
     message: "Add provider integrations? (press enter to skip)",
     options: integrationChoices.map((integration) => ({
@@ -108,6 +129,7 @@ export async function promptCreateSelections(
   return {
     directory,
     api,
+    db,
     integrations,
     packageManager: initial.packageManager,
   };

package/src/create.ts

@@ -1,6 +1,8 @@
 import { mkdir, readdir, writeFile } from "node:fs/promises";
 import path from "node:path";
 import {
+  type DatabaseName,
+  databaseChoices,
   getTemplateFiles,
   type IntegrationName,
   integrationChoices,
@@ -22,6 +24,11 @@ export type CreateOptions = {
   api?: boolean;
   packageManager?: PackageManager;
   integrations?: IntegrationName[];
+  /**
+   * Database backing the starter's Drizzle persistence layer.
+   * Defaults to "sqlite".
+   */
+  db?: DatabaseName;
   force?: boolean;
   dryRun?: boolean;
   beignetVersion?: string;
@@ -37,6 +44,7 @@ export type CreateResult = {
   dryRun: boolean;
   files: string[];
   packageManager: PackageManager;
+  database: DatabaseName;
 };
 
 /**
@@ -52,6 +60,7 @@ export async function createProject(
   const template = options.template ?? "next";
   const api = Boolean(options.api);
   const integrations = resolveIntegrations(options.integrations ?? []);
+  const database = options.db ?? "sqlite";
 
   if (template !== "next") {
     throw new Error(
@@ -59,6 +68,12 @@ export async function createProject(
     );
   }
 
+  if (!databaseChoices.includes(database)) {
+    throw new Error(
+      `Unknown database "${database}". Available databases: ${databaseChoices.join(", ")}`,
+    );
+  }
+
   const dryRun = Boolean(options.dryRun);
 
   await assertCanWrite(targetDir, Boolean(options.force));
@@ -69,6 +84,7 @@ export async function createProject(
     beignetVersion: options.beignetVersion ?? getDefaultBeignetVersion(),
     api,
     integrations,
+    database,
   });
 
   if (!dryRun) {
@@ -88,6 +104,7 @@ export async function createProject(
     dryRun,
     files: files.map((file) => file.path),
     packageManager,
+    database,
   };
 }
 
@@ -101,9 +118,14 @@ function resolveIntegrations(
   explicitIntegrations: IntegrationName[],
 ): IntegrationName[] {
   for (const integration of explicitIntegrations) {
-    if (baseProviderNames.has(integration)) {
+    const integrationName: string = integration;
+    if (baseProviderNames.has(integrationName)) {
+      const databaseHint =
+        integrationName === "drizzle-sqlite"
+          ? " Choose the starter database with --db sqlite|postgres|mysql instead."
+          : "";
       throw new Error(
-        `${integration} is part of every Beignet starter and no longer an --integrations choice.`,
+        `${integration} is part of every Beignet starter and no longer an --integrations choice.${databaseHint}`,
       );
     }
   }

package/src/index.ts

@@ -16,6 +16,9 @@ import {
 import {
   type CompletionShell,
   completionShellChoices,
+  type DatabaseName,
+  databaseChoices,
+  databaseStartCommand,
   type IntegrationName,
   integrationChoices,
   type MakeFeatureAddon,
@@ -44,6 +47,7 @@ const outputFormatChoices = [
 type CreateFlags = {
   template: TemplateName;
   api?: boolean;
+  db?: DatabaseName;
   packageManager?: PackageManager;
   integrations?: readonly IntegrationName[];
   yes?: boolean;
@@ -282,10 +286,11 @@ const createCommand = buildCommand<
   docs: {
     brief: "Create a new Beignet app.",
     fullDescription: `Scaffolds a full-stack Beignet starter: typed contracts, Better Auth,
-Drizzle/libSQL persistence with checked-in migrations, pino logging,
-devtools, and a shadcn UI shell. Pass --api for an API-only scaffold
-without the UI shell.
+Drizzle persistence with checked-in migrations, pino logging, devtools,
+and a shadcn UI shell. Pass --api for an API-only scaffold without the
+UI shell, and --db to choose the database.
 
+Available databases: ${databaseChoices.join(", ")}
 Available integrations: ${integrationChoices.join(", ")}
 
 Running create on an interactive terminal without selection flags opens a
@@ -305,6 +310,12 @@ prompt-based setup. Pass --yes or any selection flag to skip the prompts.`,
         withNegated: false,
         brief: "Scaffold an API-only app without the UI shell.",
       },
+      db: {
+        kind: "enum",
+        values: databaseChoices,
+        optional: true,
+        brief: "Database for Drizzle persistence. Default: sqlite.",
+      },
       packageManager: {
         kind: "enum",
         values: packageManagerChoices,
@@ -354,6 +365,7 @@ prompt-based setup. Pass --yes or any selection flag to skip the prompts.`,
       let selections: CreateSelections = {
         directory,
         api: flags.api,
+        db: flags.db,
         integrations: flags.integrations,
         packageManager: flags.packageManager,
       };
@@ -382,6 +394,7 @@ prompt-based setup. Pass --yes or any selection flag to skip the prompts.`,
       }
 
       const api = selections.api ?? false;
+      const database = selections.db ?? "sqlite";
       const integrations = uniqueValues([...(selections.integrations ?? [])]);
       const result = await createProject({
         name: selections.directory,
@@ -389,6 +402,7 @@ prompt-based setup. Pass --yes or any selection flag to skip the prompts.`,
         api,
         packageManager: selections.packageManager,
         integrations,
+        db: database,
         force: Boolean(flags.force),
         dryRun: Boolean(flags.dryRun),
       });
@@ -397,7 +411,7 @@ prompt-based setup. Pass --yes or any selection flag to skip the prompts.`,
         this,
         flags.json
           ? JSON.stringify(result, null, 2)
-          : nextSteps(result, { api, integrations }),
+          : nextSteps(result, { api, integrations, database }),
       );
     };
   },
@@ -1238,6 +1252,7 @@ function nextSteps(
   options: {
     api?: boolean;
     integrations?: readonly IntegrationName[];
+    database?: DatabaseName;
   } = {},
 ): string {
   if (result.dryRun) {
@@ -1261,6 +1276,15 @@ ${plannedFiles}`;
   const openStep = options.api
     ? "  open http://localhost:3000 for the API landing page"
     : "  open http://localhost:3000/sign-up";
+  const startDatabaseCommand = options.database
+    ? databaseStartCommand(options.database, result.name)
+    : undefined;
+  const startDatabaseStep = startDatabaseCommand
+    ? `Start the database:
+  ${startDatabaseCommand}
+
+`
+    : "";
 
   return `Created ${result.name} at ${result.targetDir}
 
@@ -1269,7 +1293,7 @@ Next steps:
   ${pm} install
   cp .env.example .env.local
 ${envStep}
-Prepare the database:
+${startDatabaseStep}Prepare the database:
   ${cli} db migrate
 
 Start the app: