feat: allow registering a hook without showing deprecated message

unjs · Sep 2, 2022 · 0fcd787 · 0fcd787
1 parent 526e4dc
commit 0fcd787
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/src/hookable.ts b/src/hookable.ts
@@ -29,7 +29,7 @@ export class Hookable <
     this.callHookWith = this.callHookWith.bind(this)
   }
 
-  hook<NameT extends HookNameT> (name: NameT, fn: InferCallback<HooksT, NameT>) {
+  hook<NameT extends HookNameT> (name: NameT, fn: InferCallback<HooksT, NameT>, opts: { allowDeprecated?: boolean } = {}) {
     if (!name || typeof fn !== 'function') {
       return () => {}
     }
@@ -40,7 +40,7 @@ export class Hookable <
       dep = this._deprecatedHooks[name]
       name = dep.to as NameT
     }
-    if (dep) {
+    if (dep && !opts.allowDeprecated) {
       let message = dep.message
       if (!message) {
         message = `${originalName} hook has been deprecated` +

diff --git a/test/hookable.test.ts b/test/hookable.test.ts
@@ -73,6 +73,13 @@ describe('core: hookable', () => {
     ])
   })
 
+  test('allow hiding deprecation warns', () => {
+    const hook = createHooks()
+    hook.deprecateHook('a', 'b')
+    hook.hook('a', () => {}, { allowDeprecated: true })
+    expect(console.warn).toBeCalledTimes(0)
+  })
+
   test('should handle deprecation after registering', () => {
     const hook = createHooks()
     hook.hook('a', () => { })