knex 1.0.7 → 2.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "knex",
-  "version": "1.0.7",
+  "version": "2.2.0",
   "description": "A batteries-included SQL query & schema builder for PostgresSQL, MySQL, CockroachDB, MSSQL and SQLite3",
   "main": "knex",
   "types": "types/index.d.ts",
@@ -8,6 +8,10 @@
     "node": ">=12"
   },
   "scripts": {
+    "build": "npm run build:gitignore && npm run build:ts",
+    "clean": "node scripts/clean.js",
+    "build:ts": "tsc",
+    "build:gitignore": "node scripts/update_gitignore_for_tsc_output.js run",
     "format": "prettier --write \"{lib,bin,scripts,test}/**/*.js\"",
     "debug:test": "mocha --inspect-brk --exit -t 0 test/all-tests-suite.js",
     "debug:tape": "node --inspect-brk test/tape/index.js",
@@ -51,10 +55,12 @@
     "db:stop:oracle": "docker-compose -f scripts/docker-compose.yml down",
     "stress:init": "docker-compose -f scripts/stress-test/docker-compose.yml up --no-start && docker-compose -f scripts/stress-test/docker-compose.yml start",
     "stress:test": "node scripts/stress-test/knex-stress-test.js | grep -A 5 -B 60 -- '- STATS '",
-    "stress:destroy": "docker-compose -f scripts/stress-test/docker-compose.yml stop"
+    "stress:destroy": "docker-compose -f scripts/stress-test/docker-compose.yml stop",
+    "prepare": "husky install && npm run clean && npm run build",
+    "prepublishOnly": "npm run clean && npm run build"
   },
   "dependencies": {
-    "colorette": "2.0.16",
+    "colorette": "2.0.19",
     "commander": "^9.1.0",
     "debug": "4.3.4",
     "escalade": "^3.1.1",
@@ -85,7 +91,7 @@
     "pg-native": {
       "optional": true
     },
-    "@vscode/sqlite3": {
+    "sqlite3": {
       "optional": true
     },
     "better-sqlite3": {
@@ -94,13 +100,12 @@
   },
   "lint-staged": {
     "*.{js,json}": [
-      "prettier --write",
-      "git add"
+      "prettier --write"
     ]
   },
   "devDependencies": {
-    "@types/node": "^16.11.22",
-    "@vscode/sqlite3": "^5.0.7",
+    "@tsconfig/recommended": "^1.0.1",
+    "@types/node": "^18.0.4",
     "better-sqlite3": "^7.5.1",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
@@ -113,11 +118,11 @@
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-mocha-no-only": "^1.1.1",
-    "husky": "^4.3.8",
-    "jake": "^8.1.1",
+    "husky": "^8.0.1",
+    "jake": "^10.8.5",
     "JSONStream": "^1.3.5",
-    "lint-staged": "^12.3.7",
-    "mocha": "^9.2.2",
+    "lint-staged": "^13.0.0",
+    "mocha": "^10.0.0",
     "mock-fs": "^5.1.2",
     "mysql": "^2.18.1",
     "mysql2": "^2.3.3",
@@ -127,16 +132,17 @@
     "pg-query-stream": "^4.2.1",
     "prettier": "2.6.2",
     "rimraf": "^3.0.2",
-    "sinon": "^13.0.1",
+    "sinon": "^14.0.0",
     "sinon-chai": "^3.7.0",
     "source-map-support": "^0.5.21",
+    "sqlite3": "^5.0.4",
     "tap-spec": "^5.0.0",
     "tape": "^5.5.3",
     "tedious": "^14.4.0",
     "toxiproxy-node-client": "^2.0.6",
     "ts-node": "^10.7.0",
-    "tsd": "^0.20.0",
-    "typescript": "4.6.3"
+    "tsd": "^0.22.0",
+    "typescript": "4.7.4"
   },
   "buildDependencies": [
     "rimraf"
@@ -193,9 +199,9 @@
     }
   ],
   "browser": {
-    "./lib/migrate/Migrator.js": "./lib/util/noop.js",
+    "./lib/migrations/migrate/Migrator.js": "./lib/util/noop.js",
     "./lib/bin/cli.js": "./lib/util/noop.js",
-    "./lib/seed/Seeder.js": "./lib/util/noop.js",
+    "./lib/migrations/seed/Seeder.js": "./lib/util/noop.js",
     "tedious": false,
     "mysql": false,
     "mysql2": false,
@@ -204,7 +210,6 @@
     "pg-query-stream": false,
     "oracle": false,
     "sqlite3": false,
-    "@vscode/sqlite3": false,
     "better-sqlite3": false,
     "oracledb": false
   },
@@ -214,7 +219,12 @@
   },
   "files": [
     "bin/*",
-    "lib/*",
+    "lib/",
+    "lib/**/*.js",
+    "!lib/**/*.ts",
+    "!lib/**/*.d.ts",
+    "!lib/**/*.js.map",
+    "!lib/.gitignore",
     "scripts/*",
     "types/index.d.ts",
     "types/result.d.ts",
@@ -242,11 +252,6 @@
       "lib/dialects/oracledb"
     ]
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
   "tsd": {
     "directory": "test-tsd",
     "compilerOptions": {

package/scripts/clean.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+
+const fs = require('fs')
+const path = require('path')
+const { execSync } = require("child_process");
+
+function main() {
+  const repoDir = path.dirname(__dirname)
+  const gitDir = path.join(repoDir, '.git')
+  const gitDirExists = doesDirectoryExist(gitDir)
+  if (!gitDirExists) {
+    console.log("No .git directory detected so can not clean 'lib/'. Exiting.")
+    process.exit(0)
+  }
+  console.log("Cleaning 'lib/' of outputted files from Typescript compilation ...")
+  const cmd = 'git clean -f -X lib/'
+  const output = execSync(cmd, { cwd: repoDir })
+  console.log(output.toString('utf8'))
+  console.log('Done')
+}
+
+function doesDirectoryExist(p) {
+  if (fs.existsSync(p)) {
+    return fs.lstatSync(p).isDirectory()
+  }
+  return false
+}
+
+main()

package/scripts/runkit-example.js

@@ -1,4 +1,4 @@
-require('@vscode/sqlite3');
+require('sqlite3');
 const Knex = require('knex');
 
 const knexSqlite = Knex({

package/scripts/update_gitignore_for_tsc_output.js

@@ -0,0 +1,85 @@
+#!/usr/bin/env node
+
+const path = require('path')
+const fs = require('fs')
+
+// Directory constants
+const scriptDirectory = __dirname
+const repoDirectory = path.join(scriptDirectory, '..')
+const libDirectory = path.join(repoDirectory, 'lib')
+
+const helpText = `
+Helper script to update lib/.gitignore for all .js files from .ts files.
+
+    update_gitignore_for_tsc_output.js COMMAND
+
+    COMMAND:
+        run:  Update lib/.gitignore file.
+        help: Print this menu.
+
+    NOTES FOR USAGE:
+    1. This script is tested to work on Ubuntu 18.04 LTS.
+`
+
+const gitignoreHeader = `# DO NOT EDIT, GENERATED BY: scripts/update_gitignore_for_tsc_output.js
+
+# Do not include tsc generated type definitions
+**/*.d.ts
+
+# Do not include tsc source maps
+**/*.js.map
+
+# Do not include .js files from .ts files
+`
+
+function main(cliCommand) {
+  if (cliCommand === 'run') {
+    console.log('Generating lib/.gitignore ...')
+
+    // Find all .ts files in lib/
+    const directoriesToProcess = [libDirectory]
+    const tsFiles = []
+    while (directoriesToProcess.length > 0) {
+      const directory = directoriesToProcess.pop()
+      if (!fs.existsSync(directory)) {
+        throw new Error("Directory doesn't exist:", directory)
+      }
+
+      const files = fs.readdirSync(directory)
+      files.forEach((file) => {
+        const filename = path.join(directory, file)
+        const stat = fs.lstatSync(filename)
+        if (stat.isDirectory()) {
+          directoriesToProcess.push(filename)
+        } else if (filename.endsWith('.ts') && !filename.endsWith('.d.ts')) {
+          tsFiles.push(filename)
+          console.log('Found .ts file:', filename)
+        }
+      })
+    }
+
+    // Get paths of .js files to ignore
+    const jsFilesToIgnore = tsFiles.map((filepath) => {
+      // Cuts off `${libDirectory}/`
+      const relativeTsPath = filepath.slice(libDirectory.length + 1)
+      // Swaps .ts for .js file ending
+      const relativeJsPath = relativeTsPath.slice(0, relativeTsPath.length - 3) + '.js'
+      return relativeJsPath
+    })
+    const jsFilesToIgnoreString = jsFilesToIgnore.join('\n')
+    const libGitignorePath = path.join(libDirectory, '.gitignore')
+    fs.writeFileSync(libGitignorePath, gitignoreHeader + jsFilesToIgnoreString + '\n')
+    console.log('DONE')
+  } else if (['help', '--help', '-h', undefined].includes(cliCommand)) {
+    console.log(helpText)
+  } else {
+    console.log(`Unsupported command: ${cliCommand}`)
+    console.log("Try running with 'help' to see supported commands.")
+    process.exit(1)
+  }
+}
+
+// Main script logic
+const cliCommand = process.argv[2]
+// Start the bash app's main function
+main(cliCommand)