feat(interfaces): Commit

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

Author: unicornware

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

@@ -0,0 +1,101 @@
+/**
+ * @file Type Tests - Commit
+ * @module commitlint-config/interfaces/tests/unit-d/Commit
+ */
+
+import type { Scope, Type } from '#src/enums'
+import type { LiteralUnion, Nullable } from '@flex-development/tutils'
+import type TestSubject from '../commit'
+import type Note from '../note'
+import type Reference from '../reference'
+import type Revert from '../revert'
+
+describe('unit-d:interfaces/Commit', () => {
+  it('should match [body: Nullable<string>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('body')
+      .toEqualTypeOf<Nullable<string>>()
+  })
+
+  it('should match [breaking: Nullable<"!">]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('breaking')
+      .toEqualTypeOf<Nullable<'!'>>()
+  })
+
+  it('should match [committerDate: string]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('committerDate').toBeString()
+  })
+
+  it('should match [footer: Nullable<string>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('footer')
+      .toEqualTypeOf<Nullable<string>>()
+  })
+
+  it('should match [gitTags: string]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('gitTags').toBeString()
+  })
+
+  it('should match [hash: string]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('hash').toBeString()
+  })
+
+  it('should match [header: string]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('header').toBeString()
+  })
+
+  it('should match [mentions: string[]]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('mentions')
+      .toEqualTypeOf<string[]>()
+  })
+
+  it('should match [merge: null]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('merge').toBeNull()
+  })
+
+  it('should match [notes: Note[]]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('notes').toEqualTypeOf<Note[]>()
+  })
+
+  it('should match [pr: Nullable<string>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('pr')
+      .toEqualTypeOf<Nullable<string>>()
+  })
+
+  it('should match [references: Reference[]]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('references')
+      .toEqualTypeOf<Reference[]>()
+  })
+
+  it('should match [revert: Nullable<Revert>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('revert')
+      .toEqualTypeOf<Nullable<Revert>>()
+  })
+
+  it('should match [scope: Nullable<LiteralUnion<Scope, string>>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('scope')
+      .toEqualTypeOf<Nullable<LiteralUnion<Scope, string>>>()
+  })
+
+  it('should match [shortHash: Nullable<string>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('shortHash')
+      .toEqualTypeOf<Nullable<string>>()
+  })
+
+  it('should match [subject: string]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('subject').toBeString()
+  })
+
+  it('should match [type: LiteralUnion<Type, string>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('type')
+      .toEqualTypeOf<LiteralUnion<Type, string>>()
+  })
+})

src/interfaces/commit.ts

@@ -0,0 +1,122 @@
+/**
+ * @file Interfaces - Commit
+ * @module commitlint-config/interfaces/Commit
+ */
+
+import type { Scope, Type } from '#src/enums'
+import type {
+  LiteralUnion,
+  Nullable,
+  OneOrMany
+} from '@flex-development/tutils'
+import type Note from './note'
+import type Reference from './reference'
+import type Revert from './revert'
+
+/**
+ * Object representing a parsed commit.
+ */
+interface Commit {
+  [field: string]: Note[] | Nullable<OneOrMany<string>> | Reference[] | Revert
+
+  /**
+   * Commit body text.
+   *
+   * @see https://commitlint.js.org/#/concepts-commit-conventions
+   */
+  body: Nullable<string>
+
+  /**
+   * Breaking change indicator.
+   */
+  breaking: Nullable<'!'>
+
+  /**
+   * Commit date in ISO 8601-like format (`%ci`).
+   *
+   * @see https://git-scm.com/docs/pretty-formats/2.21.0
+   */
+  committerDate: string
+
+  /**
+   * Commit footer text.
+   *
+   * @see https://commitlint.js.org/#/concepts-commit-conventions
+   */
+  footer: Nullable<string>
+
+  /**
+   * Tags associated with commit.
+   */
+  gitTags: string
+
+  /**
+   * Commit SHA.
+   */
+  hash: string
+
+  /**
+   * Commit {@linkcode type}, {@linkcode scope}, {@linkcode breaking} change
+   * indicator (if any), and {@linkcode subject}.
+   */
+  header: string
+
+  /**
+   * Users and/or organizations mentioned in commit.
+   */
+  mentions: string[]
+
+  /**
+   * Merge commit data.
+   */
+  merge: null
+
+  /**
+   * Breaking change notes.
+   */
+  notes: Note[]
+
+  /**
+   * Pull request number if commit {@linkcode subject} includes pull request
+   * reference.
+   */
+  pr: Nullable<string>
+
+  /**
+   * Reference actions parsed from commit.
+   */
+  references: Reference[]
+
+  /**
+   * Reverted commit metadata if {@linkcode type} is {@linkcode Type.REVERT}.
+   */
+  revert: Nullable<Revert>
+
+  /**
+   * Commit scope.
+   *
+   * @see https://commitlint.js.org/#/concepts-commit-conventions
+   */
+  scope: Nullable<LiteralUnion<Scope, string>>
+
+  /**
+   * Abbreviated commit SHA.
+   */
+  shortHash: Nullable<string>
+
+  /**
+   * Commit subject.
+   *
+   * @see https://commitlint.js.org/#/concepts-commit-conventions
+   */
+  subject: string
+
+  /**
+   * Commit type.
+   *
+   * @see https://commitlint.js.org/#/concepts-commit-conventions
+   */
+  type: LiteralUnion<Type, string>
+}
+
+export type { Commit as default }

src/interfaces/index.ts

@@ -3,6 +3,7 @@
  * @module commitlint-config/interfaces
  */
 
+export type { default as Commit } from './commit'
 export type { default as Config } from './config'
 export type { default as PromptConfig } from './config-prompt'
 export type { default as RulesConfig } from './config-rules'