brizzle 0.2.8 → 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 +40 -1
- package/dist/index.js +1360 -454
- 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,7 +200,25 @@ 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)
|
|
204
|
+
|
|
205
|
+
## Roadmap
|
|
206
|
+
|
|
207
|
+
- [x] **Drizzle init** - `brizzle init` to set up Drizzle ORM, database config, and db connection
|
|
208
|
+
- [ ] **Authentication** - `brizzle auth` to generate [better-auth](https://www.better-auth.com/) setup with user model and sign-in/sign-up pages
|
|
209
|
+
- [ ] **Zod schemas** - Generate validation schemas for forms and API routes
|
|
210
|
+
- [ ] **Indexes** - Support for `name:string:index` field modifier
|
|
211
|
+
- [ ] **Default values** - Support for `status:string:default:active`
|
|
212
|
+
- [ ] **Soft deletes** - Add `--soft-delete` flag for `deletedAt` timestamp
|
|
213
|
+
- [ ] **Pagination** - Add pagination to list pages and API routes
|
|
214
|
+
- [ ] **Search & filtering** - Generate search/filter UI for list pages
|
|
215
|
+
- [ ] **Seed generator** - `brizzle seed <model>` to generate seed data files
|
|
216
|
+
- [ ] **Relations helper** - Better syntax for has-many/belongs-to relationships
|
|
217
|
+
- [ ] **Custom templates** - Allow overriding templates via `.brizzle/` directory
|
|
218
|
+
- [ ] **Interactive mode** - `brizzle new` wizard for step-by-step model creation
|
|
219
|
+
- [ ] **Import cleanup** - Remove unused imports when destroying models
|
|
220
|
+
|
|
221
|
+
Have a feature request? [Open an issue](https://github.com/mantaskaveckas/brizzle/issues)
|
|
183
222
|
|
|
184
223
|
## License
|
|
185
224
|
|