feat(types): QuestionEnum

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

Author: unicornware

src/types/__tests__/question-enum.spec-d.ts

@@ -0,0 +1,26 @@
+/**
+ * @file Type Tests - QuestionEnum
+ * @module commitlint-config/types/tests/unit-d/QuestionEnum
+ */
+
+import type TestSubject from '../question-enum'
+
+describe('unit-d:types/QuestionEnum', () => {
+  it('should match [description?: string]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('description')
+      .toEqualTypeOf<string | undefined>()
+  })
+
+  it('should match [emoji?: string]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('emoji')
+      .toEqualTypeOf<string | undefined>()
+  })
+
+  it('should match [title?: string]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('title')
+      .toEqualTypeOf<string | undefined>()
+  })
+})

src/types/index.ts

@@ -4,3 +4,4 @@
  */
 
 export type { default as NoteKeyword } from './note-keyword'
+export type { default as QuestionEnum } from './question-enum'

src/types/question-enum.ts

@@ -0,0 +1,28 @@
+/**
+ * @file Type Definitions - QuestionEnum
+ * @module commitlint-config/types/QuestionEnum
+ */
+
+/**
+ * Object representing prompt question metadata.
+ *
+ * @see https://commitlint.js.org/#/reference-prompt?id=questions
+ */
+type QuestionEnum = {
+  /**
+   * Enum description.
+   */
+  description?: string
+
+  /**
+   * Emoji to display next to {@linkcode title}.
+   */
+  emoji?: string
+
+  /**
+   * Prompt title.
+   */
+  title?: string
+}
+
+export type { QuestionEnum as default }