feat: integrated hideMeta option to debug log output, modernize repo, bump deps

titanism · titanism · commit 9ef0ca5e21f3 · 2022-12-05T17:30:37.000-06:00
diff --git a/.commitlintrc.js b/.commitlintrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional']
+};
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1 @@
+!.*.js
diff --git a/.gitattributes b/.gitattributes
@@ -1 +1 @@
-* text=auto
+* text=auto eol=lf
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,26 @@
+name: CI
+on:
+  - push
+  - pull_request
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+        node_version:
+          - 14
+          - 16
+          - 18
+    name: Node ${{ matrix.node_version }} on ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node_version }}
+      - name: Install dependencies
+        run: npm install
+      - name: Run tests
+        run: npm run test
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,12 @@
 node_modules
 coverage
 .nyc_output
+locales/
+package-lock.json
+yarn.lock
+
+Thumbs.db
+tmp/
+temp/
+*.lcov
+.env
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit $1
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no-install lint-staged && npm test
diff --git a/.lintstagedrc.js b/.lintstagedrc.js
@@ -0,0 +1,5 @@
+module.exports = {
+  "*.md": filenames => filenames.map(filename => `remark ${filename} -qfo`),
+  'package.json': 'fixpack',
+  '*.js': 'xo --fix'
+};
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+package-lock=false
diff --git a/.prettierrc.js b/.prettierrc.js
@@ -0,0 +1,5 @@
+module.exports = {
+  singleQuote: true,
+  bracketSpacing: true,
+  trailingComma: 'none'
+};
diff --git a/.remarkrc.js b/.remarkrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+  plugins: ['preset-github']
+};
diff --git a/.xo-config.js b/.xo-config.js
@@ -0,0 +1,5 @@
+module.exports = {
+  prettier: true,
+  space: true,
+  extends: ['xo-lass']
+};
diff --git a/README.md b/README.md
@@ -1,7 +1,6 @@
 # [**@ladjs/redis**](https://github.com/ladjs/redis)
 
