chore: qa

Author: subframe7536

README.md

@@ -15,11 +15,10 @@ import { initSQLite, isOpfsSupported, useMemoryStorage } from '@subframe7536/sql
 
 // optional url
 const url = 'https://cdn.jsdelivr.net/npm/@subframe7536/sqlite-wasm@0.5.0/wa-sqlite.wasm'
-const url1 = 'https://cdn.jsdelivr.net/gh/subframe7536/sqlite-wasm@v0.5.0/wa-sqlite-fts5/wa-sqlite.wasm'
+const url1 =
+  'https://cdn.jsdelivr.net/gh/subframe7536/sqlite-wasm@v0.5.0/wa-sqlite-fts5/wa-sqlite.wasm'
 
-const { run, changes, lastInsertRowId, close } = await initSQLite(
-  useMemoryStorage({ url })
-)
+const { run, changes, lastInsertRowId, close } = await initSQLite(useMemoryStorage({ url }))
 ```
 
 ### IndexedDB
@@ -34,11 +33,10 @@ import { useIdbStorage } from '@subframe7536/sqlite-wasm/idb'
 
 // optional url
 const url = 'https://cdn.jsdelivr.net/npm/@subframe7536/sqlite-wasm@0.5.0/wa-sqlite-async.wasm'
-const url1 = 'https://cdn.jsdelivr.net/gh/subframe7536/sqlite-wasm@v0.5.0/wa-sqlite-fts5/wa-sqlite-async.wasm'
+const url1 =
+  'https://cdn.jsdelivr.net/gh/subframe7536/sqlite-wasm@v0.5.0/wa-sqlite-fts5/wa-sqlite-async.wasm'
 
-const { run, changes, lastInsertRowId, close } = await initSQLite(
-  useIdbStorage('test.db', { url })
-)
+const { run, changes, lastInsertRowId, close } = await initSQLite(useIdbStorage('test.db', { url }))
 ```
 
 #### IdbMemory
@@ -55,7 +53,7 @@ import { useIdbMemoryStorage } from '@subframe7536/sqlite-wasm/idb-memory'
 const url = 'https://cdn.jsdelivr.net/npm/@subframe7536/sqlite-wasm@0.5.0/dist/wa-sqlite-async.wasm'
 
 const { run, changes, lastInsertRowId, close } = await initSQLite(
-  useIdbMemoryStorage('test.db', { url })
+  useIdbMemoryStorage('test.db', { url }),
 )
 ```
 
@@ -76,12 +74,11 @@ import { useOpfsStorage } from '@subframe7536/sqlite-wasm/opfs'
 const url = 'https://cdn.jsdelivr.net/npm/@subframe7536/sqlite-wasm@0.5.0/dist/wa-sqlite.wasm'
 
 onmessage = async () => {
-  if (!await isOpfsSupported()) { // this can be called in main thread
+  if (!(await isOpfsSupported())) {
+    // this can be called in main thread
     return
   }
-  const { run, changes, lastInsertRowId, close } = await initSQLite(
-    useOpfsStorage('test.db', url)
-  )
+  const { run, changes, lastInsertRowId, close } = await initSQLite(useOpfsStorage('test.db', url))
 }
 ```
 
