From 38fe770a25df5553465b35d09c9ca123976c4b55 Mon Sep 17 00:00:00 2001 From: bingmokaka Date: Wed, 1 Jul 2026 12:30:55 +0800 Subject: [PATCH] Use pglite for generated db types by default --- README.md | 2 +- bun.lock | 3 +++ package.json | 2 ++ src/init.ts | 2 +- tests/init.test.ts | 2 +- 5 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 20e3127..cd5a4a0 100644 --- a/README.md +++ b/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 against an in-memory PGlite instance, so local Postgres is not required. Use `pgstrap generate` directly to generate from a running Postgres database instead. - `npm run db:create-migration` - Create a new migration file ### Configuration diff --git a/bun.lock b/bun.lock index 83407d9..8f476d8 100644 --- a/bun.lock +++ b/bun.lock @@ -1,10 +1,12 @@ { "lockfileVersion": 1, + "configVersion": 0, "workspaces": { "": { "name": "pgstrap", "dependencies": { "@electric-sql/pglite": "^0.3.3", + "debug": "^4.3.4", "pg-gateway": "^0.3.0-beta.4", "pg-schema-dump": "^2.0.2", "yargs": "^17.7.2", @@ -22,6 +24,7 @@ "pg": "^8.11.1", "pg-connection-from-env": "^1.1.0", "tsup": "^7.1.0", + "typescript": "^5.1.6", "zapatos": "^6.1.4", }, "peerDependencies": { diff --git a/package.json b/package.json index 18721c9..b84618d 100644 --- a/package.json +++ b/package.json @@ -23,6 +23,7 @@ "license": "MIT", "dependencies": { "@electric-sql/pglite": "^0.3.3", + "debug": "^4.3.4", "pg-gateway": "^0.3.0-beta.4", "pg-schema-dump": "^2.0.2", "yargs": "^17.7.2" @@ -47,6 +48,7 @@ "pg": "^8.11.1", "pg-connection-from-env": "^1.1.0", "tsup": "^7.1.0", + "typescript": "^5.1.6", "zapatos": "^6.1.4" } } diff --git a/src/init.ts b/src/init.ts index b84f9cd..e396f28 100644 --- a/src/init.ts +++ b/src/init.ts @@ -16,7 +16,7 @@ export const initPgstrap = async (ctx: Pick) => { pkg.scripts["db:migrate"] = "pgstrap migrate" pkg.scripts["db:reset"] = "pgstrap reset" - pkg.scripts["db:generate"] = "pgstrap generate" + pkg.scripts["db:generate"] = "pgstrap generate --pglite" pkg.scripts["db:create-migration"] = "pgstrap create-migration" if (!pkg.devDependencies) pkg.devDependencies = {} diff --git a/tests/init.test.ts b/tests/init.test.ts index cd4ec4b..aabc7f7 100644 --- a/tests/init.test.ts +++ b/tests/init.test.ts @@ -25,6 +25,6 @@ test("initPgstrap writes scripts to package.json", async () => { ) expect(pkg.scripts["db:migrate"]).toBe("pgstrap migrate") expect(pkg.scripts["db:reset"]).toBe("pgstrap reset") - expect(pkg.scripts["db:generate"]).toBe("pgstrap generate") + expect(pkg.scripts["db:generate"]).toBe("pgstrap generate --pglite") expect(pkg.scripts["db:create-migration"]).toBe("pgstrap create-migration") })