chore(workspace): upgrade deps and improve docs

Author: subframe7536

.vscode/settings.json

@@ -6,8 +6,8 @@
   "editor.formatOnSave": false,
   // Auto fix
   "editor.codeActionsOnSave": {
-    "source.fixAll": true,
-    "source.organizeImports": false
+    "source.fixAll": "explicit",
+    "source.organizeImports": "never"
   },
   // Enable eslint for all supported languages
   "eslint.validate": [

package.json

@@ -3,7 +3,7 @@
   "type": "module",
   "version": "0.5.3",
   "private": true,
-  "packageManager": "pnpm@8.10.4",
+  "packageManager": "pnpm@8.12.0",
   "description": "",
   "author": {
     "name": "subframe7536",
@@ -30,32 +30,37 @@
     "commit": "czg"
   },
   "devDependencies": {
-    "@commitlint/cli": "^18.4.1",
-    "@commitlint/config-conventional": "^18.4.0",
+    "@commitlint/cli": "^18.4.3",
+    "@commitlint/config-conventional": "^18.4.3",
     "@sqlite.org/sqlite-wasm": "3.43.2-prebuild1",
-    "@subframe7536/eslint-config": "^0.4.2",
-    "@types/better-sqlite3": "^7.6.7",
-    "@types/node": "^20.9.0",
+    "@subframe7536/eslint-config": "^0.5.5",
+    "@types/better-sqlite3": "^7.6.8",
+    "@types/node": "^20.10.4",
     "@types/sql.js": "^1.4.9",
     "@vlcn.io/crsqlite-wasm": "^0.15.2",
-    "better-sqlite3": "^9.1.1",
-    "bumpp": "^9.2.0",
-    "cz-git": "^1.7.1",
-    "czg": "^1.7.1",
-    "eslint": "^8.53.0",
+    "better-sqlite3": "^9.2.2",
+    "bumpp": "^9.2.1",
+    "cz-git": "^1.8.0",
+    "czg": "^1.8.0",
+    "eslint": "^8.55.0",
     "husky": "^8.0.3",
     "kysely": "^0.26.3",
-    "lint-staged": "^15.1.0",
-    "node-sqlite3-wasm": "^0.8.1",
-    "sql.js": "^1.8.0",
-    "tsup": "^7.2.0",
-    "typescript": "^5.2.2",
-    "vite": "4.5.0",
-    "vitest": "^0.34.6"
+    "lint-staged": "^15.2.0",
+    "node-sqlite3-wasm": "^0.8.4",
+    "sql.js": "^1.9.0",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3",
+    "vite": "^5.0.8",
+    "vitest": "^1.0.4"
+  },
+  "pnpm": {
+    "overrides": {
+      "has": "npm:@nolyfill/has@latest"
+    }
   },
   "lint-staged": {
     "*": [
-      "eslint --cache --fix"
+      "eslint . --fix"
     ]
   },
   "config": {

packages/dialect-bun-worker/README.md

@@ -2,13 +2,13 @@
 
 [kysely](https://github.com/kysely-org/kysely) dialect for `bun:sqlite`, run sql in worker
 
-## install
+## Install
 
 ```shell
 bun install kysely kysely-bun-worker
 ```
 
-## config
+## Config
 
 ```ts
 export type BunWorkerDialectConfig = {
@@ -29,4 +29,4 @@ export type BunWorkerDialectConfig = {
    */
   worker?: Worker
 }
-```
+```

packages/dialect-bun-worker/src/driver.ts

@@ -115,7 +115,7 @@ class BunWorkerConnection implements DatabaseConnection {
   }
 
   streamQuery<R>(): AsyncIterableIterator<QueryResult<R>> {
-    throw new Error('SQLite driver doesn\'t support streaming')
+    throw new Error('Bun:sqlite-worker driver doesn\'t support streaming')
   }
 
   async executeQuery<R>(compiledQuery: CompiledQuery<unknown>): Promise<QueryResult<R>> {

packages/dialect-sqlite-worker/README.md

@@ -1,16 +1,16 @@
-# worker dialect
+# kysely-sqlite-worker
 
 [kysely](https://github.com/kysely-org/kysely) dialect for better-sqlite, execute sql in `node:worker_threads`
 
 the type is also availiable for [`better-sqlite3-multiple-ciphers`](https://github.com/m4heshd/better-sqlite3-multiple-ciphers)
 
-## install
+## Install
 
 ```shell
 pnpm add kysely kysely-sqlite-worker better-sqlite3
 ```
 
-## config
+## Config
 
 ```ts
 export type SqliteWorkerDialectConfig = {

packages/dialect-sqlite-worker/src/driver.ts

@@ -103,8 +103,8 @@ export class SqliteWorkerConnection implements DatabaseConnection {
     this.emit = emit
   }
 
-  streamQuery<R>(): AsyncIterableIterator<QueryResult<R>> {
-    throw new Error('SQLite driver doesn\'t support streaming')
+  async *streamQuery<R>(): AsyncIterableIterator<QueryResult<R>> {
+    throw new Error('sqlite-worker driver doesn\'t support streaming')
   }
 
   async executeQuery<R>(compiledQuery: CompiledQuery<unknown>): Promise<QueryResult<R>> {

packages/dialect-tauri/README.md

@@ -1,14 +1,14 @@
-# Tauri dialect
+# kysely-dialect-tauri
 
 [kysely](https://github.com/kysely-org/kysely) dialect for [`Tauri`](https://tauri.app/), using [official sql plugin](https://github.com/tauri-apps/plugins-workspace/tree/dev/plugins/sql), support MySQL, PostgreSQL and SQLite
 
-## install
+## Install
 
 ```shell
 pnpm add kysely kysely-dialect-tauri @tauri-apps/plugin-sql
 ```
 
-## usage
+## Usage
 
 ```ts
 import { Kysely } from 'kysely'
@@ -23,12 +23,12 @@ const kysely = new Kysely<DB>({
 })
 ```
 
-## config
+## Config
 
 ```ts
 export interface TauriSqlDialectConfig<T extends 'sqlite' | 'mysql' | 'postgres'> {
   database: Promisable<TauriSqlDB> | ((prefix: T extends 'sqlite' ? `${T}:` : `${T}://`) => Promisable<TauriSqlDB>)
   type: T
   onCreateConnection?: (connection: DatabaseConnection) => Promisable<void>
 }
-```
+```

packages/dialect-wasm/README.md

@@ -1,16 +1,16 @@
-# wasm dialect
+# kysely-wasm
 
 [kysely](https://github.com/kysely-org/kysely) dialect for various SQLite wasm
 
 no wasm denpendencies, your need to install yourself
 
-## install
+## Install
 
 ```shell
 pnpm add -D kysely kysely-wasm
 ```
 
-## introduce
+## Introduce
 
 there are 6 dialects
 
@@ -47,17 +47,15 @@ you can choose to use `native file system` as backend storage, which is no need
 
 you can choose to use `IndexedDB` as backend storage
 
-### type
+### Type
 
 see in jsdoc
 
-### usage and more details
+### Usage and more details
 
 see [test](../../test/dialect-wasm.test.ts) and [playground](../../playground/src/modules)
 
-
 ## TODO
 
 - [ ] add type and use [worker client](https://github.com/tomayac/sqlite-wasm#usage-with-the-bundled-sqliteclient-with-opfs-if-available) for `OfficialWasmDialect`
 - [ ] seem to have nodejs support for official wasm: https://github.com/tomayac/sqlite-wasm/blob/main/sqlite-wasm/jswasm/sqlite3-node.mjs
-- [ ] add indexeddb support for official wasm, [example](https://sqlite.org/src/file/ext/wasm/api/sqlite3-vfs-opfs.js)

packages/dialect-wasm/src/baseDriver.ts

@@ -67,7 +67,7 @@ export abstract class BaseSqliteConnection implements DatabaseConnection {
   abstract query(sql: string, params?: any[]): QueryReturn
   abstract info(): InfoReturn
   streamQuery<R>(): AsyncIterableIterator<QueryResult<R>> {
-    throw new Error('SQLite driver doesn\'t support streaming')
+    throw new Error('sqlite-wasm driver doesn\'t support streaming')
   }
 
   async executeQuery<R>({ parameters, query, sql }: CompiledQuery<unknown>): Promise<QueryResult<R>> {

packages/dialect-wasm/src/wasqlite-dialect/type.ts

@@ -8,7 +8,7 @@ export interface Sqlite {
   str_new: (db: number, sql: string) => number
   str_value: (str: number) => number
   str_finish: (str: number) => void
-  prepare_v2: (db: number, sql: number) => Promise<{ stmt: number; sql: number } | null>
+  prepare_v2: (db: number, sql: number) => Promise<{ stmt: number, sql: number } | null>
   step: (stmt: number) => Promise<number>
   finalize: (stmt: number) => Promise<number>
   column_names: (stmt: number) => string[]