hookable 5.3.0 → 5.4.1

package/README.md

@@ -220,6 +220,19 @@ hookable.hook('test', () => { console.log('running test hook') })
 await hookable.callHook('test')
 ```
 
+### `createDebugger`
+
+Automatically logs each hook that is called and how long it takes to run.
+
+```js
+const debug = hookable.createDebugger(hooks, { tag: 'something' })
+
+hooks.callHook('some-hook', 'some-arg')
+// [something] some-hook: 0.21ms
+
+debug.close()
+```
+
 ## Migration
 
 ### From `4.x` to `5.x`

package/dist/index.cjs

@@ -158,12 +158,12 @@ class Hookable {
     const result = caller(this._hooks[name] || [], args);
     if (result instanceof Promise) {
       return result.finally(() => {
-        if (this._after) {
+        if (this._after && event) {
           callEachWith(this._after, event);
         }
       });
     }
-    if (this._after) {
+    if (this._after && event) {
       callEachWith(this._after, event);
     }
     return result;
@@ -171,17 +171,76 @@ class Hookable {
   beforeEach(fn) {
     this._before = this._before || [];
     this._before.push(fn);
+    return () => {
+      const index = this._before.indexOf(fn);
+      if (index !== -1) {
+        this._before.splice(index, 1);
+      }
+    };
   }
   afterEach(fn) {
     this._after = this._after || [];
     this._after.push(fn);
+    return () => {
+      const index = this._after.indexOf(fn);
+      if (index !== -1) {
+        this._after.splice(index, 1);
+      }
+    };
   }
 }
 function createHooks() {
   return new Hookable();
 }
 
+const isBrowser = typeof window !== "undefined";
+function createDebugger(hooks, _options = {}) {
+  const options = {
+    inspect: isBrowser,
+    group: isBrowser,
+    filter: () => true,
+    ..._options
+  };
+  const _filter = options.filter;
+  const filter = typeof _filter === "string" ? (name) => name.startsWith(_filter) : _filter;
+  const _tag = options.tag ? `[${options.tag}] ` : "";
+  const logPrefix = (event) => _tag + event.name + "".padEnd(event._id, "\0");
+  const _idCtr = {};
+  const unsubscribeBefore = hooks.beforeEach((event) => {
+    if (!filter(event.name)) {
+      return;
+    }
+    _idCtr[event.name] = _idCtr[event.name] || 0;
+    event._id = _idCtr[event.name]++;
+    console.time(logPrefix(event));
+  });
+  const unsubscribeAfter = hooks.afterEach((event) => {
+    if (!filter(event.name)) {
+      return;
+    }
+    if (options.group) {
+      console.groupCollapsed(event.name);
+    }
+    if (options.inspect) {
+      console.timeLog(logPrefix(event), event.args);
+    } else {
+      console.timeEnd(logPrefix(event));
+    }
+    if (options.group) {
+      console.groupEnd();
+    }
+    _idCtr[event.name]--;
+  });
+  return {
+    close: () => {
+      unsubscribeBefore();
+      unsubscribeAfter();
+    }
+  };
+}
+
 exports.Hookable = Hookable;
+exports.createDebugger = createDebugger;
 exports.createHooks = createHooks;
 exports.flatHooks = flatHooks;
 exports.mergeHooks = mergeHooks;

package/dist/index.d.ts

@@ -62,8 +62,8 @@ declare class Hookable<HooksT = Record<string, HookCallback>, HookNameT extends
     callHook<NameT extends HookNameT>(name: NameT, ...args: Parameters<InferCallback<HooksT, NameT>>): Promise<any>;
     callHookParallel<NameT extends HookNameT>(name: NameT, ...args: Parameters<InferCallback<HooksT, NameT>>): Promise<any[]>;
     callHookWith<NameT extends HookNameT, CallFunction extends (hooks: HookCallback[], args: Parameters<InferCallback<HooksT, NameT>>) => any>(caller: CallFunction, name: NameT, ...args: Parameters<InferCallback<HooksT, NameT>>): ReturnType<CallFunction>;
-    beforeEach(fn: (event: InferSpyEvent<HooksT>) => void): void;
-    afterEach(fn: (event: InferSpyEvent<HooksT>) => void): void;
+    beforeEach(fn: (event: InferSpyEvent<HooksT>) => void): () => void;
+    afterEach(fn: (event: InferSpyEvent<HooksT>) => void): () => void;
 }
 declare function createHooks<T>(): Hookable<T>;
 
@@ -73,4 +73,28 @@ declare function serial<T>(tasks: T[], fn: (task: T) => Promise<any> | any): Pro
 declare function serialCaller(hooks: HookCallback[], args?: any[]): Promise<any>;
 declare function parallelCaller(hooks: HookCallback[], args?: any[]): Promise<any[]>;
 
-export { DeprecatedHook, DeprecatedHooks, HookCallback, HookKeys, Hookable, Hooks, NestedHooks, createHooks, flatHooks, mergeHooks, parallelCaller, serial, serialCaller };
+interface CreateDebuggerOptions {
+    /** An optional tag to prefix console logs with */
+    tag?: string;
+    /**
+     * Show hook params to the console output
+     *
+     * Enabled for browsers by default
+     */
+    inspect?: boolean;
+    /**
+     * Use group/groupEnd wrapper around logs happening during a specific hook
+     *
+     * Enabled for browsers by default
+     */
+    group?: boolean;
+    /** Filter which hooks to enable debugger for. Can be a string prefix or fn. */
+    filter?: string | ((event: string) => boolean);
+}
+/** Start debugging hook names and timing in console */
+declare function createDebugger(hooks: Hookable<any>, _options?: CreateDebuggerOptions): {
+    /** Stop debugging and remove listeners */
+    close: () => void;
+};
+
+export { CreateDebuggerOptions, DeprecatedHook, DeprecatedHooks, HookCallback, HookKeys, Hookable, Hooks, NestedHooks, createDebugger, createHooks, flatHooks, mergeHooks, parallelCaller, serial, serialCaller };

package/dist/index.mjs

@@ -154,12 +154,12 @@ class Hookable {
     const result = caller(this._hooks[name] || [], args);
     if (result instanceof Promise) {
       return result.finally(() => {
-        if (this._after) {
+        if (this._after && event) {
           callEachWith(this._after, event);
         }
       });
     }
-    if (this._after) {
+    if (this._after && event) {
       callEachWith(this._after, event);
     }
     return result;
@@ -167,14 +167,72 @@ class Hookable {
   beforeEach(fn) {
     this._before = this._before || [];
     this._before.push(fn);
+    return () => {
+      const index = this._before.indexOf(fn);
+      if (index !== -1) {
+        this._before.splice(index, 1);
+      }
+    };
   }
   afterEach(fn) {
     this._after = this._after || [];
     this._after.push(fn);
+    return () => {
+      const index = this._after.indexOf(fn);
+      if (index !== -1) {
+        this._after.splice(index, 1);
+      }
+    };
   }
 }
 function createHooks() {
   return new Hookable();
 }
 
-export { Hookable, createHooks, flatHooks, mergeHooks, parallelCaller, serial, serialCaller };
+const isBrowser = typeof window !== "undefined";
+function createDebugger(hooks, _options = {}) {
+  const options = {
+    inspect: isBrowser,
+    group: isBrowser,
+    filter: () => true,
+    ..._options
+  };
+  const _filter = options.filter;
+  const filter = typeof _filter === "string" ? (name) => name.startsWith(_filter) : _filter;
+  const _tag = options.tag ? `[${options.tag}] ` : "";
+  const logPrefix = (event) => _tag + event.name + "".padEnd(event._id, "\0");
+  const _idCtr = {};
+  const unsubscribeBefore = hooks.beforeEach((event) => {
+    if (!filter(event.name)) {
+      return;
+    }
+    _idCtr[event.name] = _idCtr[event.name] || 0;
+    event._id = _idCtr[event.name]++;
+    console.time(logPrefix(event));
+  });
+  const unsubscribeAfter = hooks.afterEach((event) => {
+    if (!filter(event.name)) {
+      return;
+    }
+    if (options.group) {
+      console.groupCollapsed(event.name);
+    }
+    if (options.inspect) {
+      console.timeLog(logPrefix(event), event.args);
+    } else {
+      console.timeEnd(logPrefix(event));
+    }
+    if (options.group) {
+      console.groupEnd();
+    }
+    _idCtr[event.name]--;
+  });
+  return {
+    close: () => {
+      unsubscribeBefore();
+      unsubscribeAfter();
+    }
+  };
+}
+
+export { Hookable, createDebugger, createHooks, flatHooks, mergeHooks, parallelCaller, serial, serialCaller };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hookable",
-  "version": "5.3.0",
+  "version": "5.4.1",
   "description": "Awaitable hook system",
   "keywords": [
     "hook",
@@ -22,16 +22,16 @@
     "dist"
   ],
   "devDependencies": {
-    "@nuxtjs/eslint-config-typescript": "latest",
-    "@vitest/coverage-c8": "^0.22.1",
-    "eslint": "latest",
-    "expect-type": "^0.13.0",
-    "standard-version": "latest",
+    "@nuxtjs/eslint-config-typescript": "^11.0.0",
+    "@vitest/coverage-c8": "^0.24.3",
+    "eslint": "^8.25.0",
+    "expect-type": "^0.14.2",
+    "standard-version": "^9.5.0",
     "typescript": "latest",
-    "unbuild": "latest",
-    "vitest": "latest"
+    "unbuild": "^0.8.2",
+    "vitest": "^0.24.3"
   },
-  "packageManager": "pnpm@7.9.4",
+  "packageManager": "pnpm@7.13.4",
   "scripts": {
     "build": "unbuild",
     "dev": "vitest",