Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ npm install pgstrap --save-dev
npm run db:migrate
```

6. Generate types and structure:
6. Generate types and structure from your migrations with an in-memory PGlite
database:
```bash
npm run db:generate
```
Expand All @@ -55,7 +56,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 running migrations against an in-memory PGlite instance.
- `npm run db:create-migration` - Create a new migration file

### Configuration
Expand Down
10 changes: 5 additions & 5 deletions src/init.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import type { Context } from "./get-project-context"
import path from "path"
import * as fs from "fs"
import pgstrapPackage from "../package.json"
import kyselyTypesTemplate from "./templates/kysely-types.template"
import path from "path"
import { mkdirpSync } from "mkdirp"
import pgstrapPackage from "../package.json"
import type { Context } from "./get-project-context"
import getDbClientTemplate from "./templates/get-db-client.template"
import kyselyTypesTemplate from "./templates/kysely-types.template"

export const initPgstrap = async (ctx: Pick<Context, "cwd">) => {
const { cwd } = ctx
Expand All @@ -16,7 +16,7 @@ export const initPgstrap = async (ctx: Pick<Context, "cwd">) => {

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 = {}
Expand Down
4 changes: 2 additions & 2 deletions tests/init.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { beforeEach, afterEach, test, expect } from "bun:test"
import { afterEach, beforeEach, expect, test } from "bun:test"
import fs from "fs"
import os from "os"
import path from "path"
Expand All @@ -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")
})