feat(types): Question

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

Author: unicornware

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

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

src/types/index.ts

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

src/types/question.ts

@@ -0,0 +1,36 @@
+/**
+ * @file Type Definitions - Question
+ * @module commitlint-config/types/Question
+ */
+
+import type QuestionEnum from './question-enum'
+
+/**
+ * Object representing a prompt question.
+ *
+ * @see https://commitlint.js.org/#/reference-prompt?id=questions
+ *
+ * @template N - Question enum names
+ * @template Q - Question enum type
+ */
+type Question<
+  N extends string = string,
+  Q extends QuestionEnum = QuestionEnum
+> = {
+  /**
+   * Question description.
+   */
+  description: string
+
+  /**
+   * Question enums.
+   */
+  enum?: { [key in N]: Q }
+
+  /**
+   * Message hints.
+   */
+  messages?: { [key in string]: string }
+}
+
+export type { Question as default }