Added code formatting & linting

Author: viktor-podzigun

.github/workflows/ci.yml

@@ -13,6 +13,7 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    timeout-minutes: 20
     steps:
       - name: Git checkout
         uses: actions/checkout@v4
@@ -43,6 +44,8 @@ jobs:
       - name: Run tests
         run: |
           npm i
+          npx quick-lint-js ./*.js
+          npm run formatCheck
           node ./index.test.js
         if: ${{ env.TAG_NAME == '' }}
 

.github/workflows/ci_bun.yml

@@ -20,17 +20,17 @@ jobs:
       - name: Setup Bun
         uses: oven-sh/setup-bun@v1
         with:
-          bun-version: "1.0.1"
+          bun-version: "1.2.0"
 
       - name: Cache Dependencies
         uses: actions/cache@v4
         with:
           path: |
             ~/.bun/install/cache
             ~/work/better-sqlite3-wrapper/better-sqlite3-wrapper/bun.lockb
-          key: ${{ runner.os }}-bun-cache-v1-${{ hashFiles('package.json') }}
+          key: ${{ runner.os }}-bun-cache-v2-${{ hashFiles('package.json') }}
           restore-keys: |
-            ${{ runner.os }}-bun-cache-v1-
+            ${{ runner.os }}-bun-cache-v2-
 
       - name: Run tests
         run: |

index.d.ts

@@ -5,58 +5,64 @@
 /// <reference types="node" />
 
 type VariableArgFunction = (...params: any[]) => any;
-type ArgumentTypes<F extends VariableArgFunction> = F extends (...args: infer A) => any ? A : never;
+type ArgumentTypes<F extends VariableArgFunction> = F extends (
+  ...args: infer A
+) => any
+  ? A
+  : never;
 
 declare namespace BetterSqlite3 {
+  interface Statement<BindParameters extends any[]> {
+    run(...params: BindParameters): undefined;
+    get(...params: BindParameters): any;
+    all(...params: BindParameters): any[];
+  }
 
-    interface Statement<BindParameters extends any[]> {
-        run(...params: BindParameters): undefined;
-        get(...params: BindParameters): any;
-        all(...params: BindParameters): any[];
-    }
-
-    interface Transaction<F extends VariableArgFunction> {
-        (...params: ArgumentTypes<F>): ReturnType<F>;
-        deferred(...params: ArgumentTypes<F>): ReturnType<F>;
-        immediate(...params: ArgumentTypes<F>): ReturnType<F>;
-        exclusive(...params: ArgumentTypes<F>): ReturnType<F>;
-    }
-
-    interface Database {
-        prepare<BindParameters extends any[] | {} = any[]>(
-            source: string,
-        ): BindParameters extends any[] ? Statement<BindParameters> : Statement<[BindParameters]>;
-        transaction<F extends VariableArgFunction>(fn: F): Transaction<F>;
-        close(): this;
-    }
-
-    interface DatabaseConstructor {
-        new (filename: string, options?: Database.Options): Database;
-        prototype: Database;
-
-        SqliteError: typeof SqliteError;
-    }
+  interface Transaction<F extends VariableArgFunction> {
+    (...params: ArgumentTypes<F>): ReturnType<F>;
+    deferred(...params: ArgumentTypes<F>): ReturnType<F>;
+    immediate(...params: ArgumentTypes<F>): ReturnType<F>;
+    exclusive(...params: ArgumentTypes<F>): ReturnType<F>;
+  }
+
+  interface Database {
+    prepare<BindParameters extends any[] | {} = any[]>(
+      source: string
+    ): BindParameters extends any[]
+      ? Statement<BindParameters>
+      : Statement<[BindParameters]>;
+    transaction<F extends VariableArgFunction>(fn: F): Transaction<F>;
+    close(): this;
+  }
+
+  interface DatabaseConstructor {
+    new (filename: string, options?: Database.Options): Database;
+    prototype: Database;
+
+    SqliteError: typeof SqliteError;
+  }
 }
 
 declare class SqliteError extends Error {
-    name: string;
-    message: string;
-    code: string;
-    constructor(message: string, code: string);
+  name: string;
+  message: string;
+  code: string;
+  constructor(message: string, code: string);
 }
 
 declare namespace Database {
+  interface Options {
+    readonly?: boolean | undefined;
+  }
 
-    interface Options {
-        readonly?: boolean | undefined;
-    }
-
-    type SqliteError = typeof SqliteError;
-    type Statement<BindParameters extends any[] | {} = any[]> = BindParameters extends any[]
-        ? BetterSqlite3.Statement<BindParameters>
-        : BetterSqlite3.Statement<[BindParameters]>;
-    type Transaction<T extends VariableArgFunction = VariableArgFunction> = BetterSqlite3.Transaction<T>;
-    type Database = BetterSqlite3.Database;
+  type SqliteError = typeof SqliteError;
+  type Statement<BindParameters extends any[] | {} = any[]> =
+    BindParameters extends any[]
+      ? BetterSqlite3.Statement<BindParameters>
+      : BetterSqlite3.Statement<[BindParameters]>;
+  type Transaction<T extends VariableArgFunction = VariableArgFunction> =
+    BetterSqlite3.Transaction<T>;
+  type Database = BetterSqlite3.Database;
 }
 
 declare const Database: BetterSqlite3.DatabaseConstructor;

index.js

@@ -1,9 +1,9 @@
-const wrapper = function() {
-    if (process['isBun']) {
-        return require("bun:sqlite").Database
-    }
+const wrapper = function () {
+  if (process["isBun"]) {
+    return require("bun:sqlite").Database;
+  }
 
-    return require("better-sqlite3")
-}
+  return require("better-sqlite3");
+};
 
-module.exports = wrapper()
+module.exports = wrapper();

index.test.js

@@ -1,73 +1,80 @@
-const Database = require('./index')
-const os = require('os')
-const fs = require('fs')
-const path = require('path')
+const Database = require("./index");
+const os = require("os");
+const fs = require("fs");
+const path = require("path");
 
-const assert = require('assert').strict
-const it = function() {
-    return process['isBun'] ? test : require('node:test').it
-}()
+const assert = require("assert").strict;
+const it = (function () {
+  return process["isBun"] ? test : require("node:test").it;
+})();
 
-it('should open in-memory database', () => {
-    //when
-    const db = new Database(":memory:")
-    const query = db.prepare("select 'Hello world' as message;")
+it("should open in-memory database", () => {
+  //when
+  const db = new Database(":memory:");
+  const query = db.prepare("select 'Hello world' as message;");
 
-    //then
-    assert.deepEqual(query.get(), {message: 'Hello world'})
+  //then
+  assert.deepEqual(query.get(), { message: "Hello world" });
 
-    //when & then
-    const results = query.all()
-    assert.deepEqual(Array.isArray(results), true);
-    assert.deepEqual(results, [{message: 'Hello world'}])
+  //when & then
+  const results = query.all();
+  assert.deepEqual(Array.isArray(results), true);
+  assert.deepEqual(results, [{ message: "Hello world" }]);
 
-    //when & then
-    db.close()
-})
+  //when & then
+  db.close();
+});
 
-it('should create file-based database', () => {
-    //given
-    const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "better-sqlite3-wrapper-"))
-    const file = path.join(tmpDir, "test.db")
-    let db = new Database(file)
-    const changesQuery = db.prepare("SELECT changes() AS changes;")
-    const lastInsertRowIdQuery = db.prepare("SELECT last_insert_rowid() AS id;")
+it("should create file-based database", () => {
+  //given
+  const tmpDir = fs.mkdtempSync(
+    path.join(os.tmpdir(), "better-sqlite3-wrapper-")
+  );
+  const file = path.join(tmpDir, "test.db");
+  let db = new Database(file);
+  const changesQuery = db.prepare("SELECT changes() AS changes;");
+  const lastInsertRowIdQuery = db.prepare("SELECT last_insert_rowid() AS id;");
 
-    //when
-    const [changes, lastInsertRowId] = db.transaction(() => {
-        db.prepare(`
+  //when
+  const [changes, lastInsertRowId] = db.transaction(() => {
+    db.prepare(
+      `
             create table test(
                 id     integer primary key,
                 name   text not null
             );
-        `).run()
-        const insert = db.prepare("insert into test (name) values (?);")
-        insert.run("test1")
-        insert.run("test2")
-        return [changesQuery.get().changes, lastInsertRowIdQuery.get().id]
-    })()
-        
-    //then
-    assert.deepEqual(changes, 1)
-    assert.deepEqual(lastInsertRowId, 2)
-    db.close()
-    assert.deepEqual(fs.existsSync(file), true)
-    
-    //when
-    db = new Database(file, { readonly: true })
-    const results = db.prepare("select * from test order by id;").all()
-    
-    //then
-    assert.deepEqual(results, [{
-        id: 1,
-        name: "test1"
-    }, {
-        id: 2,
-        name: "test2"
-    }])
-    
-    //cleanup
-    db.close()
-    fs.unlinkSync(file)
-    fs.rmdirSync(tmpDir)
-})
+        `
+    ).run();
+    const insert = db.prepare("insert into test (name) values (?);");
+    insert.run("test1");
+    insert.run("test2");
+    return [changesQuery.get().changes, lastInsertRowIdQuery.get().id];
+  })();
+
+  //then
+  assert.deepEqual(changes, 1);
+  assert.deepEqual(lastInsertRowId, 2);
+  db.close();
+  assert.deepEqual(fs.existsSync(file), true);
+
+  //when
+  db = new Database(file, { readonly: true });
+  const results = db.prepare("select * from test order by id;").all();
+
+  //then
+  assert.deepEqual(results, [
+    {
+      id: 1,
+      name: "test1",
+    },
+    {
+      id: 2,
+      name: "test2",
+    },
+  ]);
+
+  //cleanup
+  db.close();
+  fs.unlinkSync(file);
+  fs.rmdirSync(tmpDir);
+});

package.json

@@ -7,6 +7,12 @@
   },
   "author": "viktor-podzigun",
   "description": "Thin api wrapper around better-sqlite3 and bun:sqlite to allow cross- runtime/engine usage",
+  "scripts": {
+    "lint": "quick-lint-js ./*.js",
+    "test": "bun test && node ./index.test.js",
+    "format": "prettier **/*.js --write",
+    "formatCheck": "prettier **/*.js --check"
+  },
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/farjs/better-sqlite3-wrapper/issues"
@@ -37,5 +43,9 @@
   },
   "optionalDependencies": {
     "better-sqlite3": "^11.5.0"
+  },
+  "devDependencies": {
+    "prettier": "^2.8.8",
+    "quick-lint-js": "^3.0.0"
   }
 }