From bbc051444e44805fe778dc7a76d168a29a950942 Mon Sep 17 00:00:00 2001 From: Seowoo Han Date: Wed, 20 May 2026 10:54:50 +0900 Subject: [PATCH] Default db generate to PGlite --- README.md | 6 +- src/cli.ts | 12 +++- src/generate.ts | 118 +++++++++++++++++++--------------- tests/generate.pglite.test.ts | 5 +- 4 files changed, 82 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 20e3127..bb0f133 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![npm version](https://badge.fury.io/js/pgstrap.svg)](https://badge.fury.io/js/pgstrap) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) -pgstrap allows you to easily run typescript migrations or generate a directory that represents your database schemas with `table.sql` files. Run `pgstrap generate` to generate a directory with the structure of your postgres database schemas! +pgstrap allows you to easily run typescript migrations or generate a directory that represents your database schemas with `table.sql` files. Run `pgstrap generate` to generate a directory with the structure of your postgres database schemas. By default, generation runs migrations against an in-memory PGlite database, so a local Postgres server is not required. ## Features @@ -44,7 +44,7 @@ npm install pgstrap --save-dev npm run db:migrate ``` -6. Generate types and structure: +6. Generate types and structure without needing a local Postgres server: ```bash npm run db:generate ``` @@ -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 against an in-memory PGlite instance, so a local Postgres server is not required. Use `pgstrap generate --no-pglite` if you want to generate from `DATABASE_URL` instead. - `npm run db:create-migration` - Create a new migration file ### Configuration diff --git a/src/cli.ts b/src/cli.ts index 9a9bdec..7765ac4 100644 --- a/src/cli.ts +++ b/src/cli.ts @@ -35,10 +35,18 @@ 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, + describe: + "run migrations against an in-memory PGlite database before generating types", + }) }, async (argv) => { - generate({ ...(await getProjectContext()), pglite: !!argv.pglite }) + generate({ + ...(await getProjectContext()), + pglite: argv.pglite !== false, + }) }, ) .parse() diff --git a/src/generate.ts b/src/generate.ts index f337094..c3f9e79 100644 --- a/src/generate.ts +++ b/src/generate.ts @@ -12,7 +12,7 @@ export const generate = async ({ schemas, defaultDatabase, dbDir, - pglite = false, + pglite = true, migrationsDir, }: Pick & { pglite?: boolean @@ -27,65 +27,79 @@ export const generate = async ({ const net = await import("node:net") const db = new PGlite() + let server: ReturnType | undefined + const prevDbUrl = process.env.DATABASE_URL - await migrate({ - client: db as any, - migrationsDir, - defaultDatabase, - cwd: process.cwd(), - schemas, - }) + try { + await migrate({ + client: db as any, + migrationsDir, + defaultDatabase, + cwd: process.cwd(), + schemas, + }) - const server = net.createServer(async (socket) => { - const connection = await fromNodeSocket(socket, { - serverVersion: "16.3 (PGlite)", - auth: { - method: "password", - validateCredentials: ({ username, password }: any) => - username === "postgres" && password === "postgres", - getClearTextPassword: () => "postgres", - }, - async onStartup() { - await (db as any).waitReady - }, - async onMessage(data: Uint8Array, { isAuthenticated }: any) { - if (!isAuthenticated) return - try { - const { data: responseData } = await (db as any).execProtocol(data) - return responseData - } catch { - return undefined - } - }, + server = net.createServer(async (socket) => { + await fromNodeSocket(socket, { + serverVersion: "16.3 (PGlite)", + auth: { + method: "password", + validateCredentials: ({ username, password }: any) => + username === "postgres" && password === "postgres", + getClearTextPassword: () => "postgres", + }, + async onStartup() { + await (db as any).waitReady + }, + async onMessage(data: Uint8Array, { isAuthenticated }: any) { + if (!isAuthenticated) return + try { + const { data: responseData } = await (db as any).execProtocol( + data, + ) + return responseData + } catch { + return undefined + } + }, + }) }) - }) - await new Promise((resolve) => server.listen(0, resolve)) - const port = (server.address() as any).port - const connectionString = `postgres://postgres:postgres@127.0.0.1:${port}/postgres` + await new Promise((resolve) => server!.listen(0, resolve)) + const port = (server.address() as any).port + const connectionString = `postgres://postgres:postgres@127.0.0.1:${port}/postgres` - const prevDbUrl = process.env.DATABASE_URL - process.env.DATABASE_URL = connectionString + process.env.DATABASE_URL = connectionString - await zg.generate({ - db: { - connectionString, - }, - schemas: Object.fromEntries( - schemas.map((s) => [s, { include: "*", exclude: [] }]), - ), - outDir: dbDir, - }) + await zg.generate({ + db: { + connectionString, + }, + schemas: Object.fromEntries( + schemas.map((s) => [s, { include: "*", exclude: [] }]), + ), + outDir: dbDir, + }) - await dumpTree({ - targetDir: path.join(dbDir, "structure"), - defaultDatabase: "postgres", - schemas, - }) + await dumpTree({ + targetDir: path.join(dbDir, "structure"), + defaultDatabase: "postgres", + schemas, + }) + } finally { + if (server?.listening) { + await new Promise((resolve, reject) => { + server!.close((err?: Error) => { + if (err) reject(err) + else resolve() + }) + }) + } + await (db as any).close?.() - server.close() - if (prevDbUrl === undefined) delete process.env.DATABASE_URL - else process.env.DATABASE_URL = prevDbUrl + if (prevDbUrl === undefined) delete process.env.DATABASE_URL + else process.env.DATABASE_URL = prevDbUrl + } return } diff --git a/tests/generate.pglite.test.ts b/tests/generate.pglite.test.ts index 56dcd53..23d6233 100644 --- a/tests/generate.pglite.test.ts +++ b/tests/generate.pglite.test.ts @@ -13,8 +13,9 @@ exports.down = async (pgm) => { } ` -test("generate with pglite runs migrations and dumps structure", async () => { +test("generate defaults to pglite and dumps structure without postgres", async () => { const tmp = fs.mkdtempSync(path.join(os.tmpdir(), "pgstrap-generate-")) + const prevDbUrl = process.env.DATABASE_URL const migrationsDir = path.join(tmp, "migrations") fs.mkdirSync(migrationsDir, { recursive: true }) fs.writeFileSync( @@ -27,7 +28,6 @@ test("generate with pglite runs migrations and dumps structure", async () => { defaultDatabase: "postgres", dbDir: path.join(tmp, "db"), migrationsDir, - pglite: true, }) const zapatosFile = path.join(tmp, "db", "zapatos", "schema.d.ts") @@ -42,6 +42,7 @@ test("generate with pglite runs migrations and dumps structure", async () => { expect(fs.existsSync(zapatosFile)).toBe(true) expect(fs.existsSync(path.join(structureDir, "table.sql"))).toBe(true) + expect(process.env.DATABASE_URL).toBe(prevDbUrl) fs.rmSync(tmp, { recursive: true, force: true }) })