feat: log levels

You can configure `pwc` to output logs for only certain levels. By default, the log level is a `0` which also represents `"log"` or `"debug"` which outputs logs from all levels. You can set the log level on `pwc` before it is used like this:

```javascript
pwc.level = 0   // 'log', 'debug' => all logs

pwc.level = 1   // 'info' => info, warn, and error logs

pwc.level = 2   // 'warn' => warn and error logs

pwc.level = 3   // 'error' => only error logs

pwc.level = -1  // 'none' => no logs

// after setting a custom log level, you can proceed to logging
pwc().blue().log('hi')
```

For custom loggers, a 3rd argument (in addition to the message and css styles object) is passed which is the log level.

Author: bbmoz

README.md

@@ -92,21 +92,38 @@ pwc({ shadow: '4px 4px 5px green' }).large().error('large error msg with green s
 pwc({ weight: 'bold', color: '#00f' }).size(20).log('bold, blue, and 20px msg')
 ```
 
-Have fun with making your logs pretty!
-
 ## Log Levels
 
 * `.log()`
+* `.debug()`
+* `.info()`
 * `.warn()`
 * `.error()`
-* `.info()`
-* `.debug()`
+
+You can configure `pwc` to output logs for only certain levels. By default, the log level is a `0` which also represents `"log"` or `"debug"` which outputs logs from all levels. You can set the log level on `pwc` before it is used like this:
+
+```javascript
+pwc.level = 0   // 'log', 'debug' => all logs
+
+pwc.level = 1   // 'info' => info, warn, and error logs
+
+pwc.level = 2   // 'warn' => warn and error logs
+
+pwc.level = 3   // 'error' => only error logs
+
+pwc.level = -1  // 'none' => no logs
+
+// after setting a custom log level, you can proceed to logging
+pwc().blue().log('hi')
+```
 
 ## Custom Logger
 
 By default, the logger used is the standard browser console. But, you may pass in your own logger if you want.
 
-For example, let's say you have a logger function named `customWarnFn`. You just need to pass it to the log function as the second argument i.e. `pwc().blue().bold().underline().warn('hi', customWarnFn)`. This passes the message and a css styles object as arguments to your custom logger. The styles object for the example would look like this:
+For example, let's say you have a logger function named `customWarnFn`. You just need to pass it to the log function as the second argument i.e. `pwc().blue().bold().underline().warn('hi', customWarnFn)`. This passes the **message**, a **css styles object**, and the **log level** as arguments to your custom logger.
+
+The styles object for the example looks like this:
 
 ```javascript
 {

src/Store.js

@@ -1,12 +1,19 @@
+import getLevel from './getLevel'
+
 class Store {
   constructor () {
     this.style = ''
     this.styleFns = {}
+    this.logLevel = 0
   }
 
   appendStyle (newStyle) {
     this.style += newStyle
   }
+
+  set level (val) {
+    this.logLevel = getLevel(val)
+  }
 }
 
 export default Store

src/getLevel.js

@@ -0,0 +1,29 @@
+import { LOG, DEBUG, INFO, WARN, ERROR, NONE } from './levels'
+
+function getLevel (val) {
+  let level = LOG
+
+  if (typeof val === 'string') {
+    switch (val.toLowerCase()) {
+      case 'debug':
+        level = DEBUG; break
+      case 'info':
+        level = INFO; break
+      case 'warn':
+        level = WARN; break
+      case 'error':
+        level = ERROR; break
+      case 'none':
+        level = NONE; break
+    }
+  } else {
+    const eVal = +val
+    if (eVal >= NONE && eVal <= ERROR) {
+      level = eVal
+    }
+  }
+
+  return level
+}
+
+export default getLevel

src/index.js

@@ -4,6 +4,7 @@ import readConfig from './readConfig'
 
 function pwc (config) {
   const store = new Store()
+  store.level = pwc.level
   if (typeof config === 'object') {
     readConfig(store, config)
   }

src/levels.js

@@ -0,0 +1,3 @@
+const [LOG, DEBUG, INFO, WARN, ERROR, NONE] = [0, 0, 1, 2, 3, -1]
+
+export { LOG, DEBUG, INFO, WARN, ERROR, NONE }

src/loggers.js

@@ -1,33 +1,41 @@
+import getLevel from './getLevel'
+
 function loggers (store) {
-  function out (defaultPrint) {
-    return (val, print) => {
-      if (!print) {
+  function out (defaultPrint, defaultLogLevel) {
+    return (val, print, logLevel) => {
+      if (store.logLevel < 0) return
+
+      if (!print && getLevel(defaultLogLevel) >= store.logLevel) {
         defaultPrint(`%c${val}`, store.style)
-      } else if (print.isSinonProxy) {
-        print(`%c${val}`, store.style)
-      } else {
-        print(val, parse(store.style))
+      } else if (print && getLevel(logLevel) >= store.logLevel) {
+        if (print.isSinonProxy) {
+          print(`%c${val}`, store.style)
+        } else {
+          print(val, parseStyles(store.style), store.logLevel)
+        }
       }
     }
   }
 
-  function parse (styleStr) {
+  function parseStyles (styleStr) {
     const cssMap = {}
     const styles = styleStr.split(';')
+
     styles.slice(0, styles.length - 1)
       .forEach(style => {
         const pair = style.split(':')
         cssMap[pair[0]] = pair[1]
       })
+
     return cssMap
   }
 
   return {
-    log: out(console.log),
-    warn: out(console.warn),
-    error: out(console.error),
-    info: out(console.info),
-    debug: out(console.debug)
+    log: out(console.log, 'log'),
+    debug: out(console.debug, 'debug'),
+    info: out(console.info, 'info'),
+    warn: out(console.warn, 'warn'),
+    error: out(console.error, 'error')
   }
 }
 

src/readConfig.js

@@ -8,41 +8,29 @@ function readConfig (store, config) {
     const val = styleVal in nameMap ? nameMap[styleVal] : styleVal
     switch (styleName) {
       case 'color':
-        appendColor(store, val)
-        break
+        appendColor(store, val); break
       case 'weight':
-        appendWeight(store, val)
-        break
+        appendWeight(store, val); break
       case 'bg':
-        appendBg(store, val)
-        break
+        appendBg(store, val); break
       case 'size':
-        appendSize(store, val)
-        break
+        appendSize(store, val); break
       case 'decorate':
-        appendDecorate(store, val)
-        break
+        appendDecorate(store, val); break
       case 'family':
-        appendFamily(store, val)
-        break
+        appendFamily(store, val); break
       case 'style':
-        appendStyle(store, val)
-        break
+        appendStyle(store, val); break
       case 'transform':
-        appendTransform(store, val)
-        break
+        appendTransform(store, val); break
       case 'shadow':
-        appendShadow(store, val)
-        break
+        appendShadow(store, val); break
       case 'padding':
-        appendPadding(store, val)
-        break
+        appendPadding(store, val); break
       case 'margin':
-        appendMargin(store, val)
-        break
+        appendMargin(store, val); break
       case 'css':
-        appendCss(store, val)
-        break
+        appendCss(store, val); break
     }
   })
 }

test/levels.js

@@ -0,0 +1,133 @@
+import test from 'ava'
+import { spy } from 'sinon'
+import pwc from './../dist/pretty-web-console'
+
+test('pwc.level = "debug"|"log"|0', t => {
+  t.plan(5)
+
+  let logLevel = 'log'
+  pwc().log(logLevel, logSpy, logLevel)
+  t.true(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'debug'
+  pwc().debug(logLevel, logSpy, logLevel)
+  t.true(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'info'
+  pwc().info(logLevel, logSpy, logLevel)
+  t.true(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'warn'
+  pwc().warn(logLevel, logSpy, logLevel)
+  t.true(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'error'
+  pwc().error(logLevel, logSpy, logLevel)
+  t.true(logSpy.calledWith(`%c${logLevel}`))
+})
+
+test('pwc.level = "info"|1', t => {
+  t.plan(5)
+  pwc.level = 'info'
+
+  let logLevel = 'log'
+  pwc().log(logLevel, logSpy, logLevel)
+  t.false(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'debug'
+  pwc().debug(logLevel, logSpy, logLevel)
+  t.false(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'info'
+  pwc().info(logLevel, logSpy, logLevel)
+  t.true(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'warn'
+  pwc().warn(logLevel, logSpy, logLevel)
+  t.true(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'error'
+  pwc().error(logLevel, logSpy, logLevel)
+  t.true(logSpy.calledWith(`%c${logLevel}`))
+})
+
+test('pwc.level = "warn"|2', t => {
+  t.plan(5)
+  pwc.level = 'warn'
+
+  let logLevel = 'log'
+  pwc().log(logLevel, logSpy, logLevel)
+  t.false(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'debug'
+  pwc().debug(logLevel, logSpy, logLevel)
+  t.false(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'info'
+  pwc().info(logLevel, logSpy, logLevel)
+  t.false(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'warn'
+  pwc().warn(logLevel, logSpy, logLevel)
+  t.true(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'error'
+  pwc().error(logLevel, logSpy, logLevel)
+  t.true(logSpy.calledWith(`%c${logLevel}`))
+})
+
+test('pwc.level = "error"|3', t => {
+  t.plan(5)
+  pwc.level = 'error'
+
+  let logLevel = 'log'
+  pwc().log(logLevel, logSpy, logLevel)
+  t.false(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'debug'
+  pwc().debug(logLevel, logSpy, logLevel)
+  t.false(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'info'
+  pwc().info(logLevel, logSpy, logLevel)
+  t.false(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'warn'
+  pwc().warn(logLevel, logSpy, logLevel)
+  t.false(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'error'
+  pwc().error(logLevel, logSpy, logLevel)
+  t.true(logSpy.calledWith(`%c${logLevel}`))
+})
+
+test('pwc.level = "none"|-1', t => {
+  t.plan(5)
+  pwc.level = 'none'
+
+  let logLevel = 'log'
+  pwc().log(logLevel, logSpy, logLevel)
+  t.false(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'debug'
+  pwc().debug(logLevel, logSpy, logLevel)
+  t.false(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'info'
+  pwc().info(logLevel, logSpy, logLevel)
+  t.false(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'warn'
+  pwc().warn(logLevel, logSpy, logLevel)
+  t.false(logSpy.calledWith(`%c${logLevel}`))
+
+  logLevel = 'error'
+  pwc().error(logLevel, logSpy, logLevel)
+  t.false(logSpy.calledWith(`%c${logLevel}`))
+})
+
+let logSpy
+test.beforeEach('setup', () => {
+  logSpy = spy()
+  pwc.level = 0
+})