feat: refactor into CommonKeyValueDB and RedisClient, modernize

BREAKING CHANGE: ^^^

Author: kirillgroshkov

.circleci/config.yml

@@ -0,0 +1,43 @@
+name: ci
+
+on: [push, workflow_dispatch]
+
+env:
+  NODE_OPTIONS: --max-old-space-size=5000
+
+jobs:
+  build-job:
+    runs-on: ubuntu-latest
+    steps:
+      - { uses: actions/checkout@v4, with: { persist-credentials: false } }
+      - { uses: actions/setup-node@v4, with: { node-version: 'lts/*', cache: 'yarn' } }
+      - run: yarn --frozen-lockfile
+      - name: build
+        run: yarn build
+      - name: test
+        run: yarn test
+
+  release-job:
+    runs-on: ubuntu-latest
+    if: github.ref_name == 'master'
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - { uses: actions/checkout@v4, with: { persist-credentials: true } }
+      - { uses: actions/setup-node@v4, with: { node-version: 'lts/*', cache: 'yarn' } }
+
+      # Cache for npm/npx in ~/.npm
+      - uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: npm-v1-${{ runner.os }}
+
+      - run: yarn --frozen-lockfile
+      - run: yarn build-prod
+
+      - name: release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx @naturalcycles/semantic-release

.github/workflows/ci.yml

@@ -0,0 +1,6 @@
+#!/bin/sh
+[ -n "$CI" ] && exit 0
+. "$(dirname "$0")/_/husky.sh"
+
+node_modules/.bin/commitlint-def $1
+# exit 1 # uncomment to debug

.husky/commit-msg

@@ -0,0 +1,5 @@
+#!/bin/sh
+[ -n "$CI" ] && exit 0
+. "$(dirname "$0")/_/husky.sh"
+
+node_modules/.bin/lint-staged-def

.husky/pre-commit

@@ -1,32 +1 @@
-# [2.0.0](https://github.com/NaturalCycles/redis-lib/compare/v1.1.1...v2.0.0) (2019-10-19)
-
-
-### Features
-
-* impl CommonDB 2.0 ([4830225](https://github.com/NaturalCycles/redis-lib/commit/4830225))
-
-
-### BREAKING CHANGES
-
-* ^^^
-
-## [1.1.1](https://github.com/NaturalCycles/redis-lib/compare/v1.1.0...v1.1.1) (2019-09-20)
-
-
-### Bug Fixes
-
-* adapt to new db-lib ([d3555be](https://github.com/NaturalCycles/redis-lib/commit/d3555be))
-
-# [1.1.0](https://github.com/NaturalCycles/redis-lib/compare/v1.0.0...v1.1.0) (2019-08-23)
-
-
-### Features
-
-* namespacePrefix; adopt to db-lib ([e3b35f4](https://github.com/NaturalCycles/redis-lib/commit/e3b35f4))
-
-# 1.0.0 (2019-08-20)
-
-
-### Features
-
-* first version ([a80ee79](https://github.com/NaturalCycles/redis-lib/commit/a80ee79))
+See [Github Releases](https://github.com/NaturalCycles/redis-lib/releases)

CHANGELOG.md

@@ -1,22 +1,18 @@
 {
   "name": "@naturalcycles/redis-lib",
-  "scripts": {},
+  "scripts": {
+    "prepare": "husky"
+  },
   "dependencies": {
-    "@naturalcycles/db-lib": "^2.0.2",
-    "@naturalcycles/js-lib": "^8.5.1",
-    "@naturalcycles/nodejs-lib": "^6.11.1",
-    "@types/ioredis": "^4.0.15",
-    "chalk": "^2.4.2",
-    "ioredis": "^4.14.0"
+    "@naturalcycles/db-lib": "^9.9.2",
+    "@naturalcycles/js-lib": "^14.217.0",
+    "@naturalcycles/nodejs-lib": "^13.8.0",
+    "ioredis": "^5.3.2"
   },
   "devDependencies": {
-    "@naturalcycles/dev-lib": "^8.1.0",
-    "@types/node": "^12.7.2",
-    "dotenv": "^8.1.0",
-    "jest": "^24.9.0"
-  },
-  "resolutions": {
-    "@types/hapi__joi": "15.0.4"
+    "@naturalcycles/dev-lib": "^13.49.2",
+    "@types/node": "^20.12.2",
+    "jest": "^29.7.0"
   },
   "files": [
     "dist",
@@ -29,17 +25,18 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "publishConfig": {
+    "provenance": true,
     "access": "public"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/NaturalCycles/redis-lib"
   },
   "engines": {
-    "node": ">=10.13"
+    "node": ">=18.12"
   },
   "version": "2.0.0",
-  "description": "Redis implementation of CommonDB interface",
+  "description": "Redis implementation of CommonKeyValueDB interface",
   "author": "Natural Cycles Team",
   "license": "MIT"
 }

husky.config.js

@@ -1,6 +1,6 @@
 ## @naturalcycles/redis-lib
 
-> Redis implementation of CommonDB interface
+> Redis implementation of CommonKeyValueDB interface
 
 [![npm](https://img.shields.io/npm/v/@naturalcycles/redis-lib/latest.svg)](https://www.npmjs.com/package/@naturalcycles/redis-lib)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
@@ -9,28 +9,22 @@
 
 - ...
 
-# DEBUG namespaces
-
-- `nc:redis-lib`
-- `ioredis`, `ioredis:redis`, `ioredis:connection`
-
-# Packaging
-
-- `engines.node >= 10.13`: Latest Node.js LTS
-- `main: dist/index.js`: commonjs, es2018
-- `types: dist/index.d.ts`: typescript types
-- `/src` folder with source `*.ts` files included
-
 # Starting / debugging Redis server on OSX
 
-    brew install redis
-    brew services start redis
-    brew services stop redis
+```shell
+brew install redis
+brew services start redis
+brew services stop redis
+
+redis-server /usr/local/etc/redis.conf
 
-    redis-server /usr/local/etc/redis.conf
+redis-cli ping
+redis-cli flushall
 
-    redis-cli ping
-    redis-cli flushall
+# connect and list all keys
+redis-cli
+scan 0
+```
 
 Location and size of local DB:
 

package.json

@@ -1,3 +1,2 @@
-import { RedisDB, RedisDBCfg } from './redis.db'
-
-export { RedisDBCfg, RedisDB }
+export * from './redisClient'
+export * from './redisKeyValueDB'