refactor!: rename node-sqlite3 to sqlite3

reduce auto complete confusion with native `node-sqlite`
unjs · Feb 26, 2025 · eb8c06d · eb8c06d
1 parent 4da62b4
commit eb8c06d
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 12 deletions.
diff --git a/docs/2.connectors/sqlite.md b/docs/2.connectors/sqlite.md
@@ -10,7 +10,7 @@ You have 3 options for using SQLite:
 
 - [`node-sqlite`](#node-sqlite) (recommended)
 - [`better-sqlite3`](#better-sqlite3)
-- [`sqlite3`](#node-sqlite3)
+- [`sqlite3`](#sqlite3)
 
 ## `node-sqlite`
 
@@ -69,19 +69,19 @@ Database (file) name. Default is `db`.
 
 Related (to `cwd`) or absolute path to the sql file. By default it is stored in `{cwd}/.data/{name}.sqlite3` / `.data/db.sqlite3`
 
-## `node-sqlite3`
+## `sqlite3`
 
-:read-more{to="https://github.com/TryGhost/node-sqlite3" title="node-sqlite3"}
+:read-more{to="https://github.com/TryGhost/sqlite3" title="sqlite3"}
 
 For this connector, you need to install [`sqlite3`](https://www.npmjs.com/package/sqlite3) dependency:
 
 :pm-install{name="sqlite3"}
 
-Use `node-sqlite3` connector:
+Use `sqlite3` connector:
 
 ```js
 import { createDatabase } from "db0";
-import sqlite from "db0/connectors/node-sqlite3";
+import sqlite from "db0/connectors/sqlite3";
 
 const db = createDatabase(
   sqlite({

diff --git a/src/_connectors.ts b/src/_connectors.ts
@@ -9,12 +9,12 @@ import type { ConnectorOptions as LibSQLNodeOptions } from "db0/connectors/libsq
 import type { ConnectorOptions as LibSQLWebOptions } from "db0/connectors/libsql/web";
 import type { ConnectorOptions as MySQL2Options } from "db0/connectors/mysql2";
 import type { ConnectorOptions as NodeSQLiteOptions } from "db0/connectors/node-sqlite";
-import type { ConnectorOptions as NodeSQLite3Options } from "db0/connectors/node-sqlite3";
 import type { ConnectorOptions as PgliteOptions } from "db0/connectors/pglite";
 import type { ConnectorOptions as PlanetscaleOptions } from "db0/connectors/planetscale";
 import type { ConnectorOptions as PostgreSQLOptions } from "db0/connectors/postgresql";
+import type { ConnectorOptions as SQLite3Options } from "db0/connectors/sqlite3";
 
-export type ConnectorName = "better-sqlite3" | "sqlite" | "bun-sqlite" | "bun" | "cloudflare-d1" | "libsql-core" | "libsql-http" | "libsql-node" | "libsql" | "libsql-web" | "mysql2" | "node-sqlite" | "node-sqlite3" | "pglite" | "planetscale" | "postgresql";
+export type ConnectorName = "better-sqlite3" | "sqlite" | "bun-sqlite" | "bun" | "cloudflare-d1" | "libsql-core" | "libsql-http" | "libsql-node" | "libsql" | "libsql-web" | "mysql2" | "node-sqlite" | "pglite" | "planetscale" | "postgresql" | "sqlite3";
 
 export type ConnectorOptions = {
   "better-sqlite3": BetterSQLite3Options;
@@ -32,10 +32,10 @@ export type ConnectorOptions = {
   "libsql-web": LibSQLWebOptions;
   "mysql2": MySQL2Options;
   "node-sqlite": NodeSQLiteOptions;
-  "node-sqlite3": NodeSQLite3Options;
   "pglite": PgliteOptions;
   "planetscale": PlanetscaleOptions;
   "postgresql": PostgreSQLOptions;
+  "sqlite3": SQLite3Options;
 };
 
 export const connectors = Object.freeze({
@@ -54,8 +54,8 @@ export const connectors = Object.freeze({
   "libsql-web": "db0/connectors/libsql/web",
   "mysql2": "db0/connectors/mysql2",
   "node-sqlite": "db0/connectors/node-sqlite",
-  "node-sqlite3": "db0/connectors/node-sqlite3",
   "pglite": "db0/connectors/pglite",
   "planetscale": "db0/connectors/planetscale",
   "postgresql": "db0/connectors/postgresql",
+  "sqlite3": "db0/connectors/sqlite3",
 } as const);
diff --git a/src/connectors/node-sqlite3.ts → src/connectors/sqlite3.ts b/src/connectors/node-sqlite3.ts → src/connectors/sqlite3.ts
@@ -40,7 +40,7 @@ export default function nodeSqlite3Connector(opts: ConnectorOptions): Connector<
   })
 
   return {
-    name: 'node-sqlite3',
+    name: 'sqlite3',
     dialect: 'sqlite',
     getInstance: () => getDB(),
     exec: (sql: string) => query(sql),

diff --git a/test/connectors/node-sqlite3.test.ts → test/connectors/sqlite3.test.ts b/test/connectors/node-sqlite3.test.ts → test/connectors/sqlite3.test.ts
@@ -1,8 +1,8 @@
 import { describe } from "vitest";
-import connector from "../../src/connectors/node-sqlite3";
+import connector from "../../src/connectors/sqlite3";
 import { testConnector } from "./_tests";
 
-describe("connectors: node-sqlite3", () => {
+describe("connectors: sqlite3", () => {
   testConnector({
     dialect: "sqlite",
     connector: connector({