refactor: event system

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

Author: unicornware

.attw.json

@@ -2,6 +2,10 @@
   "color": true,
   "emoji": true,
   "format": "ascii",
-  "ignoreRules": ["cjs-resolves-to-esm", "internal-resolution-error"],
+  "ignoreRules": [
+    "cjs-resolves-to-esm",
+    "internal-resolution-error",
+    "no-resolution"
+  ],
   "summary": true
 }

.commitlintrc.ts

@@ -18,7 +18,8 @@ const config: UserConfig = {
     'scope-enum': [RuleConfigSeverity.Error, 'always', scopes([
       'chore',
       'constructs',
-      'errors'
+      'errors',
+      'events'
     ])]
   }
 }

package.json

@@ -43,7 +43,19 @@
       "kronk": "./src/index.mts",
       "default": "./dist/index.mjs"
     },
-    "./package.json": "./package.json"
+    "./errors": {
+      "kronk": "./src/errors/index.mts",
+      "default": "./dist/errors/index.mjs"
+    },
+    "./events": {
+      "kronk": "./src/events/index.mts",
+      "default": "./dist/events/index.mjs"
+    },
+    "./package.json": "./package.json",
+    "./utils": {
+      "kronk": "./src/utils/index.mts",
+      "default": "./dist/utils/index.mjs"
+    }
   },
   "imports": {
     "#constructs/*": {
@@ -58,6 +70,10 @@
       "kronk": "./src/errors/*.mts",
       "default": "./dist/errors/*.mjs"
     },
+    "#events/*": {
+      "kronk": "./src/events/*.mts",
+      "default": "./dist/events/*.mjs"
+    },
     "#fixtures/*": "./__fixtures__/*.mts",
     "#interfaces/*": {
       "kronk": "./src/interfaces/*.mts",

src/__snapshots__/index.e2e.snap

@@ -3,15 +3,17 @@
 exports[`e2e:kronk > should expose public api 1`] = `
 [
   "optionValueSource",
-  "CommandError",
-  "KronkError",
   "Argument",
   "Command",
   "Option",
+  "CommandError",
+  "KronkError",
+  "KronkEvent",
+  "OptionEvent",
   "isArgument",
-  "isCommand",
   "isCommandError",
   "isKronkError",
+  "isKronkEvent",
   "isOption",
 ]
 `;

src/errors/__tests__/index.e2e.spec.mts

@@ -3,7 +3,7 @@
  * @module kronk/errors/tests/e2e/api
  */
 
-import * as testSubject from '#errors/index'
+import * as testSubject from '@flex-development/kronk/errors'
 
 describe('e2e:errors', () => {
   it('should expose public api', () => {

src/events/__snapshots__/index.e2e.snap

@@ -0,0 +1,8 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`e2e:events > should expose public api 1`] = `
+[
+  "KronkEvent",
+  "OptionEvent",
+]
+`;

src/events/__tests__/index.e2e.spec.mts

@@ -0,0 +1,12 @@
+/**
+ * @file E2E Tests - events
+ * @module kronk/errors/tests/e2e/api
+ */
+
+import * as testSubject from '@flex-development/kronk/events'
+
+describe('e2e:events', () => {
+  it('should expose public api', () => {
+    expect(Object.keys(testSubject)).toMatchSnapshot()
+  })
+})

src/events/__tests__/kronk.event.spec.mts

@@ -0,0 +1,33 @@
+/**
+ * @file Unit Tests - KronkEvent
+ * @module kronk/events/tests/unit/KronkEvent
+ */
+
+import TestSubject from '#events/kronk.event'
+import isKronkEvent from '#utils/is-kronk-event'
+import type { KronkEventName } from '@flex-development/kronk'
+
+describe('unit:events/KronkEvent', () => {
+  let id: KronkEventName
+  let subject: TestSubject
+
+  beforeAll(() => {
+    subject = new TestSubject(id = 'option:')
+  })
+
+  describe('constructor', () => {
+    it('should pass kronk event guard', () => {
+      expect(subject).to.satisfy(isKronkEvent)
+    })
+
+    it('should set #id', () => {
+      expect(subject).to.have.property('id', id)
+    })
+  })
+
+  describe('#toString', () => {
+    it('should return event as human-readable string', () => {
+      expect(subject.toString()).to.eq(id).and.eq(String(subject))
+    })
+  })
+})

src/events/__tests__/option.event.spec.mts

@@ -0,0 +1,60 @@
+/**
+ * @file Unit Tests - OptionEvent
+ * @module kronk/events/tests/unit/OptionEvent
+ */
+
+import optionValueSource from '#enums/option-value-source'
+import KronkEvent from '#events/kronk.event'
+import TestSubject from '#events/option.event'
+import Option from '#lib/option'
+import type {
+  Flags,
+  OptionValueSource,
+  RawOptionValue
+} from '@flex-development/kronk'
+import { ok } from 'devlop'
+
+describe('unit:events/OptionEvent', () => {
+  let flag: Flags
+  let option: Option
+  let source: OptionValueSource
+  let subject: TestSubject
+  let value: RawOptionValue
+
+  beforeAll(() => {
+    option = new Option('-d | --debug')
+    ok(typeof option.long === 'string', 'expected `option.long`')
+
+    flag = option.long
+    source = optionValueSource.config
+    value = true
+
+    subject = new TestSubject(option, value, source, flag)
+  })
+
+  describe('constructor', () => {
+    it('should be instanceof `KronkEvent`', () => {
+      expect(subject).to.be.instanceof(KronkEvent)
+    })
+
+    it('should set #flag', () => {
+      expect(subject).to.have.property('flag', flag)
+    })
+
+    it('should set #id', () => {
+      expect(subject).to.have.property('id', option.event)
+    })
+
+    it('should set #option', () => {
+      expect(subject).to.have.property('option', option)
+    })
+
+    it('should set #source', () => {
+      expect(subject).to.have.property('source', source)
+    })
+
+    it('should set #value', () => {
+      expect(subject).to.have.property('value', value)
+    })
+  })
+})

src/events/index.mts

@@ -0,0 +1,7 @@
+/**
+ * @file Entry Point - Events
+ * @module kronk/events
+ */
+
+export { default as KronkEvent } from '#events/kronk.event'
+export { default as OptionEvent } from '#events/option.event'