fix: resolve #2

README.md

@@ -55,7 +55,7 @@ npm install pgstrap --save-dev
 
 - `npm run db:migrate` - Run pending migrations
 - `npm run db:reset` - Drop and recreate the database, then run all migrations
-- `npm run db:generate` - Generate types and structure dumps. Use `pgstrap generate --pglite` to run migrations against an in-memory PGlite instance.
+- `npm run db:generate` - Generate types and structure dumps. By default this runs migrations against an in-memory PGlite instance, so no running postgres is required. Use `pgstrap generate --no-pglite` to generate against a real postgres database from your environment instead.
 - `npm run db:create-migration` - Create a new migration file
 
 ### Configuration

src/cli.ts

@@ -35,7 +35,7 @@ import { getProjectContext } from "./get-project-context"
     "generate",
     "generate types and sql documentation from database",
     (yargs) => {
-      yargs.option("pglite", { type: "boolean", default: false })
+      yargs.option("pglite", { type: "boolean", default: true })
     },
     async (argv) => {
       generate({ ...(await getProjectContext()), pglite: !!argv.pglite })

src/generate.ts

@@ -12,7 +12,7 @@ export const generate = async ({
   schemas,
   defaultDatabase,
   dbDir,
-  pglite = false,
+  pglite = true,
   migrationsDir,
 }: Pick<Context, "schemas" | "defaultDatabase" | "dbDir"> & {
   pglite?: boolean

tests/generate.default.test.ts

@@ -0,0 +1,48 @@
+import { test, expect } from "bun:test"
+import fs from "fs"
+import os from "os"
+import path from "path"
+import { generate } from "../src/generate"
+
+const migrationFile = `
+exports.up = async (pgm) => {
+  pgm.createTable('foo', { id: 'id' })
+}
+exports.down = async (pgm) => {
+  pgm.dropTable('foo')
+}
+`
+
+test("generate defaults to pglite so no running postgres is required", async () => {
+  const tmp = fs.mkdtempSync(
+    path.join(os.tmpdir(), "pgstrap-generate-default-"),
+  )
+  const migrationsDir = path.join(tmp, "migrations")
+  fs.mkdirSync(migrationsDir, { recursive: true })
+  fs.writeFileSync(
+    path.join(migrationsDir, "001_create_table.js"),
+    migrationFile,
+  )
+
+  await generate({
+    schemas: ["public"],
+    defaultDatabase: "postgres",
+    dbDir: path.join(tmp, "db"),
+    migrationsDir,
+  })
+
+  const zapatosFile = path.join(tmp, "db", "zapatos", "schema.d.ts")
+  const structureDir = path.join(
+    tmp,
+    "db",
+    "structure",
+    "public",
+    "tables",
+    "foo",
+  )
+
+  expect(fs.existsSync(zapatosFile)).toBe(true)
+  expect(fs.existsSync(path.join(structureDir, "table.sql"))).toBe(true)
+
+  fs.rmSync(tmp, { recursive: true, force: true })
+})