feat: modernize, convert to ESM

kirillgroshkov · kirillgroshkov · commit 01cf9482e780 · 2025-04-05T20:30:41.000+02:00
BREAKING CHANGE: ^^^
diff --git a/eslint.config.js b/eslint.config.js
@@ -1,4 +1,10 @@
-// prettier-ignore
-module.exports = [
-  ...require('@naturalcycles/dev-lib/cfg/eslint.config'),
+import sharedConfig from '@naturalcycles/dev-lib/cfg/eslint.config.js'
+
+export default [
+  ...sharedConfig,
+  {
+    rules: {
+      '@typescript-eslint/consistent-type-imports': 2,
+    },
+  },
 ]
diff --git a/jest.config.js b/jest.config.js
diff --git a/package.json b/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@naturalcycles/sqlite-lib",
+  "type": "module",
   "scripts": {
     "prepare": "husky",
     "build": "dev-lib build",
@@ -9,19 +10,21 @@
     "lbt": "dev-lib lbt"
   },
   "dependencies": {
-    "@naturalcycles/db-lib": "^9.1.0",
-    "@naturalcycles/js-lib": "^14.27.0",
-    "@naturalcycles/nodejs-lib": "^13.1.3",
-    "@types/better-sqlite3": "^7.6.0",
-    "better-sqlite3": "^11.0.0",
-    "sql-template-strings": "^2.2.2",
-    "sqlite": "^5.0.1",
-    "sqlite3": "^5.1.1"
+    "@naturalcycles/db-lib": "^10",
+    "@naturalcycles/js-lib": "^14",
+    "@naturalcycles/nodejs-lib": "^13",
+    "@types/better-sqlite3": "^7",
+    "better-sqlite3": "^11",
+    "sql-template-strings": "^2",
+    "sqlite": "^5",
+    "sqlite3": "^5"
   },
   "devDependencies": {
-    "@naturalcycles/dev-lib": "^15.21.0",
-    "@types/node": "^22.7.5",
-    "jest": "^29.0.3"
+    "@naturalcycles/dev-lib": "^17",
+    "@types/node": "^22",
+    "@vitest/coverage-v8": "^3",
+    "tsx": "^4",
+    "vitest": "^3"
   },
   "files": [
     "dist",
@@ -41,7 +44,7 @@
     "url": "https://github.com/NaturalCycles/sqlite-lib"
   },
   "engines": {
-    "node": ">=20.13.0"
+    "node": ">=22.12.0"
   },
   "version": "1.2.1",
   "description": "CommonDB implementation based on SQLite",
diff --git a/prettier.config.js b/prettier.config.js
@@ -1 +1,3 @@
-module.exports = require('@naturalcycles/dev-lib/cfg/prettier.config')
+import sharedConfig from '@naturalcycles/dev-lib/cfg/prettier.config.js'
+
+export default sharedConfig
diff --git a/scripts/generateTestTable.script.ts b/scripts/generateTestTable.script.ts
@@ -1,6 +1,6 @@
 /*
 
-DEBUG=nc* yarn tsn generateTestTable
+yarn tsx scripts/generateTestTable.script.ts
 
 Creates ./tmp/test.sqlite
 Fills it with 1M rows of TestItem
@@ -9,17 +9,17 @@ Not gzipped (to better test streaming)
  */
 
 import { Readable } from 'node:stream'
-import { TEST_TABLE } from '@naturalcycles/db-lib/dist/testing'
+import { TEST_TABLE } from '@naturalcycles/db-lib/dist/testing/index.js'
 import { _range } from '@naturalcycles/js-lib'
 import {
   _pipeline,
   runScript,
   transformLogProgress,
   writableForEach,
 } from '@naturalcycles/nodejs-lib'
-import { SqliteKeyValueDB } from '../src'
-import { tmpDir } from '../src/test/paths.cnst'
-import { TestItem } from '../src/test/test.model'
+import { SqliteKeyValueDB } from '../src/index.js'
+import { tmpDir } from '../src/test/paths.cnst.js'
+import type { TestItem } from '../src/test/test.model.js'
 
 runScript(async () => {
   const filename = `${tmpDir}/test.sqlite`
diff --git a/scripts/streamingTest.script.ts b/scripts/streamingTest.script.ts
@@ -1,18 +1,18 @@
 /*
 
-DEBUG=nc* yarn tsn streamingTest
+yarn tsx scripts/streamingTest.script.ts
 
  */
 
-import { TEST_TABLE } from '@naturalcycles/db-lib/dist/testing'
+import { TEST_TABLE } from '@naturalcycles/db-lib/dist/testing/index.js'
 import {
   _pipeline,
   runScript,
   transformLogProgress,
   writableForEach,
 } from '@naturalcycles/nodejs-lib'
-import { SqliteKeyValueDB } from '../src'
-import { tmpDir } from '../src/test/paths.cnst'
+import { SqliteKeyValueDB } from '../src/index.js'
+import { tmpDir } from '../src/test/paths.cnst.js'
 
 runScript(async () => {
   const filename = `${tmpDir}/test.sqlite`
diff --git a/src/betterSqliteKeyValueDB.test.ts b/src/betterSqliteKeyValueDB.test.ts
@@ -1,5 +1,6 @@
-import { runCommonKeyValueDBTest, TEST_TABLE } from '@naturalcycles/db-lib/dist/testing'
-import { BetterSqliteKeyValueDB } from './betterSqliteKeyValueDB'
+import { runCommonKeyValueDBTest, TEST_TABLE } from '@naturalcycles/db-lib/dist/testing/index.js'
+import { afterAll, beforeAll, describe, expect, test } from 'vitest'
+import { BetterSqliteKeyValueDB } from './betterSqliteKeyValueDB.js'
 
 const db = new BetterSqliteKeyValueDB({
   filename: ':memory:',
diff --git a/src/betterSqliteKeyValueDB.ts b/src/betterSqliteKeyValueDB.ts
@@ -1,12 +1,14 @@
-import {
+import type {
   CommonDBCreateOptions,
   CommonKeyValueDB,
-  commonKeyValueDBFullSupport,
   IncrementTuple,
   KeyValueDBTuple,
 } from '@naturalcycles/db-lib'
-import { AppError, CommonLogger } from '@naturalcycles/js-lib'
-import { boldWhite, readableCreate, ReadableTyped } from '@naturalcycles/nodejs-lib'
+import { commonKeyValueDBFullSupport } from '@naturalcycles/db-lib'
+import type { CommonLogger } from '@naturalcycles/js-lib'
+import { AppError } from '@naturalcycles/js-lib'
+import type { ReadableTyped } from '@naturalcycles/nodejs-lib'
+import { boldWhite, readableCreate } from '@naturalcycles/nodejs-lib'
 import type { Database, Options } from 'better-sqlite3'
 import BetterSqlite3 from 'better-sqlite3'
 
diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,3 @@
-export * from './betterSqliteKeyValueDB'
-export * from './sqlite.db'
-export * from './sqliteKeyValueDB'
+export * from './betterSqliteKeyValueDB.js'
+export * from './sqlite.db.js'
+export * from './sqliteKeyValueDB.js'
diff --git a/src/query.util.test.ts b/src/query.util.test.ts
@@ -1,5 +1,6 @@
-import { createTestItemsDBM, TEST_TABLE } from '@naturalcycles/db-lib/dist/testing'
-import { insertSQL } from './query.util'
+import { createTestItemsDBM, TEST_TABLE } from '@naturalcycles/db-lib/dist/testing/index.js'
+import { test } from 'vitest'
+import { insertSQL } from './query.util.js'
 
 test('insertSQL', () => {
   const items = createTestItemsDBM(3)
diff --git a/src/query.util.ts b/src/query.util.ts
@@ -1,5 +1,6 @@
-import { KeyValueDBTuple } from '@naturalcycles/db-lib'
-import { SQL, SQLStatement } from 'sql-template-strings'
+import type { KeyValueDBTuple } from '@naturalcycles/db-lib'
+import type { SQLStatement } from 'sql-template-strings'
+import { SQL } from 'sql-template-strings'
 
 export type SQLWithParams = [sql: string, params: any[]]
 
diff --git a/src/sqlite.db.test.ts b/src/sqlite.db.test.ts
@@ -2,8 +2,10 @@ import {
   createTestItemsDBM,
   TEST_TABLE,
   testItemBMJsonSchema,
-} from '@naturalcycles/db-lib/dist/testing'
-import { SQLiteDB } from './sqlite.db'
+} from '@naturalcycles/db-lib/dist/testing/index.js'
+import { _omit } from '@naturalcycles/js-lib'
+import { test } from 'vitest'
+import { SQLiteDB } from './sqlite.db.js'
 
 test('test1', async () => {
   const db = new SQLiteDB({
@@ -15,7 +17,7 @@ test('test1', async () => {
   // await db.getTables()
   await db.createTable(TEST_TABLE, testItemBMJsonSchema, { dropIfExists: true })
 
-  const items = createTestItemsDBM(3)
+  const items = createTestItemsDBM(3).map(v => _omit(v, ['nested']))
   await db.saveBatch(TEST_TABLE, items)
 
   await db.close()
diff --git a/src/sqlite.db.ts b/src/sqlite.db.ts
@@ -1,16 +1,17 @@
-import {
-  BaseCommonDB,
+import type {
   CommonDB,
   CommonDBCreateOptions,
   CommonDBOptions,
   CommonDBSaveOptions,
 } from '@naturalcycles/db-lib'
-import { CommonLogger, JsonSchemaObject, ObjectWithId } from '@naturalcycles/js-lib'
+import { BaseCommonDB } from '@naturalcycles/db-lib'
+import type { CommonLogger, JsonSchemaObject, ObjectWithId } from '@naturalcycles/js-lib'
 import { boldWhite } from '@naturalcycles/nodejs-lib'
-import { Database, open } from 'sqlite'
+import type { Database } from 'sqlite'
+import { open } from 'sqlite'
 import { OPEN_CREATE, OPEN_READWRITE } from 'sqlite3'
 import * as sqlite3 from 'sqlite3'
-import { insertSQL } from './query.util'
+import { insertSQL } from './query.util.js'
 
 export interface SQLiteDBCfg {
   filename: string
diff --git a/src/sqliteKeyValueDB.test.ts b/src/sqliteKeyValueDB.test.ts
@@ -1,5 +1,6 @@
-import { runCommonKeyValueDBTest, TEST_TABLE } from '@naturalcycles/db-lib/dist/testing'
-import { SqliteKeyValueDB } from './sqliteKeyValueDB'
+import { runCommonKeyValueDBTest, TEST_TABLE } from '@naturalcycles/db-lib/dist/testing/index.js'
+import { afterAll, beforeAll, describe, expect, test } from 'vitest'
+import { SqliteKeyValueDB } from './sqliteKeyValueDB.js'
 
 const db = new SqliteKeyValueDB({
   filename: ':memory:',
diff --git a/src/sqliteKeyValueDB.ts b/src/sqliteKeyValueDB.ts
@@ -1,17 +1,20 @@
-import {
+import type {
   CommonDBCreateOptions,
   CommonKeyValueDB,
-  commonKeyValueDBFullSupport,
   IncrementTuple,
   KeyValueDBTuple,
 } from '@naturalcycles/db-lib'
-import { AppError, CommonLogger, pMap } from '@naturalcycles/js-lib'
-import { boldWhite, readableCreate, ReadableTyped } from '@naturalcycles/nodejs-lib'
-import { Database, open } from 'sqlite'
+import { commonKeyValueDBFullSupport } from '@naturalcycles/db-lib'
+import type { CommonLogger } from '@naturalcycles/js-lib'
+import { AppError, pMap } from '@naturalcycles/js-lib'
+import type { ReadableTyped } from '@naturalcycles/nodejs-lib'
+import { boldWhite, readableCreate } from '@naturalcycles/nodejs-lib'
+import type { Database } from 'sqlite'
+import { open } from 'sqlite'
 import * as sqlite3 from 'sqlite3'
 import { OPEN_CREATE, OPEN_READWRITE } from 'sqlite3'
-import { deleteByIdsSQL, insertKVSQL, selectKVSQL } from './query.util'
-import { SqliteReadable } from './stream.util'
+import { deleteByIdsSQL, insertKVSQL, selectKVSQL } from './query.util.js'
+import { SqliteReadable } from './stream.util.js'
 
 export interface SQLiteKeyValueDBCfg {
   filename: string
diff --git a/src/stream.util.ts b/src/stream.util.ts
@@ -1,6 +1,6 @@
 import { Readable } from 'node:stream'
-import { ReadableTyped } from '@naturalcycles/nodejs-lib'
-import { Database, Statement } from 'sqlite'
+import type { ReadableTyped } from '@naturalcycles/nodejs-lib'
+import type { Database, Statement } from 'sqlite'
 
 /**
  * Based on: https://gist.github.com/rmela/a3bed669ad6194fb2d9670789541b0c7
diff --git a/src/test/paths.cnst.ts b/src/test/paths.cnst.ts
@@ -1,4 +1,8 @@
-import * as path from 'node:path'
+import { dirname, join } from 'node:path'
+import { fileURLToPath } from 'node:url'
 
-export const projectDir = path.join(`${__dirname}/../..`)
+const __filename = fileURLToPath(import.meta.url)
+const __dirname = dirname(__filename)
+
+export const projectDir = join(`${__dirname}/../..`)
 export const tmpDir = `${projectDir}/tmp`
diff --git a/src/test/setupJest.ts b/src/test/setupJest.ts
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,6 +1,7 @@
 {
   "extends": "@naturalcycles/dev-lib/cfg/tsconfig.json",
   "compilerOptions": {
+    "verbatimModuleSyntax": true,
     "outDir": "dist",
   },
   "include": ["src"],
diff --git a/vitest.config.ts b/vitest.config.ts
@@ -0,0 +1,8 @@
+import { defineConfig } from 'vitest/config'
+import { sharedConfig } from '@naturalcycles/dev-lib/cfg/vitest.config.mjs'
+
+export default defineConfig({
+  test: {
+    ...sharedConfig,
+  },
+})
diff --git a/yarn.lock b/yarn.lock
