feat: add shmancy reporter

Named after Fancy Shmancy (something expensive and impressive) it extends the Fancy reporter and allows you to set a custom log format using sprintf expressions

demo/index.js

@@ -6,34 +6,49 @@ const Consola = esm('../src')
 
 const reporters = [
   'FancyReporter',
+  'ShmancyReporter',
   'BasicReporter',
   'JSONReporter',
   'WinstonReporter'
 ]
 
 for (const reporter of reporters) {
+  const s = process.hrtime()
   const consola = new Consola.Consola({
     level: 5,
-    reporters: [new Consola[reporter]()]
+    reporters: [new Consola[reporter]({
+      errStream: process.stdout
+    })]
   })
 
-  for (let type of Object.keys(consola.types).sort()) {
-    consola[type](`A message with consola.${type}()`)
-  }
-
-  consola.info('A JSON Log:', {
-    name: 'Cat',
-    color: '#454545'
-  })
+  for (let i = 0; i < 10; i++) {
+    for (let type of Object.keys(consola.types).sort()) {
+      consola[type](`A message with consola.${type}()`)
+    }
 
-  if (reporter === 'FancyReporter') {
-    consola.success({
-      message: 'This is a fancy badge',
-      additional: 'With some additional info',
-      additionalColor: 'brown',
-      badge: true
+    consola.info('A JSON Log:', {
+      name: 'Cat',
+      color: '#454545'
     })
+
+    if (reporter === 'FancyReporter' || reporter === 'SmancyReporter') {
+      consola.success({
+        message: 'This is a fancy badge',
+        additional: 'With some additional info',
+        additionalColor: 'brown',
+        badge: true
+      })
+    }
+
+    consola.error(new Error('Something bad happened!'))
+
+    const tagged = consola.create({ defaults: { tag: 'tagged' } })
+    for (let type of Object.keys(consola.types).sort()) {
+      tagged[type](`A tagged message with consola.${type}()`)
+    }
   }
 
-  consola.error(new Error('Something bad happened!'))
+  const t = process.hrtime(s)
+
+  console.error(`${reporter} took ${Math.round((t[0] * 1e9 + t[1]) / 1e4) / 1e2}ms`) // eslint-disable-line no-console
 }

package.json

@@ -38,6 +38,7 @@
   "dependencies": {
     "chalk": "^2.4.1",
     "figures": "^2.0.0",
+    "printj": "^1.2.0",
     "std-env": "^2.0.2"
   },
   "devDependencies": {

src/reporters/fancy.js

@@ -1,25 +1,10 @@
 import figures from 'figures'
-import chalk from 'chalk'
 import BasicReporter from './basic'
-import { parseStack, align } from '../utils'
+import { parseStack, align, chalkColor, chalkBgColor } from '../utils'
 
-function chalkColor (name) {
-  if (name[0] === '#') {
-    return chalk.hex(name)
-  }
-  return chalk[name] || chalk.keyword(name)
-}
-
-function chalkBgColor (name) {
-  if (name[0] === '#') {
-    return chalk.bgHex(name)
-  }
-  return chalk['bg' + name[0] + name.slice(1)] || chalk.bgKeyword(name)
-}
-
-const NS_SEPARATOR = chalk.blue(figures(' › '))
+export const NS_SEPARATOR = chalkColor('blue')(figures(' › '))
 
-const ICONS = {
+export const ICONS = {
   start: figures('●'),
   info: figures('ℹ'),
   success: figures('✔'),

src/reporters/index.js

@@ -1,5 +1,6 @@
 export { default as BasicReporter } from './basic'
 export { default as BrowserReporter } from './browser'
 export { default as FancyReporter } from './fancy'
+export { default as ShmancyReporter } from './shmancy'
 export { default as JSONReporter } from './json'
 export { default as WinstonReporter } from './winston'

src/utils.js

@@ -1,3 +1,5 @@
+import chalk from 'chalk'
+
 export function isPlainObject (obj) {
   return Object.prototype.toString.call(obj) === '[object Object]'
 }
@@ -64,3 +66,17 @@ export function align (alignment, str, len, space = ' ') {
     default: return str
   }
 }
+
+export function chalkColor (name) {
+  if (name[0] === '#') {
+    return chalk.hex(name)
+  }
+  return chalk[name] || chalk.keyword(name)
+}
+
+export function chalkBgColor (name) {
+  if (name[0] === '#') {
+    return chalk.bgHex(name)
+  }
+  return chalk['bg' + name[0] + name.slice(1)] || chalk.bgKeyword(name)
+}

yarn.lock

@@ -5542,6 +5542,11 @@ pretty-ms@^3.1.0:
   dependencies:
     parse-ms "^1.0.0"
 
+printj@^1.2.0:
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/printj/-/printj-1.2.0.tgz#852fca7283cdb82f3fd08d007bde701a224cc397"
+  integrity sha512-wQ6jPc72jVXX/qpP2/oDIPQ+ZJqvZGAZPm47LnBwzWTBssK1a/c9p09e/Pd1Nx4ACm+Ru86AT99nuiyOFT2zOQ==
+
 private@^0.1.6, private@^0.1.8:
   version "0.1.8"
   resolved "https://registry.yarnpkg.com/private/-/private-0.1.8.tgz#2381edb3689f7a53d653190060fcf822d2f368ff"