@@ -92,6 +89,7 @@ Store data through `FileSystemFileHandle`, use modified `OPFSAnyContextVFS` with
 [minimal File System Access backend browser version](https://caniuse.com/mdn-api_filesystemhandle)
 
 > [!warning]
+>
 > 1. maybe have perfarmance issue on Windows with device's local file, see in [#5](https://github.com/subframe7536/sqlite-wasm/pull/5)
 > 2. Safari is not supported, see in [caniuse](https://caniuse.com/mdn-api_filesystemwritablefilestream)
 
@@ -108,7 +106,7 @@ const root = await window.showDirectoryPicker()
 const root1 = await navigator.storage.getDirectory()
 
 const { run, changes, lastInsertRowId, close } = await initSQLite(
-  useFsHandleStorage('test.db', root, url)
+  useFsHandleStorage('test.db', root, url),
 )
 ```
 
@@ -141,9 +139,7 @@ async function selectFile(): Promise<File> {
     input.click()
   })
 }
-const FileOrReadableStream = remote
-  ? (await fetch(remoteSqliteURL)).body!
-  : await selectFile()
+const FileOrReadableStream = remote ? (await fetch(remoteSqliteURL)).body! : await selectFile()
 ```
 
 Import while initiaizing
@@ -152,9 +148,7 @@ Import while initiaizing
 import { initSQLite, withExistDB } from '@subframe7536/sqlite-wasm'
 import { useIdbStorage } from '@subframe7536/sqlite-wasm/idb'
 
-const db = initSQLite(
-  useIdbStorage('test.db', withExistDB(FileOrReadableStream, { url }))
-)
+const db = initSQLite(useIdbStorage('test.db', withExistDB(FileOrReadableStream, { url })))
 ```
 
 or load it later
@@ -196,9 +190,7 @@ import { customFunction, initSQLite, isOpfsSupported } from '@subframe7536/sqlit
 import { useOpfsStorage } from '@subframe7536/sqlite-wasm/opfs'
 import { uuidv7 } from 'uuidv7'
 
-const { run, sqlite, db } = await initSQLite(
-  useOpfsStorage('test')
-)
+const { run, sqlite, db } = await initSQLite(useOpfsStorage('test'))
 customFunction(sqlite, db, 'uuidv7', () => uuidv7())
 console.log(await run('select uuidv7() as a'))
 // [{ "a": "01932f1b-b663-7714-af4d-17a3d9efc7b3" }]
@@ -225,7 +217,7 @@ for await (const row of iterator(core, 'select * from test')) {
   console.log(row)
 }
 
-customFunctionCore(core, 'test', num => num)
+customFunctionCore(core, 'test', (num) => num)
 await run(core, 'select test(?)', [1])
 
 const buf = await exportDatabase(core.vfs, core.path)
@@ -235,8 +227,12 @@ await close(core)
 
 ### Utils
 
-```ts
-function dumpVFS(vfs: FacadeVFS, path: string, onDone?: (vfs: FacadeVFS, path: string) => any): ReadableStream
+````ts
+function dumpVFS(
+  vfs: FacadeVFS,
+  path: string,
+  onDone?: (vfs: FacadeVFS, path: string) => any,
+): ReadableStream
 
 function exportDatabaseFromIDB(vfs: FacadeVFS, path: string): Promise<Uint8Array>
 
@@ -249,15 +245,23 @@ function exportDatabaseFromFsHandle(vfs: FacadeVFS, path: string): Promise<Uint8
  */
 function exportDatabase(vfs: FacadeVFS, path: string): Promise<Uint8Array>
 
-function importDatabaseToIdb(vfs: FacadeVFS, path: string, stream: ReadableStream<Uint8Array>): Promise<void>
+function importDatabaseToIdb(
+  vfs: FacadeVFS,
+  path: string,
+  stream: ReadableStream<Uint8Array>,
+): Promise<void>
 
 /**
  * Import database from `File` or `ReadableStream`
  * @param vfs SQLite VFS
  * @param path db path
  * @param data existing database
  */
-function importDatabase(vfs: FacadeVFS, path: string, data: File | ReadableStream<Uint8Array>): Promise<void>
+function importDatabase(
+  vfs: FacadeVFS,
+  path: string,
+  data: File | ReadableStream<Uint8Array>,
+): Promise<void>
 
 /**
  * check if IndexedDB and Web Locks API supported
@@ -293,17 +297,28 @@ function isModuleWorkerSupport(): boolean
  * // [{ "a": "01932f1b-b663-7714-af4d-17a3d9efc7b3" }]
  * ```
  */
-function customFunction<N extends string, T extends SQLiteCompatibleType[]>(sqlite: SQLiteAPI, db: number, fnName: N, fn: N extends '' ? never : (...args: T) => (SQLiteCompatibleType | number[]) | null, options?: {
-  deterministic?: boolean
-  directOnly?: boolean
-  varargs?: boolean
-}): void
-
-function customFunctionCore<N extends string, T extends SQLiteCompatibleType[]>(core: SQLiteDBCore, fnName: N, fn: N extends '' ? never : (...args: T) => (SQLiteCompatibleType | number[]) | null, options?: {
-  deterministic?: boolean
-  directOnly?: boolean
-  varargs?: boolean
-}): void
+function customFunction<N extends string, T extends SQLiteCompatibleType[]>(
+  sqlite: SQLiteAPI,
+  db: number,
+  fnName: N,
+  fn: N extends '' ? never : (...args: T) => (SQLiteCompatibleType | number[]) | null,
+  options?: {
+    deterministic?: boolean
+    directOnly?: boolean
+    varargs?: boolean
+  },
+): void
+
+function customFunctionCore<N extends string, T extends SQLiteCompatibleType[]>(
+  core: SQLiteDBCore,
+  fnName: N,
+  fn: N extends '' ? never : (...args: T) => (SQLiteCompatibleType | number[]) | null,
+  options?: {
+    deterministic?: boolean
+    directOnly?: boolean
+    varargs?: boolean
+  },
+): void
 
 /**
  * Parse options with existing database
@@ -319,24 +334,41 @@ function customFunctionCore<N extends string, T extends SQLiteCompatibleType[]>(
  * )
  * ```
  */
-function withExistDB<T extends BaseStorageOptions>(data: File | ReadableStream, options?: Omit<T, 'beforeOpen'>): T
+function withExistDB<T extends BaseStorageOptions>(
+  data: File | ReadableStream,
+  options?: Omit<T, 'beforeOpen'>,
+): T
 
 function close(core: SQLiteDBCore): Promise<void>
 
 function changes(core: SQLiteDBCore): number | bigint
 
 function lastInsertRowId(core: SQLiteDBCore): number | bigint
 
-function stream(core: SQLiteDBCore, onData: (data: Record<string, SQLiteCompatibleType>) => void, sql: string, parameters?: SQLiteCompatibleType[]): Promise<void>
-
-function run(core: SQLiteDBCore, sql: string, parameters?: SQLiteCompatibleType[]): Promise<Array<Record<string, SQLiteCompatibleType>>>
-
-function iterator(core: SQLiteDBCore, sql: string, parameters?: SQLiteCompatibleType[], chunkSize?: number): AsyncIterableIterator<Record<string, SQLiteCompatibleType>[]>
+function stream(
+  core: SQLiteDBCore,
+  onData: (data: Record<string, SQLiteCompatibleType>) => void,
+  sql: string,
+  parameters?: SQLiteCompatibleType[],
+): Promise<void>
+
+function run(
+  core: SQLiteDBCore,
+  sql: string,
+  parameters?: SQLiteCompatibleType[],
+): Promise<Array<Record<string, SQLiteCompatibleType>>>
+
+function iterator(
+  core: SQLiteDBCore,
+  sql: string,
+  parameters?: SQLiteCompatibleType[],
+  chunkSize?: number,
+): AsyncIterableIterator<Record<string, SQLiteCompatibleType>[]>
 
 function parseOpenV2Flag(readonly?: boolean): number
 
 function reopen(core: SQLiteDBCore, readonly?: boolean): Promise<void>
-```
+````
 
 ## License
 

oxfmt.config.ts

@@ -1,3 +1,5 @@
 import { subfFmt } from '@subf/config/oxfmt'
 
-export default subfFmt()
+export default subfFmt({
+  ignorePatterns: ['wa-sqlite-fts5', 'wa-sqlite', 'src/vfs/class/OPFSAnyContextVFS.js'],
+})

oxlint.config.ts

@@ -1,10 +1,7 @@
 import { subfLint } from '@subf/config/oxlint'
 
 export default subfLint({
-  ignorePatterns: [
-    'wa-sqlite-fts5',
-    'wa-sqlite',
-  ],
+  ignorePatterns: ['wa-sqlite-fts5', 'wa-sqlite', 'src/vfs/class/OPFSAnyContextVFS.js'],
   rules: {
     'no-constant-condition': 'off',
     'no-unused-vars': 'off',

package.json

@@ -38,7 +38,8 @@
     "dev": "vite serve playground",
     "build": "tsdown",
     "update": "bun run download.ts",
-    "release": "bun run typecheck && bun run lint && bun run format && bun run build && bumpp --all"
+    "qa": "bun run typecheck && bun run lint && bun run format",
+    "release": "bun run qa && bun run build && bumpp --all"
   },
   "devDependencies": {
     "@subf/config": "^0.2.1",

playground/src/index.ts

@@ -1,7 +1,6 @@
-import type { SQLiteDB } from '../../src/index'
-
 import { mitt } from 'zen-mitt'
 
+import type { SQLiteDB } from '../../src/index'
 import {
   initSQLite,
   isIdbSupported,
@@ -13,6 +12,7 @@ import { useIdbStorage } from '../../src/vfs/idb'
 import { useIdbMemoryStorage } from '../../src/vfs/idb-memory'
 import url from '../../wa-sqlite-fts5/wa-sqlite-async.wasm?url'
 import syncUrl from '../../wa-sqlite-fts5/wa-sqlite.wasm?url'
+
 import { runSQL } from './runSQL'
 import OpfsWorker from './worker?worker'
 
@@ -59,7 +59,9 @@ document.querySelector('.import')?.addEventListener('click', async () => {
   )
   await db.sync(file)
   console.log(
-    await db.run(`SELECT "type", "tbl_name" AS "table", CASE WHEN "sql" LIKE '%PRIMARY KEY AUTOINCREMENT%' THEN 1 ELSE "name" END AS "name" FROM "sqlite_master"`),
+    await db.run(
+      `SELECT "type", "tbl_name" AS "table", CASE WHEN "sql" LIKE '%PRIMARY KEY AUTOINCREMENT%' THEN 1 ELSE "name" END AS "name" FROM "sqlite_master"`,
+    ),
   )
 })
 
@@ -203,14 +205,18 @@ async function selectFile(accept?: string): Promise<File> {
       input.remove()
     }
 
-    window.addEventListener('focus', () => {
-      setTimeout(() => {
-        if (!input.files?.length) {
-          reject(new Error('File selection cancelled'))
-          input.remove()
-        }
-      }, 300)
-    }, { once: true })
+    window.addEventListener(
+      'focus',
+      () => {
+        setTimeout(() => {
+          if (!input.files?.length) {
+            reject(new Error('File selection cancelled'))
+            input.remove()
+          }
+        }, 300)
+      },
+      { once: true },
+    )
 
     input.click()
   })

playground/src/runSQL.ts

@@ -1,12 +1,13 @@
 import type { SQLiteDBCore } from '../../src'
-
 import { iterator } from '../../src'
 
-export async function runSQL(run: (sql: string, parameters?: any[]) => Promise<any>): Promise<void> {
+export async function runSQL(
+  run: (sql: string, parameters?: any[]) => Promise<any>,
+): Promise<void> {
   await run('CREATE TABLE if not exists t1(a INTEGER, b INTEGER, c VARCHAR);')
-  await run('INSERT INTO t1 VALUES(1, 19147, \'nineteen thousand one hundred forty-seven\');')
-  await run('INSERT INTO t1 VALUES(2, 26008, \'twenty-six thousand eight\');')
-  await run('INSERT INTO t1 VALUES(3, 46582, \'forty-six thousand five hundred eighty-two\');')
+  await run("INSERT INTO t1 VALUES(1, 19147, 'nineteen thousand one hundred forty-seven');")
+  await run("INSERT INTO t1 VALUES(2, 26008, 'twenty-six thousand eight');")
+  await run("INSERT INTO t1 VALUES(3, 46582, 'forty-six thousand five hundred eighty-two');")
   console.log(await run('select * from t1'))
 }
 export async function runSQLStream(
@@ -15,16 +16,15 @@ export async function runSQLStream(
   onData: (data: any) => void,
 ): Promise<void> {
   await run('CREATE TABLE if not exists t1(a INTEGER, b INTEGER, c VARCHAR);')
-  await run('INSERT INTO t1 VALUES(1, 19147, \'nineteen thousand one hundred forty-seven\');')
-  await run('INSERT INTO t1 VALUES(2, 26008, \'twenty-six thousand eight\');')
-  await run('INSERT INTO t1 VALUES(3, 46582, \'forty-six thousand five hundred eighty-two\');')
+  await run("INSERT INTO t1 VALUES(1, 19147, 'nineteen thousand one hundred forty-seven');")
+  await run("INSERT INTO t1 VALUES(2, 26008, 'twenty-six thousand eight');")
+  await run("INSERT INTO t1 VALUES(3, 46582, 'forty-six thousand five hundred eighty-two');")
   await stream(onData, 'select * from t1')
 }
 
-export async function runIterator(
-  core: SQLiteDBCore,
-): Promise<void> {
-  const sql = 'INSERT INTO t1 VALUES(100, 19147, \'nineteen thousand one hundred forty-seven\'), (200, 26008, \'twenty-six thousand eight\'), (300, 46582, \'forty-six thousand five hundred eighty-two\') returning *;'
+export async function runIterator(core: SQLiteDBCore): Promise<void> {
+  const sql =
+    "INSERT INTO t1 VALUES(100, 19147, 'nineteen thousand one hundred forty-seven'), (200, 26008, 'twenty-six thousand eight'), (300, 46582, 'forty-six thousand five hundred eighty-two') returning *;"
   const it = iterator(core, sql)
   for await (const row of it) {
     console.log('[iterator]', row)