feat: prepare v5 stable release (#1538)

Author: luin

.dockerignore

@@ -48,7 +48,10 @@
         }
       }
     ],
-    "@typescript-eslint/explicit-member-accessibility": [1, { "accessibility": "no-public" }],
+    "@typescript-eslint/explicit-member-accessibility": [
+      1,
+      { "accessibility": "no-public" }
+    ],
     "@typescript-eslint/no-empty-interface": 0,
     "@typescript-eslint/no-empty-function": 0,
     "@typescript-eslint/no-unused-vars": [
@@ -60,7 +63,7 @@
   },
   "overrides": [
     {
-      "files": ["test/**/*", "test-cluster/**/*"],
+      "files": ["test/cluster/*", "test/unit/*", "test/functional/*"],
       "env": {
         "mocha": true
       },

.eslintignore

@@ -41,7 +41,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Build and test cluster
-        run: bash test-cluster/docker/main.sh
+        run: bash test/cluster/docker/main.sh
 
   code-coverage:
     needs: test

.eslintrc.json

@@ -1,8 +1,5 @@
 {
-  "branches": [
-    "v4",
-    { "name": "main", "channel": "next", "prerelease": "beta" }
-  ],
+  "branches": ["main"],
   "plugins": [
     [
       "@semantic-release/commit-analyzer",

.github/workflows/test.yml

@@ -18,7 +18,6 @@ used in the world's biggest online commerce company [Alibaba](http://www.alibaba
 0. Full-featured. It supports [Cluster](http://redis.io/topics/cluster-tutorial), [Sentinel](http://redis.io/topics/sentinel), [Streams](https://redis.io/topics/streams-intro), [Pipelining](http://redis.io/topics/pipelining), and of course [Lua scripting](http://redis.io/commands/eval), [Redis Functions](https://redis.io/topics/functions-intro), [Pub/Sub](http://redis.io/topics/pubsub) (with the support of binary messages).
 0. High performance 🚀.
 0. Delightful API 😄. It works with Node callbacks and Native promises.
-0. Official TypeScript declarations.
 0. Transformation of command arguments and replies.
 0. Transparent key prefixing.
 0. Abstraction for Lua scripting, allowing you to [define custom commands](https://github.com/luin/ioredis#lua-scripting).
@@ -30,29 +29,28 @@ used in the world's biggest online commerce company [Alibaba](http://www.alibaba
 0. Supports Redis ACL.
 0. Sophisticated error handling strategy.
 0. Supports NAT mapping.
-0. Supports autopipelining
+0. Supports autopipelining.
 
-# Versions
+**100% written in TypeScript and official declarations are provided:**
 
-| NPM Version  | Branch | Node.js Version | Redis Version   |
-| ------------ | ------ | --------------- | --------------- |
-| 5.x.x (beta) | main   | >= 12           | 2.6.12 ~ latest |
-| 4.x.x        | v4     | >= 6            | 2.6.12 ~ 7      |
+<img width="837" src="resources/ts-screenshot.png" alt="TypeScript Screenshot" />
 
-V5 is still in the beta stage. You can install it with:
+# Versions
 
-```
-$ npm install ioredis@next
-```
+| NPM Version    | Branch | Node.js Version | Redis Version   |
+| -------------- | ------ | --------------- | --------------- |
+| 5.x.x (latest) | main   | >= 12           | 2.6.12 ~ latest |
+| 4.x.x          | v4     | >= 6            | 2.6.12 ~ 7      |
 
 Refer to [CHANGELOG.md](CHANGELOG.md) for features and bug fixes introduced in v5.
 
+🚀 [Upgrading from v4 to v5](https://github.com/luin/ioredis/wiki/Upgrading-from-v4-to-v5)
+
 # Links
 
 - [API Documentation](http://luin.github.io/ioredis/) ([Redis](http://luin.github.io/ioredis/classes/default.html), [Cluster](http://luin.github.io/ioredis/classes/Cluster.html))
 - [Changelog](CHANGELOG.md)
 - [Migrating from node_redis](https://github.com/luin/ioredis/wiki/Migrating-from-node_redis)
-- [Error Handling](#error-handling)
 
 <hr>
 
@@ -107,6 +105,12 @@ Medis starts with all the basic features you need:
 $ npm install ioredis
 ```
 
+In a TypeScript project, you may want to add TypeScript declarations for Node.js:
+
+```shell
+$ npm install --save-dev @types/node
+```
+
 ## Basic Usage
 
 ```javascript

.releaserc.json

@@ -38,7 +38,7 @@ async function main() {
   });
 
   fs.writeFileSync(
-    path.join(__dirname, "..", "..", "lib/utils/RedisCommander.ts"),
+    path.join(__dirname, "..", "lib/utils/RedisCommander.ts"),
     template.replace("////", () => interface)
   );
 }

README.md

@@ -9,9 +9,9 @@
   ],
   "scripts": {
     "test:tsd": "npm run build && tsd",
-    "test:js": "TS_NODE_TRANSPILE_ONLY=true NODE_ENV=test mocha \"test/helpers/*.ts\" \"test/**/*.ts\"",
+    "test:js": "TS_NODE_TRANSPILE_ONLY=true NODE_ENV=test mocha \"test/helpers/*.ts\" \"test/unit/**/*.ts\" \"test/functional/**/*.ts\"",
     "test:cov": "nyc npm run test:js",
-    "test:js:cluster": "TS_NODE_TRANSPILE_ONLY=true NODE_ENV=test mocha \"test-cluster/**/*.ts\"",
+    "test:js:cluster": "TS_NODE_TRANSPILE_ONLY=true NODE_ENV=test mocha \"test/cluster/**/*.ts\"",
     "test": "npm run test:js && npm run test:tsd",
     "lint": "eslint --ext .js,.ts ./lib",
     "docs": "npx typedoc --logLevel Error --excludeExternals --excludeProtected --excludePrivate --readme none lib/index.ts",
@@ -31,6 +31,9 @@
     "sentinel",
     "pipelining"
   ],
+  "tsd": {
+		"directory": "test/typing"
+	},
   "author": "Zihua Li <i@zihua.li> (http://zihua.li)",
   "license": "MIT",
   "funding": {
@@ -58,25 +61,25 @@
     "@types/lodash.defaults": "^4.2.6",
     "@types/lodash.isarguments": "^3.1.6",
     "@types/mocha": "^9.1.0",
-    "@types/node": "^17.0.18",
+    "@types/node": "^14.18.12",
     "@types/redis-errors": "^1.2.1",
     "@types/sinon": "^10.0.11",
-    "@typescript-eslint/eslint-plugin": "^5.12.0",
-    "@typescript-eslint/parser": "^5.12.0",
+    "@typescript-eslint/eslint-plugin": "^5.16.0",
+    "@typescript-eslint/parser": "^5.16.0",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^8.9.0",
+    "eslint": "^8.12.0",
     "eslint-config-prettier": "^8.4.0",
     "mocha": "^9.2.1",
     "nyc": "^15.1.0",
-    "prettier": "^2.5.1",
+    "prettier": "^2.6.1",
     "semantic-release": "^19.0.2",
     "server-destroy": "^1.0.1",
     "sinon": "^13.0.1",
     "ts-node": "^10.4.0",
     "tsd": "^0.19.1",
     "typedoc": "^0.22.12",
-    "typescript": "^4.5.5",
+    "typescript": "^4.6.3",
     "uuid": "^8.3.0"
   },
   "nyc": {

bin/generateRedisCommander/argumentTypes.js bin/argumentTypes.js

@@ -1,5 +1,5 @@
 import { expect } from "chai";
-import Redis, { Cluster } from "../lib";
+import Redis, { Cluster } from "../../lib";
 
 const masters = [30000, 30001, 30002];
 const replicas = [30003, 30004, 30005];

bin/generateRedisCommander/index.js bin/index.js

@@ -1,27 +1,33 @@
 import { expectError, expectType } from "tsd";
-import Redis from "../built";
+import Redis from "../../built";
 
 const redis = new Redis();
 
 // call
-expectType<Promise<unknown>>(redis.call('info'));
-expectType<Promise<unknown>>(redis.call('set', 'foo', 'bar'));
-expectType<Promise<unknown>>(redis.call('set', ['foo', 'bar']));
+expectType<Promise<unknown>>(redis.call("info"));
+expectType<Promise<unknown>>(redis.call("set", "foo", "bar"));
+expectType<Promise<unknown>>(redis.call("set", ["foo", "bar"]));
 expectType<Promise<unknown>>(redis.callBuffer("set", ["foo", "bar"]));
-expectType<Promise<unknown>>(redis.call('set', ['foo', 'bar'], (err, value) => {
-  expectType<Error | undefined | null>(err);
-  expectType<unknown | undefined>(value);
-}));
-
-expectType<Promise<unknown>>(redis.call('get', 'foo', (err, value) => {
-  expectType<Error | undefined | null>(err);
-  expectType<unknown | undefined>(value);
-}));
-
-expectType<Promise<unknown>>(redis.call('info', (err, value) => {
-  expectType<Error | undefined | null>(err);
-  expectType<unknown | undefined>(value);
-}));
+expectType<Promise<unknown>>(
+  redis.call("set", ["foo", "bar"], (err, value) => {
+    expectType<Error | undefined | null>(err);
+    expectType<unknown | undefined>(value);
+  })
+);
+
+expectType<Promise<unknown>>(
+  redis.call("get", "foo", (err, value) => {
+    expectType<Error | undefined | null>(err);
+    expectType<unknown | undefined>(value);
+  })
+);
+
+expectType<Promise<unknown>>(
+  redis.call("info", (err, value) => {
+    expectType<Error | undefined | null>(err);
+    expectType<unknown | undefined>(value);
+  })
+);
 
 // GET
 expectType<Promise<string | null>>(redis.get("key"));

bin/generateRedisCommander/overrides.js bin/overrides.js

@@ -1,5 +1,5 @@
 import { expectType } from "tsd";
-import Redis, { Cluster } from "../built";
+import Redis, { Cluster } from "../../built";
 
 expectType<Redis>(new Redis());
 

bin/generateRedisCommander/returnTypes.js bin/returnTypes.js

@@ -1,5 +1,5 @@
 import { expectType } from "tsd";
-import Redis from "../built";
+import Redis from "../../built";
 
 const redis = new Redis();