feat(interfaces): Note

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

Author: unicornware

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

@@ -0,0 +1,19 @@
+/**
+ * @file Type Tests - Note
+ * @module commitlint-config/interfaces/tests/unit-d/Note
+ */
+
+import type { NoteKeyword } from '#src/types'
+import type TestSubject from '../note'
+
+describe('unit-d:interfaces/Note', () => {
+  it('should match [text: string]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('text').toBeString()
+  })
+
+  it('should match [title: NoteKeyword]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('title')
+      .toEqualTypeOf<NoteKeyword>()
+  })
+})

src/interfaces/index.ts

@@ -6,6 +6,7 @@
 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 Note } from './note'
 export type { default as ParserOptions } from './options-parser'
 export type { default as Reference } from './reference'
 export type { default as Revert } from './revert'

src/interfaces/note.ts

@@ -0,0 +1,23 @@
+/**
+ * @file Interfaces - Note
+ * @module commitlint-config/interfaces/Note
+ */
+
+import type { NoteKeyword } from '#src/types'
+
+/**
+ * Object representing a "BREAKING CHANGE" note.
+ */
+interface Note {
+  /**
+   * Note content.
+   */
+  text: string
+
+  /**
+   * Note title.
+   */
+  title: NoteKeyword
+}
+
+export type { Note as default }