-[![build status](https://img.shields.io/travis/ladjs/redis.svg)](https://travis-ci.org/ladjs/redis)
-[![code coverage](https://img.shields.io/codecov/c/github/ladjs/redis.svg)](https://codecov.io/gh/ladjs/redis)
+[![build status](https://github.com/ladjs/redis/actions/workflows/ci.yml/badge.svg)](https://github.com/ladjs/redis/actions/workflows/ci.yml)
 [![code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
 [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 [![made with lass](https://img.shields.io/badge/made_with-lass-95CC28.svg)](https://lass.js.org)
@@ -26,12 +25,6 @@
 npm install @ladjs/redis
 ```
 
-[yarn][]:
-
-```sh
-yarn add @ladjs/redis
-```
-
 
 ## Usage
 
@@ -48,10 +41,8 @@ yarn add @ladjs/redis
 [MIT](LICENSE) © [Nick Baugh](http://niftylettuce.com/)
 
 
-## 
+##
 
 [npm]: https://www.npmjs.com/
 
-[yarn]: https://yarnpkg.com/
-
 [redis]: https://github.com/luin/ioredis
diff --git a/index.js b/index.js
@@ -1,37 +1,38 @@
 const IORedis = require('ioredis');
 
-function getMeta(client) {
+function getMeta(client, hideMeta) {
   return {
     description: client._getDescription(),
-    status: client.status || '[empty]'
+    status: client.status || '[empty]',
+    ...(hideMeta ? { [hideMeta]: true } : {})
   };
 }
 
-function bindEvents(client, logger) {
+function bindEvents(client, logger, hideMeta) {
   client.on('connect', () =>
-    logger.debug('redis connection established', getMeta(client))
+    logger.debug('redis connection established', getMeta(client, hideMeta))
   );
   client.on('ready', () =>
-    logger.debug('redis connection ready', getMeta(client))
+    logger.debug('redis connection ready', getMeta(client, hideMeta))
   );
-  client.on('error', (err) => logger.error(err, getMeta(client)));
+  client.on('error', (error) => logger.error(error, getMeta(client, hideMeta)));
   client.on('close', () =>
-    logger.debug('redis connection closed', getMeta(client))
+    logger.debug('redis connection closed', getMeta(client, hideMeta))
   );
   client.on('reconnecting', (time) =>
-    logger.debug('redis reconnecting', { time, ...getMeta(client) })
+    logger.debug('redis reconnecting', { time, ...getMeta(client, hideMeta) })
   );
   client.on('end', () =>
-    logger.debug('redis connection ended', getMeta(client))
+    logger.debug('redis connection ended', getMeta(client, hideMeta))
   );
   client.on('+node', () =>
-    logger.debug('redis node connected', getMeta(client))
+    logger.debug('redis node connected', getMeta(client, hideMeta))
   );
   client.on('-node', () =>
-    logger.debug('redis node disconnected', getMeta(client))
+    logger.debug('redis node disconnected', getMeta(client, hideMeta))
   );
-  client.on('node error', (err, address) =>
-    logger.error(err, { address, ...getMeta(client) })
+  client.on('node error', (error, address) =>
+    logger.error(error, { address, ...getMeta(client, hideMeta) })
   );
 }
 
@@ -41,33 +42,40 @@ function Redis(
   logger = console,
   monitor = false,
   maxListeners = 15,
-  _bindEvents = true
+  _bindEvents = true,
+  hideMeta = 'hide_meta'
 ) {
   const client = new IORedis(config);
   client.setMaxListeners(maxListeners);
   // https://github.com/luin/ioredis#monitor
   if (monitor) {
-    client.monitor((err, monitor) => {
-      if (err) return logger.error(err, getMeta(client));
+    client.monitor((error, monitor) => {
+      if (error) {
+        return logger.error(error, getMeta(client, hideMeta));
+      }
+
       logger.debug('redis monitor instance created', {
-        ...getMeta(client),
+        ...getMeta(client, hideMeta),
         monitor
       });
       client._monitor = monitor;
       monitor.on('monitor', (time, args, source, database) =>
         logger.debug('redis monitor', {
-          ...getMeta(client),
+          ...getMeta(client, hideMeta),
           time,
           args,
           source,
           database
         })
       );
-      bindEvents(monitor, logger);
+      bindEvents(monitor, logger, hideMeta);
     });
   }
 
-  if (_bindEvents) bindEvents(client, logger);
+  if (_bindEvents) {
+    bindEvents(client, logger, hideMeta);
+  }
+
   return client;
 }
 
diff --git a/package.json b/package.json
@@ -3,54 +3,41 @@
   "description": "Redis for Lad",
   "version": "1.0.7",
   "author": "Nick Baugh <niftylettuce@gmail.com> (http://niftylettuce.com/)",
-  "ava": {
-    "failFast": true,
-    "verbose": true
-  },
   "bugs": {
     "url": "https://github.com/ladjs/redis/issues",
     "email": "niftylettuce@gmail.com"
   },
-  "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
-  },
   "contributors": [
     "Nick Baugh <niftylettuce@gmail.com> (http://niftylettuce.com/)"
   ],
   "dependencies": {
-    "ioredis": "^4.17.3"
+    "ioredis": "^5.2.4"
   },
   "devDependencies": {
-    "@commitlint/cli": "^9.1.1",
-    "@commitlint/config-conventional": "^9.1.1",
-    "ava": "^3.10.1",
-    "codecov": "^3.7.1",
-    "cross-env": "^7.0.2",
-    "delay": "^4.4.0",
-    "eslint": "7.5.0",
-    "eslint-config-xo-lass": "^1.0.3",
+    "@commitlint/cli": "^17.3.0",
+    "@commitlint/config-conventional": "^17.3.0",
+    "ava": "^5.1.0",
+    "cross-env": "^7.0.3",
+    "delay": "^5.0.0",
+    "eslint": "8.29.0",
+    "eslint-config-xo-lass": "^2.0.1",
     "eslint-plugin-node": "^11.1.0",
-    "fixpack": "^3.0.6",
-    "husky": "^4.2.5",
-    "lint-staged": "^10.2.11",
+    "fixpack": "^4.0.0",
+    "husky": "^8.0.2",
+    "lint-staged": "^13.1.0",
     "nyc": "^15.1.0",
-    "remark-cli": "^8.0.1",
-    "remark-preset-github": "^2.0.2",
-    "sinon": "^9.0.2",
-    "xo": "^0.32.1"
+    "remark-cli": "^11.0.0",
+    "remark-preset-github": "^4.0.4",
+    "sinon": "^15.0.0",
+    "xo": "^0.53.1"
   },
   "engines": {
-    "node": ">=8.3"
+    "node": ">=14"
   },
+  "files": [
+    "index.js"
+  ],
   "homepage": "https://github.com/ladjs/redis",
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged && npm test",
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
-    }
-  },
   "keywords": [
     "agenda",
     "api",
@@ -87,49 +74,18 @@
     "web"
   ],
   "license": "MIT",
-  "lint-staged": {
-    "*.js": [
-      "xo --fix",
-      "git add"
-    ],
-    "*.md": [
-      "remark . -qfo",
-      "git add"
-    ],
-    "package.json": [
-      "fixpack",
-      "git add"
-    ]
-  },
   "main": "index.js",
-  "prettier": {
-    "singleQuote": true,
-    "bracketSpacing": true,
-    "trailingComma": "none"
-  },
   "publishConfig": {
     "access": "public"
   },
-  "remarkConfig": {
-    "plugins": [
-      "preset-github"
-    ]
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/ladjs/redis"
   },
   "scripts": {
-    "coverage": "nyc report --reporter=text-lcov > coverage.lcov && codecov",
-    "lint": "xo && remark . -qfo",
-    "test": "npm run lint && npm run test-coverage",
-    "test-coverage": "cross-env NODE_ENV=test nyc ava"
-  },
-  "xo": {
-    "prettier": true,
-    "space": true,
-    "extends": [
-      "xo-lass"
-    ]
+    "lint": "xo --fix && remark . -qfo && fixpack",
+    "prepare": "husky install",
+    "pretest": "npm run lint",
+    "test": "cross-env NODE_ENV=test nyc ava"
   }
 }
diff --git a/test/test.js b/test/test.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = {`
	`2`	`+ extends: ['@commitlint/config-conventional']`
	`3`	`+};`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+module.exports = {`
	`2`	`+ plugins: ['preset-github']`
	`3`	`+};`