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

[hyunbinseo]

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.

[sacrosanctic]

Are you saying the generated drizzle config is wrong? Or docs is wrong?

[hyunbinseo]

Documentation for the API is missing. These are the pages I've checked:

• https://svelte.dev/docs/cli/drizzle
• https://svelte.dev/docs/cli/sv#add

Since the type is not tightly checked - and is divergent from the CLI commands - documentation would be appreciated.

[sacrosanctic]

ok, this took me awhile to figure you. You mean, in the CLI and the docs is labelled as client
npx sv add drizzle="database:postgresql+client:postgres.js"

But in the imported API, its labelled as sqlite

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

I think this is a bug and we should fix that first, then adjust the docs accordingly.

[sacrosanctic]

Since the type is not tightly checked - and is divergent from the CLI commands - documentation would be appreciated.

Right now, its a bit laborious to keep the docs in sync with the CLI. A pipeline to convert the args into docs would be nice.

[hyunbinseo]

@sacrosanctic precisely that. Could you update the issue title or body accordingly?

[sacrosanctic]

Well, we can just fix this one in particular. That can be a separate issue.

[jycouet]

Hooo, I did comment this issue here yesterday... But I don't see my comment today :/ (I had bad internet)
I think that you are going in rong direction!

First:

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 version? You meant that you did:

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

And THIS is wrong? To put client in the API is not good. Correct?

---

Yes, client is a cmd & interactive way to configure the dialect of drizzle, it's a "group". To simplify things for users: https://svelte.dev/docs/cli/drizzle#Options-client I think that it's good to keep it.

The API doesn't have the group level, but speak directly with dialect. so there is not client level. Internaly, types are also easier like this. I would keep it like this too.

The problem is that official add-on don't export types when bundled https://github.com/sveltejs/cli/blob/fix/auth-cli-bin/packages/sv/src/addons/index.ts#L23 It would be great to fix this! I spent days on this already and didn't manage... (another point for #80 ). If you find a way, I'll be happy to see 👍

• I don't think that we should spend time in doc generation like this
• I don't think we should change the API
• exporting types of official add-on would be great. (like this it would be the doc)
• as a fallback, exporting types via JSDoc would be sufficient IMO

I mean, today api usage is very low, the impact on this is minimal IMO.
Feel free to tell me that I'm completely off

[hyunbinseo]

The docs: tag might have been a mistake.

npx sv add drizzle="database:postgresql+client:postgres.js" # inferring API from this

{
  drizzle: { database: "sqlite", client: "better-sqlite3" }, // I expected this to work
  drizzle: { database: "sqlite", sqlite: "better-sqlite3" }, // instead this was working
}

I didn't know about this deviation until I bumped into this issue.

The API doesn't have the group level, but speak directly with dialect.

• API: database+<dialect>
• CLI: database+client

That's all I wanted to say. I know that API usage is low, and things can be kept as-is.