debug-logfmt 1.2.3 → 1.4.0

package/README.md

@@ -6,9 +6,12 @@
 
 ## Highlights
 
-- Based on [`debug`](https://www.npmjs.com/package/debug), use `DEBUG` for enable/disable logging.
-- Expose `info`, `warn` and `error` logging levels, inspired from [RFC 5424](https://datatracker.ietf.org/doc/html/rfc5424).
-- Format messages using Heroku [logfmt](https://brandur.org/logfmt) syntax.
+- Based on the popular [`debug`](https://www.npmjs.com/package/debug) module.
+- Lazy level evaluation used logs levels.
+- Level support: `info`, `warn` & `error` based from [RFC 5424](https://datatracker.ietf.org/doc/html/rfc5424).
+- Message formatting Heroku [logfmt](https://brandur.org/logfmt) syntax.
+- Colorized output via [`DEBUG_COLORS`](https://github.com/debug-js/debug#environment-variables) by default.
+- [`debug.duration`](#measurement) for measurement.
 
 ## Install
 
@@ -16,15 +19,38 @@
 $ npm install debug-logfmt --save
 ```
 
+## Usage
+
+### Multiple levels
+
+Given a code like this one:
+
+```js
+const debug = require('debug-logfmt')('metascraper')
+
+debug('retry', { url: 'https://kikobeats.com' })
+debug.info('done', { time: Date.now() })
+debug.warn('token expired', { timestamp: Date.now() })
+debug.error('whoops', { message: 'expected `number`, got `NaN`' })
+```
+
+You can:
+- Allow all the levels: `DEBUG=debug-logfmt*`
+- Discard specific levels: `DEBUG="*,-metascraper:info*" node example.js`
+
+### Measurement
+
+Sometimes you need to log the duration of a function:
+
 ```js
-const debug = require('debug-logfmt')
+const { setTimeout } = require('timers/promises')
 
-const log = debug('metascraper')
+const debug = require('debug-logfmt')('metascraper')
 
-log.debug('retry', { url: req.url })
-log.info('done', { time: ms('1 hour') })
-log.warn('token expired', { timestamp: Date.now() })
-log.error('whoops', { message: error.message })
+const duration = debug.duration()
+
+setTimeout(1001).then(() => duration.error('timeout!'))
+setTimeout(1100).then(() => duration.info('success'))
 ```
 
 ## API
@@ -47,6 +73,16 @@ Default: `['debug', 'info', 'warn', 'error']`
 
 The log levels available.
 
+### debug.duration([...args])
+
+It returns a function will print the duration in the next call.
+
+```js
+const duration = debug.duration('query')
+const result = await db.query(query)
+duration(result)
+```
+
 ## License
 
 **debug-logfmt** © [Kiko Beats](https://kikobeats.com), released under the [MIT](https://github.com/Kikobeats/debug-logfmt/blob/master/LICENSE.md) License.<br>

package/package.json

@@ -2,13 +2,25 @@
   "name": "debug-logfmt",
   "description": "debug module using logfmt format",
   "homepage": "https://github.com/Kikobeats/debug-logfmt",
-  "version": "1.2.3",
-  "main": "index.js",
+  "version": "1.4.0",
+  "types": "./src/index.d.ts",
+  "main": "src/index.js",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    },
+    "./encode": {
+      "types": "./src/encode.d.ts",
+      "default": "./src/encode.js"
+    }
+  },
   "author": {
     "email": "josefrancisco.verdu@gmail.com",
     "name": "Kiko Beats",
     "url": "https://kikobeats.com"
   },
+  "contributors": [],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Kikobeats/debug-logfmt.git"
@@ -27,9 +39,8 @@
     "winston"
   ],
   "dependencies": {
-    "@jclem/logfmt2": "~2.4.3",
-    "@kikobeats/time-span": "~1.0.2",
-    "debug-fabulous": "2.0.2",
+    "@kikobeats/time-span": "~1.0.5",
+    "debug-fabulous": "~2.0.8",
     "pretty-ms": "~7.0.1"
   },
   "devDependencies": {
@@ -37,25 +48,24 @@
     "@commitlint/config-conventional": "latest",
     "@ksmithut/prettier-standard": "latest",
     "ava": "latest",
+    "c8": "latest",
     "ci-publish": "latest",
-    "coveralls": "latest",
-    "debug": "latest",
     "finepack": "latest",
     "git-authors-cli": "latest",
-    "git-dirty": "latest",
     "github-generate-release": "latest",
     "nano-staged": "latest",
-    "nyc": "latest",
     "simple-git-hooks": "latest",
     "standard": "latest",
     "standard-markdown": "latest",
-    "standard-version": "latest"
+    "standard-version": "latest",
+    "strip-ansi": "6",
+    "tinyspawn": "latest"
   },
   "engines": {
     "node": ">= 8"
   },
   "files": [
-    "index.js"
+    "src"
   ],
   "license": "MIT",
   "commitlint": {
@@ -68,18 +78,19 @@
       ]
     }
   },
+  "eslintIgnore": [
+    "*.d.ts"
+  ],
   "nano-staged": {
     "*.js": [
-      "git add",
-      "prettier-standard"
+      "prettier-standard",
+      "standard --fix"
     ],
     "*.md": [
-      "git add",
       "standard-markdown"
     ],
     "package.json": [
-      "finepack",
-      "git add"
+      "finepack"
     ]
   },
   "simple-git-hooks": {
@@ -88,15 +99,15 @@
   },
   "scripts": {
     "clean": "rm -rf node_modules",
+    "contributors": "(npx git-authors-cli && npx finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
     "coverage": "nyc report --reporter=text-lcov | coveralls",
-    "lint": "standard-markdown README.md && standard",
-    "postrelease": "npm run release:tags && npm run release:github && ci-publish",
+    "lint": "standard",
+    "postrelease": "npm run release:tags && npm run release:github && (ci-publish || npm publish --access=public)",
     "pretest": "npm run lint",
     "pretty": "prettier-standard index.js {core,test,bin,scripts}/**/*.js --single-quote --print-width 100",
-    "release": "git-authors-cli && git add package.json && standard-version -a",
+    "release": "standard-version -a",
     "release:github": "github-generate-release",
     "release:tags": "git push --follow-tags origin HEAD:master",
-    "test": "exit 0",
-    "update": "ncu -a"
+    "test": "c8 ava"
   }
 }

package/src/encode.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Encodes an object into logfmt format
+ * @param obj - The object to encode
+ * @returns The logfmt encoded string
+ */
+declare function encode(obj: Record<string, any>): string
+
+export = encode

package/src/encode.js

@@ -0,0 +1,15 @@
+function stringify (input) {
+  if (typeof input !== 'string') input = String(input)
+  if (input === '') return '""'
+  let encoded = input.split(/\n/g).join(' ')
+  if (/["\\]/.test(encoded)) encoded = encoded.replace(/["\\]/g, '\\$&')
+  if (/[\s=]/.test(encoded)) encoded = `"${encoded}"`
+  return encoded
+}
+
+module.exports = obj => {
+  let result = ''
+  let i = 0
+  for (const key in obj) result += (i++ ? ' ' : '') + `${key}=${stringify(obj[key])}`
+  return result
+}

package/src/index.d.ts

@@ -0,0 +1,21 @@
+declare namespace DebugLogfmt {
+  interface DebugOptions {
+    levels?: string[]
+  }
+
+  interface DurationLogger {
+    (...args: any[]): boolean
+    error(...args: any[]): boolean
+    info(...args: any[]): boolean
+  }
+
+  interface DebugLogger {
+    (...args: any[]): void
+    duration(...args: any[]): DurationLogger
+    [level: string]: ((...args: any[]) => void) | DurationLogger | ((...args: any[]) => DurationLogger)
+  }
+}
+
+declare function createDebugLogger(env: string, options?: DebugLogfmt.DebugOptions): DebugLogfmt.DebugLogger
+
+export = createDebugLogger

package/{index.js → src/index.js}

@@ -1,12 +1,13 @@
 'use strict'
 
-const { encode } = require('@jclem/logfmt2')
 const origDebug = require('debug')
 
 const timeSpan = require('@kikobeats/time-span')({
   format: require('pretty-ms')
 })
 
+const encode = require('./encode')
+
 /**
  * This methods override the default `formatArgs` to don't print diff information.
  */
@@ -16,9 +17,7 @@ if (process.env.DEBUG_COLORS === 'false') {
   }
 } else {
   origDebug.formatArgs = function formatArgs (args) {
-    const colorCode = `\u001B[3${
-      this.color < 8 ? this.color : `8;5;${this.color}`
-    }`
+    const colorCode = `\u001B[3${this.color < 8 ? this.color : `8;5;${this.color}`}`
     const prefix = `  ${colorCode};1m${this.namespace} \u001B[0m`
     args[0] = prefix + args[0].replace(/\n/g, `\n${prefix}`)
   }
@@ -31,15 +30,11 @@ const LEVELS = ['info', 'warn', 'error']
 const createLogger =
   log =>
     (...args) =>
-      log(
-        args.map(arg => (typeof arg === 'string' ? arg : encode(arg))).join(' ')
-      )
+      log(args.map(arg => (typeof arg === 'string' ? arg : encode(arg))).join(' '))
 
 module.exports = (env, { levels = LEVELS } = {}) => {
   const debug = createLogger(createDebug(env))
-  levels.forEach(
-    level => (debug[level] = createLogger(createDebug(`${env}:${level}`)))
-  )
+  levels.forEach(level => (debug[level] = createLogger(createDebug(`${env}:${level}`))))
 
   debug.duration = (...args) => {
     const duration = timeSpan()