Release 4.0.0-rc.3

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,15 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: Bug
+assignees: ''
+---
+
+<!-- Describe your issue here -->
+
+**Environment:**
+ - **Node.js Version**: <!-- e.g. "node --version" -->
+ - **Redis Server Version**: <!-- e.g. "redis-server --version" -->
+ - **Node Redis Version**: <!-- e.g. "npm ls redis" -->
+ - **Platform**: <!-- e.g. Ubuntu 20.04.3, Windows 10, Mac OS 11.6 -->

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,7 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: Bug
+assignees: ''
+---

.npmignore

@@ -1,12 +1,13 @@
 .vscode/
 .idea/
 node_modules/
-.nyc_output
+.nyc_output/
 coverage/
 dump.rdb
 documentation/
 CONTRIBUTING.md
 tsconfig.json
+.deepsource.toml
 .nycrc.json
 benchmark/
 .github/

README.md

@@ -53,7 +53,7 @@ The above code connects to localhost on port 6379. To connect to a different hos
 
 ```typescript
 createClient({
-  url: 'redis://alice:[email protected]:6380',
+  url: 'redis://alice:[email protected]:6380'
 });
 ```
 
@@ -78,7 +78,7 @@ Modifiers to commands are specified using a JavaScript object:
 ```typescript
 await client.set('key', 'value', {
   EX: 10,
-  NX: true,
+  NX: true
 });
 ```
 
@@ -181,12 +181,9 @@ for await (const key of client.scanIterator()) {
 This works with `HSCAN`, `SSCAN`, and `ZSCAN` too:
 
 ```typescript
-for await (const member of client.hScanIterator('hash')) {
-}
-for await (const { field, value } of client.sScanIterator('set')) {
-}
-for await (const { member, score } of client.zScanIterator('sorted-set')) {
-}
+for await (const member of client.hScanIterator('hash')) {}
+for await (const { field, value } of client.sScanIterator('set')) {}
+for await (const { member, score } of client.zScanIterator('sorted-set')) {}
 ```
 
 You can override the default options by providing a configuration object:
@@ -204,7 +201,8 @@ client.scanIterator({
 Define new functions using [Lua scripts](https://redis.io/commands/eval) which execute on the Redis server:
 
 ```typescript
-import { createClient, defineScript } from 'redis';
+import { createClient } from 'redis';
+import { defineScript } from 'redis/lua-script';
 
 (async () => {
   const client = createClient({
@@ -218,9 +216,9 @@ import { createClient, defineScript } from 'redis';
         },
         transformReply(reply: number): number {
           return reply;
-        },
-      }),
-    },
+        }
+      })
+    }
   });
 
   await client.connect();
@@ -241,14 +239,12 @@ import { createCluster } from 'redis';
   const cluster = createCluster({
     rootNodes: [
       {
-        host: '10.0.0.1',
-        port: 30001,
+        url: 'redis://10.0.0.1:30001'
       },
       {
-        host: '10.0.0.2',
-        port: 30002,
-      },
-    ],
+        url: 'redis://10.0.0.2:30002'
+      }
+    ]
   });
 
   cluster.on('error', (err) => console.log('Redis Cluster Error', err));
@@ -274,7 +270,7 @@ Of course, if you don't do something with your Promises you're certain to get [u
 ```typescript
 await Promise.all([
   client.set('Tm9kZSBSZWRpcw==', 'users:1'),
-  client.sAdd('users:1:tokens', 'Tm9kZSBSZWRpcw=='),
+  client.sAdd('users:1:tokens', 'Tm9kZSBSZWRpcw==')
 ]);
 ```
 

SECURITY.md

@@ -0,0 +1,16 @@
+# Security Policy
+
+## Supported Versions
+
+Node Redis is generally backwards compatible with very few exceptions, so we recommend users to always use the latest version to experience stability, performance and security.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 4.0.x   | :white_check_mark: |
+| 3.1.x   | :white_check_mark: |
+| < 3.1   | :x:                |
+
+## Reporting a Vulnerability
+
+If you believe you’ve discovered a serious vulnerability, please contact the Node Redis core team at [email protected]. We will evaluate your report and if necessary issue a fix and an advisory. If the issue was previously undisclosed,
+we’ll also mention your name in the credits.