feat: hooks

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

README.md

@@ -44,6 +44,12 @@ const config = [
       'sort-keys': 0
     }
   },
+  {
+    files: ['src/internal/__tests__/is-promise.spec.mts'],
+    rules: {
+      'unicorn/no-thenable': 0
+    }
+  },
   {
     files: ['src/lib/command.mts'],
     rules: {

eslint.config.mjs

@@ -0,0 +1,23 @@
+/**
+ * @file Enums - hooks
+ * @module kronk/enums/hooks
+ */
+
+import type { KronkHookName } from '@flex-development/kronk'
+
+/**
+ * Default hook names.
+ *
+ * @see {@linkcode KronkHookName}
+ *
+ * @internal
+ *
+ * @enum {KronkHookName}
+ */
+const enum hooks {
+  postAction = 'postAction',
+  preAction = 'preAction',
+  preCommand = 'preCommand'
+}
+
+export default hooks

src/enums/hooks.mts

@@ -15,6 +15,7 @@ import type {
   HelpCommandData,
   HelpOptionData,
   HelpTextOptions,
+  HooksData,
   List,
   OptionPriority,
   OptionsData,
@@ -59,12 +60,6 @@ describe('unit-d:interfaces/CommandData', () => {
       .toEqualTypeOf<Nilable<boolean>>()
   })
 
-  it('should match [done?: Action<any> | null | undefined]', () => {
-    expectTypeOf<TestSubject>()
-      .toHaveProperty('done')
-      .toEqualTypeOf<Nilable<Action<any>>>()
-  })
-
   it('should match [examples?: ExamplesData | null | undefined]', () => {
     expectTypeOf<TestSubject>()
       .toHaveProperty('examples')
@@ -95,6 +90,12 @@ describe('unit-d:interfaces/CommandData', () => {
       .toEqualTypeOf<Nilable<HelpOptionData>>()
   })
 
+  it('should match [hooks?: HooksData | null | undefined]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('hooks')
+      .toEqualTypeOf<Nilable<HooksData>>()
+  })
+
   it('should match [optionPriority?: OptionPriority | null | undefined]', () => {
     expectTypeOf<TestSubject>()
       .toHaveProperty('optionPriority')

src/interfaces/__tests__/command.data.spec-d.mts

@@ -8,11 +8,13 @@ import type {
   default as TestSubject
 } from '#interfaces/command.metadata'
 import type {
+  Action,
   Argument,
   Command,
   CommandInfo,
   ExampleInfo,
   Help,
+  HooksInfo,
   Option,
   VersionOption
 } from '@flex-development/kronk'
@@ -27,6 +29,12 @@ describe('unit-d:interfaces/CommandMetadata', () => {
     expectTypeOf<TestSubject>().toExtend<Expect>()
   })
 
+  it('should match [action: Action<any>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('action')
+      .toEqualTypeOf<Action<any>>()
+  })
+
   it('should match [aliases: Set<string>]', () => {
     expectTypeOf<TestSubject>()
       .toHaveProperty('aliases')
@@ -63,6 +71,12 @@ describe('unit-d:interfaces/CommandMetadata', () => {
       .toEqualTypeOf<Nilable<Option>>()
   })
 
+  it('should match [hooks: HooksInfo]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('hooks')
+      .toEqualTypeOf<HooksInfo>()
+  })
+
   it('should match [options: Map<string, Option>]', () => {
     expectTypeOf<TestSubject>()
       .toHaveProperty('options')

src/interfaces/__tests__/command.metadata.spec-d.mts

@@ -0,0 +1,37 @@
+/**
+ * @file Type Tests - HooksData
+ * @module kronk/interfaces/tests/unit-d/HooksData
+ */
+
+import type TestSubject from '#interfaces/hooks.data'
+import type {
+  List,
+  PostActionHook,
+  PreActionHook,
+  PreCommandHook
+} from '@flex-development/kronk'
+import type { Nilable, OptionalKeys } from '@flex-development/tutils'
+
+describe('unit-d:interfaces/HooksData', () => {
+  it('should have all optional keys', () => {
+    expectTypeOf<OptionalKeys<TestSubject>>().toEqualTypeOf<keyof TestSubject>()
+  })
+
+  it('should match [postAction?: PostActionHook | List<PostActionHook> | null | undefined]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('postAction')
+      .toEqualTypeOf<Nilable<PostActionHook | List<PostActionHook>>>()
+  })
+
+  it('should match [preAction?: PreActionHook | List<PreActionHook> | null | undefined]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('preAction')
+      .toEqualTypeOf<Nilable<PreActionHook | List<PreActionHook>>>()
+  })
+
+  it('should match [preCommand?: PreCommandHook | List<PreCommandHook> | null | undefined]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('preCommand')
+      .toEqualTypeOf<Nilable<PreCommandHook | List<PreCommandHook>>>()
+  })
+})

src/interfaces/__tests__/hooks.data.spec-d.mts

@@ -0,0 +1,41 @@
+/**
+ * @file Type Tests - HooksInfo
+ * @module kronk/interfaces/tests/unit-d/HooksInfo
+ */
+
+import type TestSubject from '#interfaces/hooks.info'
+import type {
+  HooksData,
+  PostActionHook,
+  PreActionHook,
+  PreCommandHook
+} from '@flex-development/kronk'
+import type { RequiredKeys } from '@flex-development/tutils'
+
+describe('unit-d:interfaces/HooksInfo', () => {
+  it('should extend HooksData', () => {
+    expectTypeOf<TestSubject>().toExtend<HooksData>()
+  })
+
+  it('should have all required keys', () => {
+    expectTypeOf<RequiredKeys<TestSubject>>().toEqualTypeOf<keyof TestSubject>()
+  })
+
+  it('should match [postAction: PostActionHook[]]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('postAction')
+      .toEqualTypeOf<PostActionHook[]>()
+  })
+
+  it('should match [preAction: PreActionHook[]]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('preAction')
+      .toEqualTypeOf<PreActionHook[]>()
+  })
+
+  it('should match [preCommand: PreCommandHook[]]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('preCommand')
+      .toEqualTypeOf<PreCommandHook[]>()
+  })
+})

src/interfaces/__tests__/hooks.info.spec-d.mts

@@ -0,0 +1,27 @@
+/**
+ * @file Type Tests - KronkHookMap
+ * @module kronk/interfaces/tests/unit-d/KronkHookMap
+ */
+
+import type TestSubject from '#interfaces/kronk-hook.map'
+import type { Hook } from '@flex-development/kronk'
+
+describe('unit-d:interfaces/KronkHookMap', () => {
+  it('should match [postAction: Hook]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('postAction')
+      .toEqualTypeOf<Hook>()
+  })
+
+  it('should match [preAction: Hook]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('preAction')
+      .toEqualTypeOf<Hook>()
+  })
+
+  it('should match [preCommand: Hook]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('preCommand')
+      .toEqualTypeOf<Hook>()
+  })
+})

