Adapt eslint and whitespace conventions for typescript

Author: LeartS

.editorconfig

@@ -6,10 +6,14 @@ insert_final_newline = true
 trim_trailing_whitespace = true
 charset = utf-8
 
+[*.ts]
+indent_style = space
+indent_size = 4
+
 [*.js]
 indent_style = space
 indent_size = 2
 
-[{package.json,*.yml,*.cjson}]
+[{*.json,*.yml,*.cjson}]
 indent_style = space
 indent_size = 2

.eslintrc

@@ -0,0 +1,43 @@
+{
+  "env": {
+    "commonjs": true,
+    "es6": true
+  },
+  "extends": [
+    "standard",
+    "eslint:recommended",
+    "plugin:node/recommended",
+    "plugin:promise/recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "plugins": [
+    "@typescript-eslint",
+    "promise"
+  ],
+  "settings": {
+    "import/resolver": {
+      "node": {
+        "extensions": [".js"]
+      }
+    }
+  },
+  "rules": {
+    "no-await-in-loop": "warn",
+    "no-process-exit": "warn",
+    "no-tabs": "error",
+    "no-var": "error",
+    "semi": ["error", "never"],
+    "eqeqeq": ["error", "always"],
+    "node/no-unsupported-features/es-syntax": "off",
+    "@typescript-eslint/no-non-null-assertion": "warn",
+    "@typescript-eslint/explicit-function-return-type": [
+      "error", {
+        "allowExpressions": true
+      }
+    ]
+  }
+}

.eslintrc.json

@@ -1,70 +1,68 @@
 import * as url from 'url'
 import * as Redis from 'ioredis'
-import { ClusterOptions, RedisOptions } from 'ioredis'
 import * as debug from 'debug'
 
 const debugEvents = debug('monredis:events')
 const debugInfo = debug('monredis:info')
 
 /**
- * ioRedis has a bug where if the redis instance endpoint is supplied using
- * a connection uri; the password is passed only to the
- */
-function getRedisPasswordFromURI (redisUri: string | string[]) : string {
-  if (Array.isArray(redisUri)) {
-    redisUri = redisUri[0]
-  }
-  const parsedURL = new url.URL(redisUri)
-  return parsedURL.password
+* Extract password from connection URI
+*/
+function getRedisPasswordFromURI (redisUri: string | string[]): string {
+    if (Array.isArray(redisUri)) {
+        redisUri = redisUri[0]
+    }
+    const parsedURL = new url.URL(redisUri)
+    return parsedURL.password
 }
 
 type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>
-type MonredisClusterOptions = Omit<ClusterOptions, 'redisOptions'>
+type MonredisClusterOptions = Omit<Redis.ClusterOptions, 'redisOptions'>
 
-const defaultNodeOptions: RedisOptions= {
-  keyPrefix: '',
-  autoResubscribe: true,
-  autoResendUnfulfilledCommands: true,
+const defaultNodeOptions: Redis.RedisOptions= {
+    keyPrefix: '',
+    autoResubscribe: true,
+    autoResendUnfulfilledCommands: true,
 }
 
-const defaultClusterOptions: ClusterOptions = {
-  retryDelayOnClusterDown: 300,
-  retryDelayOnFailover: 1000,
-  retryDelayOnTryAgain: 3000,
-  slotsRefreshTimeout: 10000,
-  clusterRetryStrategy: times => Math.min(times * 1000, 10000),
+const defaultClusterOptions: Redis.ClusterOptions = {
+    retryDelayOnClusterDown: 300,
+    retryDelayOnFailover: 1000,
+    retryDelayOnTryAgain: 3000,
+    slotsRefreshTimeout: 10000,
+    clusterRetryStrategy: times => Math.min(times * 1000, 10000),
 }
 
 function getClient (
-  host: string | string[],
-  cluster: boolean = false,
-  userNodeOptions: RedisOptions = {},
-  userClusterOptions: MonredisClusterOptions = {}
-) {
-  const nodeOptions: RedisOptions = {...defaultNodeOptions, ...userNodeOptions}
-  const clusterOptions: ClusterOptions = {...defaultClusterOptions, ...userClusterOptions}
-  clusterOptions.redisOptions = nodeOptions
-  let client
-  if (cluster) {
-    // Workaround for ioredis bug not passing password to all nodes if
-    // endpoint is supplied using connection uri
-    const password = getRedisPasswordFromURI(host)
-    clusterOptions.redisOptions.password = password
-    host = Array.isArray(host) ? host : [host]
-    debugInfo('Creating new redis cluster instance')
-    client = new Redis.Cluster(host, clusterOptions)
-  } else {
-    debugInfo('Creating new redis single node instance')
-    client = new Redis(Array.isArray(host) ? host[0] : host, nodeOptions)
-  }
-  client.on('connecting', () => debugEvents('[connecting]'))
-  client.on('connect', () => debugEvents('[connect]'))
-  client.on('ready', () => debugEvents('[ready]'))
-  client.on('error', (arg) => debugEvents('[error] with argument %O', arg))
-  client.on('close', () => debugEvents('[close]'))
-  client.on('reconnecting', () => debugEvents('[reconnecting]'))
-  client.on('end', () => debugEvents('[end]'))
-  return client
+    host: string | string[],
+    cluster: boolean = false,
+    userNodeOptions: Redis.RedisOptions = {},
+    userClusterOptions: MonredisClusterOptions = {}
+): Redis.Redis | Redis.Cluster {
+    const nodeOptions: Redis.RedisOptions = {...defaultNodeOptions, ...userNodeOptions}
+    const clusterOptions: Redis.ClusterOptions = {...defaultClusterOptions, ...userClusterOptions}
+    clusterOptions.redisOptions = nodeOptions
+    let client
+    if (cluster) {
+        // Workaround for ioredis bug not passing password to all nodes if
+        // endpoint is supplied using connection uri
+        const password = getRedisPasswordFromURI(host)
+        clusterOptions.redisOptions.password = password
+        host = Array.isArray(host) ? host : [host]
+        debugInfo('Creating new redis cluster instance')
+        client = new Redis.Cluster(host, clusterOptions)
+    } else {
+        debugInfo('Creating new redis single node instance')
+        client = new Redis(Array.isArray(host) ? host[0] : host, nodeOptions)
+    }
+    client.on('connecting', () => debugEvents('[connecting]'))
+    client.on('connect', () => debugEvents('[connect]'))
+    client.on('ready', () => debugEvents('[ready]'))
+    client.on('error', (arg) => debugEvents('[error] with argument %O', arg))
+    client.on('close', () => debugEvents('[close]'))
+    client.on('reconnecting', () => debugEvents('[reconnecting]'))
+    client.on('end', () => debugEvents('[end]'))
+    return client
 }
 
 export = getClient

lib/redis.ts

@@ -11,7 +11,7 @@
   "scripts": {
     "build": "tsc",
     "test": "env TS_NODE_FILES=true mocha --require ts-node/register --extension ts --colors --exit",
-    "lint": "eslint . --ext js",
+    "lint": "eslint --ext .ts lib test",
     "prepare": "npm run build"
   },
   "files": [
@@ -34,6 +34,8 @@
     "@types/ioredis": "^4.0.10",
     "@types/mocha": "^5.2.6",
     "@types/node": "^11.13.4",
+    "@typescript-eslint/eslint-plugin": "^1.6.0",
+    "@typescript-eslint/parser": "^1.6.0",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "eslint": "^5.13.0",