feat(interfaces): Reference

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

Author: unicornware

src/interfaces/__tests__/reference.spec-d.ts

@@ -0,0 +1,40 @@
+/**
+ * @file Type Tests - Reference
+ * @module commitlint-config/interfaces/tests/unit-d/Reference
+ */
+
+import type { ReferenceAction } from '#src/enums'
+import type { Nullable } from '@flex-development/tutils'
+import type TestSubject from '../reference'
+
+describe('unit-d:interfaces/Reference', () => {
+  it('should match [action: Nullable<ReferenceAction>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('action')
+      .toEqualTypeOf<Nullable<ReferenceAction>>()
+  })
+
+  it('should match [issue: string]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('issue').toBeString()
+  })
+
+  it('should match [owner: Nullable<string>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('owner')
+      .toEqualTypeOf<Nullable<string>>()
+  })
+
+  it('should match [prefix: string]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('prefix').toBeString()
+  })
+
+  it('should match [raw: string]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('raw').toBeString()
+  })
+
+  it('should match [repository: Nullable<string>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('repository')
+      .toEqualTypeOf<Nullable<string>>()
+  })
+})

src/interfaces/index.ts

@@ -7,4 +7,5 @@ export type { default as Config } from './config'
 export type { default as PromptConfig } from './config-prompt'
 export type { default as RulesConfig } from './config-rules'
 export type { default as ParserOptions } from './options-parser'
+export type { default as Reference } from './reference'
 export type { default as Revert } from './revert'

src/interfaces/reference.ts

@@ -0,0 +1,46 @@
+/**
+ * @file Interfaces - Reference
+ * @module commitlint-config/interfaces/Reference
+ */
+
+import type { ReferenceAction } from '#src/enums'
+import type { Nullable } from '@flex-development/tutils'
+
+/**
+ * Object representing a reference action in a commit.
+ */
+interface Reference {
+  /**
+   * Reference action, if any.
+   */
+  action: Nullable<ReferenceAction>
+
+  /**
+   * Referenced issue.
+   */
+  issue: string
+
+  /**
+   * Repository owner.
+   */
+  owner: Nullable<string>
+
+  /**
+   * Issue prefix.
+   */
+  prefix: string
+
+  /**
+   * Raw reference from commit.
+   */
+  raw: string
+
+  /**
+   * Name of repository the reference belongs to.
+   *
+   * If `null`, reference is from `origin`.
+   */
+  repository: Nullable<string>
+}
+
+export type { Reference as default }