sveltejs / sveltejs/cli

docs: `sv.add` Drizzle ORM options for `client`

Open
#1,217 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

pkg:add
Dominant language
TypeScript
Stars
506
Forks
107
Avg merge
5d 15h
Merged PRs (30d)
28

Description

Turns out this is wrong:

await sv.add({
  cwd,
  addons: {
    drizzle: sv.officialAddons.drizzle,
  },
  options: {
    drizzle: { database: "sqlite", sqlite: "client-sqlite3" },
  },
  packageManager: "pnpm",
});

This is the fix:

- drizzle: { database: "sqlite", client: "better-sqlite3" },
+ drizzle: { database: "sqlite", sqlite: "better-sqlite3" },

I've been using a client key to match the CLI script:

npx sv add drizzle="database:postgresql+client:postgres.js"

I did name this as a docs issue, but would prefer the API to match CLI.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the sv.add options example and the sv add drizzle=... CLI syntax shown in the issue. Confirm whether the documented key or API should change, then update the relevant documentation or API behavior so the SQLite client option uses one consistent name and verify the examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
sqlite, typescript
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.