hookable 5.4.2 → 5.5.1

package/README.md

@@ -2,11 +2,11 @@
 
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![packagephobia][packagephobia-src]][packagephobia-href]
-[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
+[![bundle][bundle-src]][bundle-href]
 [![Codecov][codecov-src]][codecov-href]
+[![License][license-src]][license-href]
 
-> Awaitable hook system
+Awaitable hooks system.
 
 ## Install
 
@@ -255,17 +255,13 @@ Thanks to [Joe Paice](https://github.com/RGBboy) for donating [hookable](https:/
 MIT - Made with 💖
 
 <!-- Badges -->
-[npm-version-src]: https://flat.badgen.net/npm/dt/hookable
+[npm-version-src]: https://img.shields.io/npm/v/hookable?style=flat&colorA=18181B&colorB=F0DB4F
 [npm-version-href]: https://npmjs.com/package/hookable
-
-[npm-downloads-src]: https://flat.badgen.net/npm/v/hookable
+[npm-downloads-src]: https://img.shields.io/npm/dm/hookable?style=flat&colorA=18181B&colorB=F0DB4F
 [npm-downloads-href]: https://npmjs.com/package/hookable
-
-[github-actions-ci-src]: https://flat.badgen.net/github/checks/unjs/hookable/main
-[github-actions-ci-href]: https://github.com/unjs/hookable/actions
-
-[codecov-src]: https://flat.badgen.net/codecov/c/github/unjs/hookable
-[codecov-href]: https://codecov.io/gh/unjs/hookable
-
-[packagephobia-src]: https://flat.badgen.net/packagephobia/install/hookable
-[packagephobia-href]: https://packagephobia.now.sh/result?p=hookable
+[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/hookable/main?style=flat&colorA=18181B&colorB=F0DB4F
+[codecov-href]: https://codecov.io/gh/unjs/h3
+[bundle-src]: https://img.shields.io/bundlephobia/minzip/hookable?style=flat&colorA=18181B&colorB=F0DB4F
+[bundle-href]: https://bundlephobia.com/result?p=hookable
+[license-src]: https://img.shields.io/github/license/unjs/hookable.svg?style=flat&colorA=18181B&colorB=F0DB4F
+[license-href]: https://github.com/unjs/hookable/blob/main/LICENSE

package/dist/index.cjs

@@ -35,17 +35,39 @@ function mergeHooks(...hooks) {
   return finalHooks;
 }
 function serial(tasks, function_) {
-  return tasks.reduce((promise, task) => promise.then(() => function_(task)), Promise.resolve());
+  return tasks.reduce(
+    (promise, task) => promise.then(() => function_(task)),
+    Promise.resolve()
+  );
+}
+const defaultTask = { run: (function_) => function_() };
+const _createTask = () => defaultTask;
+const createTask = typeof console.createTask !== "undefined" ? console.createTask : _createTask;
+function serialTaskCaller(hooks, args) {
+  const name = args.shift();
+  const task = createTask(name);
+  return hooks.reduce(
+    (promise, hookFunction) => promise.then(() => task.run(() => hookFunction(...args))),
+    Promise.resolve()
+  );
+}
+function parallelTaskCaller(hooks, args) {
+  const name = args.shift();
+  const task = createTask(name);
+  return Promise.all(hooks.map((hook) => task.run(() => hook(...args))));
 }
 function serialCaller(hooks, arguments_) {
-  return hooks.reduce((promise, hookFunction) => promise.then(() => hookFunction.apply(void 0, arguments_)), Promise.resolve());
+  return hooks.reduce(
+    (promise, hookFunction) => promise.then(() => hookFunction(...arguments_)),
+    Promise.resolve()
+  );
 }
-function parallelCaller(hooks, arguments_) {
-  return Promise.all(hooks.map((hook) => hook.apply(void 0, arguments_)));
+function parallelCaller(hooks, args) {
+  return Promise.all(hooks.map((hook) => hook(...args)));
 }
-function callEachWith(callbacks, argument0) {
+function callEachWith(callbacks, arg0) {
   for (const callback of callbacks) {
-    callback(argument0);
+    callback(arg0);
   }
 }
 
@@ -84,6 +106,15 @@ class Hookable {
         this._deprecatedMessages.add(message);
       }
     }
+    if (!function_.name) {
+      try {
+        Object.defineProperty(function_, "name", {
+          get: () => "_" + name.replace(/\W+/g, "_") + "_hook_cb",
+          configurable: true
+        });
+      } catch {
+      }
+    }
     this._hooks[name] = this._hooks[name] || [];
     this._hooks[name].push(function_);
     return () => {
@@ -133,7 +164,9 @@ class Hookable {
   }
   addHooks(configHooks) {
     const hooks = flatHooks(configHooks);
-    const removeFns = Object.keys(hooks).map((key) => this.hook(key, hooks[key]));
+    const removeFns = Object.keys(hooks).map(
+      (key) => this.hook(key, hooks[key])
+    );
     return () => {
       for (const unreg of removeFns.splice(0, removeFns.length)) {
         unreg();
@@ -146,11 +179,18 @@ class Hookable {
       this.removeHook(key, hooks[key]);
     }
   }
+  removeAllHooks() {
+    for (const key in this._hooks) {
+      delete this._hooks[key];
+    }
+  }
   callHook(name, ...arguments_) {
-    return this.callHookWith(serialCaller, name, ...arguments_);
+    arguments_.unshift(name);
+    return this.callHookWith(serialTaskCaller, name, ...arguments_);
   }
   callHookParallel(name, ...arguments_) {
-    return this.callHookWith(parallelCaller, name, ...arguments_);
+    arguments_.unshift(name);
+    return this.callHookWith(parallelTaskCaller, name, ...arguments_);
   }
   callHookWith(caller, name, ...arguments_) {
     const event = this._before || this._after ? { name, args: arguments_, context: {} } : void 0;
@@ -234,6 +274,7 @@ function createDebugger(hooks, _options = {}) {
     _idCtr[event.name]--;
   });
   return {
+    /** Stop debugging and remove listeners */
     close: () => {
       unsubscribeBefore();
       unsubscribeAfter();

package/dist/index.d.ts

@@ -1,42 +1,42 @@
-declare type HookCallback = (...arguments_: any) => Promise<void> | void;
+type HookCallback = (...arguments_: any) => Promise<void> | void;
 interface Hooks {
     [key: string]: HookCallback;
 }
-declare type HookKeys<T> = keyof T & string;
-declare type DeprecatedHook<T> = {
+type HookKeys<T> = keyof T & string;
+type DeprecatedHook<T> = {
     message?: string;
     to: HookKeys<T>;
 };
-declare type DeprecatedHooks<T> = {
+type DeprecatedHooks<T> = {
     [name in HookKeys<T>]: DeprecatedHook<T>;
 };
-declare type ValueOf<C> = C extends Record<any, any> ? C[keyof C] : never;
-declare type Strings<T> = Exclude<keyof T, number | symbol>;
-declare type KnownKeys<T> = keyof {
+type ValueOf<C> = C extends Record<any, any> ? C[keyof C] : never;
+type Strings<T> = Exclude<keyof T, number | symbol>;
+type KnownKeys<T> = keyof {
     [K in keyof T as string extends K ? never : number extends K ? never : K]: never;
 };
-declare type StripGeneric<T> = Pick<T, KnownKeys<T> extends keyof T ? KnownKeys<T> : never>;
-declare type OnlyGeneric<T> = Omit<T, KnownKeys<T> extends keyof T ? KnownKeys<T> : never>;
-declare type Namespaces<T> = ValueOf<{
+type StripGeneric<T> = Pick<T, KnownKeys<T> extends keyof T ? KnownKeys<T> : never>;
+type OnlyGeneric<T> = Omit<T, KnownKeys<T> extends keyof T ? KnownKeys<T> : never>;
+type Namespaces<T> = ValueOf<{
     [key in Strings<T>]: key extends `${infer Namespace}:${string}` ? Namespace : never;
 }>;
-declare type BareHooks<T> = ValueOf<{
+type BareHooks<T> = ValueOf<{
     [key in Strings<T>]: key extends `${string}:${string}` ? never : key;
 }>;
-declare type HooksInNamespace<T, Namespace extends string> = ValueOf<{
+type HooksInNamespace<T, Namespace extends string> = ValueOf<{
     [key in Strings<T>]: key extends `${Namespace}:${infer HookName}` ? HookName : never;
 }>;
-declare type WithoutNamespace<T, Namespace extends string> = {
+type WithoutNamespace<T, Namespace extends string> = {
     [key in HooksInNamespace<T, Namespace>]: `${Namespace}:${key}` extends keyof T ? T[`${Namespace}:${key}`] : never;
 };
-declare type NestedHooks<T> = (Partial<StripGeneric<T>> | Partial<OnlyGeneric<T>>) & Partial<{
+type NestedHooks<T> = (Partial<StripGeneric<T>> | Partial<OnlyGeneric<T>>) & Partial<{
     [key in Namespaces<StripGeneric<T>>]: NestedHooks<WithoutNamespace<T, key>>;
 }> & Partial<{
     [key in BareHooks<StripGeneric<T>>]: T[key];
 }>;
 
-declare type InferCallback<HT, HN extends keyof HT> = HT[HN] extends HookCallback ? HT[HN] : never;
-declare type InferSpyEvent<HT extends Record<string, any>> = {
+type InferCallback<HT, HN extends keyof HT> = HT[HN] extends HookCallback ? HT[HN] : never;
+type InferSpyEvent<HT extends Record<string, any>> = {
     [key in keyof HT]: {
         name: key;
         args: Parameters<HT[key]>;
@@ -59,6 +59,7 @@ declare class Hookable<HooksT = Record<string, HookCallback>, HookNameT extends
     deprecateHooks(deprecatedHooks: Partial<Record<HookNameT, DeprecatedHook<HooksT>>>): void;
     addHooks(configHooks: NestedHooks<HooksT>): () => void;
     removeHooks(configHooks: NestedHooks<HooksT>): void;
+    removeAllHooks(): void;
     callHook<NameT extends HookNameT>(name: NameT, ...arguments_: Parameters<InferCallback<HooksT, NameT>>): Promise<any>;
     callHookParallel<NameT extends HookNameT>(name: NameT, ...arguments_: Parameters<InferCallback<HooksT, NameT>>): Promise<any[]>;
     callHookWith<NameT extends HookNameT, CallFunction extends (hooks: HookCallback[], arguments_: Parameters<InferCallback<HooksT, NameT>>) => any>(caller: CallFunction, name: NameT, ...arguments_: Parameters<InferCallback<HooksT, NameT>>): ReturnType<CallFunction>;
@@ -70,8 +71,10 @@ declare function createHooks<T>(): Hookable<T>;
 declare function flatHooks<T>(configHooks: NestedHooks<T>, hooks?: T, parentName?: string): T;
 declare function mergeHooks<T>(...hooks: NestedHooks<T>[]): T;
 declare function serial<T>(tasks: T[], function_: (task: T) => Promise<any> | any): Promise<any>;
-declare function serialCaller(hooks: HookCallback[], arguments_?: any[]): Promise<any>;
-declare function parallelCaller(hooks: HookCallback[], arguments_?: any[]): Promise<any[]>;
+/** @deprecated */
+declare function serialCaller(hooks: HookCallback[], arguments_?: any[]): Promise<void>;
+/** @deprecated */
+declare function parallelCaller(hooks: HookCallback[], args?: any[]): Promise<void[]>;
 
 interface CreateDebuggerOptions {
     /** An optional tag to prefix console logs with */

package/dist/index.mjs

@@ -33,17 +33,39 @@ function mergeHooks(...hooks) {
   return finalHooks;
 }
 function serial(tasks, function_) {
-  return tasks.reduce((promise, task) => promise.then(() => function_(task)), Promise.resolve());
+  return tasks.reduce(
+    (promise, task) => promise.then(() => function_(task)),
+    Promise.resolve()
+  );
+}
+const defaultTask = { run: (function_) => function_() };
+const _createTask = () => defaultTask;
+const createTask = typeof console.createTask !== "undefined" ? console.createTask : _createTask;
+function serialTaskCaller(hooks, args) {
+  const name = args.shift();
+  const task = createTask(name);
+  return hooks.reduce(
+    (promise, hookFunction) => promise.then(() => task.run(() => hookFunction(...args))),
+    Promise.resolve()
+  );
+}
+function parallelTaskCaller(hooks, args) {
+  const name = args.shift();
+  const task = createTask(name);
+  return Promise.all(hooks.map((hook) => task.run(() => hook(...args))));
 }
 function serialCaller(hooks, arguments_) {
-  return hooks.reduce((promise, hookFunction) => promise.then(() => hookFunction.apply(void 0, arguments_)), Promise.resolve());
+  return hooks.reduce(
+    (promise, hookFunction) => promise.then(() => hookFunction(...arguments_)),
+    Promise.resolve()
+  );
 }
-function parallelCaller(hooks, arguments_) {
-  return Promise.all(hooks.map((hook) => hook.apply(void 0, arguments_)));
+function parallelCaller(hooks, args) {
+  return Promise.all(hooks.map((hook) => hook(...args)));
 }
-function callEachWith(callbacks, argument0) {
+function callEachWith(callbacks, arg0) {
   for (const callback of callbacks) {
-    callback(argument0);
+    callback(arg0);
   }
 }
 
@@ -82,6 +104,15 @@ class Hookable {
         this._deprecatedMessages.add(message);
       }
     }
+    if (!function_.name) {
+      try {
+        Object.defineProperty(function_, "name", {
+          get: () => "_" + name.replace(/\W+/g, "_") + "_hook_cb",
+          configurable: true
+        });
+      } catch {
+      }
+    }
     this._hooks[name] = this._hooks[name] || [];
     this._hooks[name].push(function_);
     return () => {
@@ -131,7 +162,9 @@ class Hookable {
   }
   addHooks(configHooks) {
     const hooks = flatHooks(configHooks);
-    const removeFns = Object.keys(hooks).map((key) => this.hook(key, hooks[key]));
+    const removeFns = Object.keys(hooks).map(
+      (key) => this.hook(key, hooks[key])
+    );
     return () => {
       for (const unreg of removeFns.splice(0, removeFns.length)) {
         unreg();
@@ -144,11 +177,18 @@ class Hookable {
       this.removeHook(key, hooks[key]);
     }
   }
+  removeAllHooks() {
+    for (const key in this._hooks) {
+      delete this._hooks[key];
+    }
+  }
   callHook(name, ...arguments_) {
-    return this.callHookWith(serialCaller, name, ...arguments_);
+    arguments_.unshift(name);
+    return this.callHookWith(serialTaskCaller, name, ...arguments_);
   }
   callHookParallel(name, ...arguments_) {
-    return this.callHookWith(parallelCaller, name, ...arguments_);
+    arguments_.unshift(name);
+    return this.callHookWith(parallelTaskCaller, name, ...arguments_);
   }
   callHookWith(caller, name, ...arguments_) {
     const event = this._before || this._after ? { name, args: arguments_, context: {} } : void 0;
@@ -232,6 +272,7 @@ function createDebugger(hooks, _options = {}) {
     _idCtr[event.name]--;
   });
   return {
+    /** Stop debugging and remove listeners */
     close: () => {
       unsubscribeBefore();
       unsubscribeAfter();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hookable",
-  "version": "5.4.2",
+  "version": "5.5.1",
   "description": "Awaitable hook system",
   "keywords": [
     "hook",
@@ -23,22 +23,25 @@
     "dist"
   ],
   "devDependencies": {
-    "@vitest/coverage-c8": "^0.25.2",
-    "eslint": "^8.27.0",
-    "eslint-config-unjs": "^0.0.2",
+    "@types/node": "^18.15.0",
+    "@vitest/coverage-c8": "^0.29.2",
+    "changelogen": "^0.5.1",
+    "eslint": "^8.35.0",
+    "eslint-config-unjs": "^0.1.0",
     "expect-type": "^0.15.0",
-    "standard-version": "^9.5.0",
-    "typescript": "^4.8.4",
-    "unbuild": "^0.9.4",
-    "vitest": "^0.25.2"
+    "prettier": "^2.8.4",
+    "typescript": "^4.9.5",
+    "unbuild": "^1.1.2",
+    "vitest": "^0.29.2"
   },
-  "packageManager": "pnpm@7.16.0",
+  "packageManager": "pnpm@7.29.1",
   "scripts": {
     "build": "unbuild",
     "dev": "vitest",
-    "lint": "eslint --ext .ts src",
+    "lint": "eslint --cache --ext .ts,.js,.mjs,.cjs . && prettier -c src test",
+    "lint:fix": "eslint --cache --ext .ts,.js,.mjs,.cjs . --fix && prettier -c src test -w",
     "prepublish": "pnpm build",
-    "release": "pnpm test && pnpm build && standard-version && git push --follow-tags && pnpm publish",
+    "release": "pnpm test && pnpm build && changelogen --release --push && pnpm publish",
     "test": "pnpm lint && vitest run --coverage",
     "test:types": "tsc --noEmit"
   }