brizzle 0.2.9 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -2
- package/dist/index.js +1340 -434
- package/package.json +18 -1
package/README.md
CHANGED
|
@@ -30,6 +30,9 @@ npx brizzle scaffold post title:string body:text
|
|
|
30
30
|
## Quick Start
|
|
31
31
|
|
|
32
32
|
```bash
|
|
33
|
+
# Initialize Drizzle ORM in your project
|
|
34
|
+
npx brizzle init
|
|
35
|
+
|
|
33
36
|
# Generate a full CRUD scaffold (model + actions + pages)
|
|
34
37
|
brizzle scaffold post title:string body:text published:boolean
|
|
35
38
|
|
|
@@ -48,6 +51,24 @@ brizzle actions post
|
|
|
48
51
|
|
|
49
52
|
## Commands
|
|
50
53
|
|
|
54
|
+
### `brizzle init`
|
|
55
|
+
|
|
56
|
+
Interactive setup wizard for Drizzle ORM. Configures your database connection and generates all necessary files.
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
brizzle init
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Supports:
|
|
63
|
+
- **SQLite**: better-sqlite3, libsql (Turso), bun:sqlite
|
|
64
|
+
- **PostgreSQL**: postgres.js, pg, neon, vercel-postgres
|
|
65
|
+
- **MySQL**: mysql2, planetscale
|
|
66
|
+
|
|
67
|
+
Options:
|
|
68
|
+
- `--dialect <dialect>` - Database dialect for non-interactive mode
|
|
69
|
+
- `--driver <driver>` - Database driver for non-interactive mode
|
|
70
|
+
- `--no-install` - Skip automatic dependency installation
|
|
71
|
+
|
|
51
72
|
### `brizzle model <name> [fields...]`
|
|
52
73
|
|
|
53
74
|
Creates a Drizzle schema model in `db/schema.ts`.
|
|
@@ -179,11 +200,11 @@ Next steps:
|
|
|
179
200
|
|
|
180
201
|
- Node.js >= 18
|
|
181
202
|
- Next.js project with App Router
|
|
182
|
-
- Drizzle ORM configured
|
|
203
|
+
- Drizzle ORM configured (or run `brizzle init` to set it up)
|
|
183
204
|
|
|
184
205
|
## Roadmap
|
|
185
206
|
|
|
186
|
-
- [
|
|
207
|
+
- [x] **Drizzle init** - `brizzle init` to set up Drizzle ORM, database config, and db connection
|
|
187
208
|
- [ ] **Authentication** - `brizzle auth` to generate [better-auth](https://www.better-auth.com/) setup with user model and sign-in/sign-up pages
|
|
188
209
|
- [ ] **Zod schemas** - Generate validation schemas for forms and API routes
|
|
189
210
|
- [ ] **Indexes** - Support for `name:string:index` field modifier
|