feat: custom logger

BREAKING CHANGE: console is replaced by consola by default

Author: pooya parsa

README.md

@@ -33,6 +33,8 @@ export default class Foo extends Hookable {
   constructor() {
     // Call to parent to initialize
     super()
+    // Initialize Hookable with custom logger
+    // super(consola)
   }
 
   async someFunction() {
@@ -62,6 +64,15 @@ lib.hookObj({
 
 ## Hookable class
 
+### `constructor(logger)`
+
+Custom logger. Default logger is `console` but you can use your own or [consola](https://github.com/nuxt/consola).
+
+It should be an object implementing following functions:
+- log
+- warn
+- error
+- debug
 
 ### `hook (name, fn)`
 

lib/hookable.js

@@ -1,8 +1,8 @@
-const consola = require('consola')
 const { serial, flatHooks } = require('./utils')
 
 module.exports = class Hookable {
-  constructor () {
+  constructor (logger = console) {
+    this.logger = logger
     this._hooks = {}
     this._deprecatedHooks = {}
 
@@ -16,7 +16,7 @@ module.exports = class Hookable {
     }
 
     if (this._deprecatedHooks[name]) {
-      consola.warn(`${name} hook has been deprecated, please use ${this._deprecatedHooks[name]}`)
+      this.logger.warn(`${name} hook has been deprecated, please use ${this._deprecatedHooks[name]}`)
       name = this._deprecatedHooks[name]
     }
 
@@ -43,7 +43,7 @@ module.exports = class Hookable {
       await serial(this._hooks[name], fn => fn(...args))
     } catch (err) {
       name !== 'error' && await this.callHook('error', err)
-      consola.error(err)
+      this.logger.error(err)
     }
   }
 

package.json

@@ -26,9 +26,6 @@
     "prepublish": "yarn test",
     "release": "standard-version && git push --follow-tags && npm publish"
   },
-  "dependencies": {
-    "consola": "^2.4.0"
-  },
   "devDependencies": {
     "codecov": "^3.0.0",
     "eslint": "^5.13.0",

test/hookable.test.js

@@ -1,10 +1,11 @@
-const consola = require('consola')
 const Hookable = require('..')
 const { flatHooks } = require('../lib/utils')
 
 describe('core: hookable', () => {
   beforeEach(() => {
-    consola.mockTypes(() => jest.fn())
+    ['log', 'warn', 'error', 'debug'].forEach(l => {
+      console[l] = jest.fn()
+    })
   })
 
   test('should construct hook object', () => {
@@ -51,26 +52,26 @@ describe('core: hookable', () => {
 
     hook.hook('test:hook', () => { })
 
-    expect(consola.warn).toBeCalledWith('test:hook hook has been deprecated, please use test:before')
+    expect(console.warn).toBeCalledWith('test:hook hook has been deprecated, please use test:before')
     expect(hook._hooks['test:hook']).toBeUndefined()
     expect(hook._hooks['test:before']).toEqual([expect.any(Function)])
   })
 
   test('should call registered hook', async () => {
     const hook = new Hookable()
-    hook.hook('test:hook', () => consola.log('test:hook called'))
+    hook.hook('test:hook', () => console.log('test:hook called'))
 
     await hook.callHook('test:hook')
 
-    expect(consola.log).toBeCalledWith('test:hook called')
+    expect(console.log).toBeCalledWith('test:hook called')
   })
 
   test('should ignore unregistered hook', async () => {
     const hook = new Hookable()
 
     await hook.callHook('test:hook')
 
-    expect(consola.debug).not.toBeCalled()
+    expect(console.debug).not.toBeCalled()
   })
 
   test('should report hook error', async () => {
@@ -80,7 +81,7 @@ describe('core: hookable', () => {
 
     await hook.callHook('test:hook')
 
-    expect(consola.error).toBeCalledWith(error)
+    expect(console.error).toBeCalledWith(error)
   })
 
   test('should call error hook', async () => {
@@ -92,7 +93,7 @@ describe('core: hookable', () => {
     await hook.callHook('test:hook')
 
     expect(hook._hooks.error[0]).toBeCalledWith(error)
-    expect(consola.error).toBeCalledWith(error)
+    expect(console.error).toBeCalledWith(error)
   })
 
   test('should clear registered hooks', () => {

yarn.lock

@@ -845,11 +845,6 @@ concat-stream@^1.6.0:
     readable-stream "^2.2.2"
     typedarray "^0.0.6"
 
-consola@^2.4.0:
-  version "2.5.6"
-  resolved "https://registry.yarnpkg.com/consola/-/consola-2.5.6.tgz#5ce14dbaf6f5b589c8a258ef80ed97b752fa57d5"
-  integrity sha512-DN0j6ewiNWkT09G3ZoyyzN3pSYrjxWcx49+mHu+oDI5dvW5vzmyuzYsqGS79+yQserH9ymJQbGzeqUejfssr8w==
-
 contains-path@^0.1.0:
   version "0.1.0"
   resolved "https://registry.yarnpkg.com/contains-path/-/contains-path-0.1.0.tgz#fe8cf184ff6670b6baef01a9d4861a5cbec4120a"
@@ -2302,11 +2297,6 @@ istanbul-reports@^2.1.1:
   dependencies:
     handlebars "^4.1.0"
 
-items-promise@^1.0.0:
-  version "1.0.0"
-  resolved "https://registry.yarnpkg.com/items-promise/-/items-promise-1.0.0.tgz#a71ff03063078eb82db468f1e2f12df4da34dc01"
-  integrity sha512-t+3w4E51IlviTn1b/gesEsH9Jf0gEs2+VhSbwgMaVyK2IxXYSwZkL6sOmr+FBhMT0sSFzcc4Rn5X7sz6NvS2GQ==
-
 jest-changed-files@^24.5.0:
   version "24.5.0"
   resolved "https://registry.yarnpkg.com/jest-changed-files/-/jest-changed-files-24.5.0.tgz#4075269ee115d87194fd5822e642af22133cf705"