src/interfaces/__tests__/kronk-hook.map.spec-d.mts

@@ -4,9 +4,13 @@
  */
 
 import type TestSubject from '#interfaces/usage.data'
-import type { Nilable } from '@flex-development/tutils'
+import type { Nilable, OptionalKeys } from '@flex-development/tutils'
 
 describe('unit-d:interfaces/UsageData', () => {
+  it('should have all optional keys', () => {
+    expectTypeOf<OptionalKeys<TestSubject>>().toEqualTypeOf<keyof TestSubject>()
+  })
+
   it('should match [arguments?: readonly string[] | string | null | undefined]', () => {
     expectTypeOf<TestSubject>()
       .toHaveProperty('arguments')

src/interfaces/__tests__/usage.data.spec-d.mts

@@ -5,13 +5,17 @@
 
 import type TestSubject from '#interfaces/usage.info'
 import type { UsageData } from '@flex-development/kronk'
-import type { Nullable } from '@flex-development/tutils'
+import type { Nullable, RequiredKeys } from '@flex-development/tutils'
 
 describe('unit-d:interfaces/UsageInfo', () => {
   it('should extend UsageData', () => {
     expectTypeOf<TestSubject>().toExtend<UsageData>()
   })
 
+  it('should have all required keys', () => {
+    expectTypeOf<RequiredKeys<TestSubject>>().toEqualTypeOf<keyof TestSubject>()
+  })
+
   it('should match [arguments: readonly string[]]', () => {
     expectTypeOf<TestSubject>()
       .toHaveProperty('arguments')