feat(types): Questions

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

Author: unicornware

package.json

@@ -74,6 +74,7 @@
   "dependencies": {
     "@commitlint/config-conventional": "17.4.4",
     "@commitlint/types": "17.4.4",
+    "@flex-development/tutils": "6.0.0-alpha.10",
     "conventional-changelog-conventionalcommits": "5.0.0"
   },
   "devDependencies": {
@@ -82,7 +83,6 @@
     "@flex-development/mkbuild": "1.0.0-alpha.14",
     "@flex-development/mlly": "1.0.0-alpha.13",
     "@flex-development/pathe": "1.0.3",
-    "@flex-development/tutils": "6.0.0-alpha.10",
     "@graphql-eslint/eslint-plugin": "3.16.0",
     "@types/chai": "4.3.4",
     "@types/conventional-changelog": "3.1.1",

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

@@ -0,0 +1,27 @@
+/**
+ * @file Type Tests - Questions
+ * @module commitlint-config/types/tests/unit-d/Questions
+ */
+
+import { PromptKind, Scope, Type } from '#src/enums'
+import type Question from '../question'
+import type QuestionEnum from '../question-enum'
+import type TestSubject from '../questions'
+
+describe('unit-d:types/Questions', () => {
+  it('should extend Record<PromptKind, Question>', () => {
+    expectTypeOf<TestSubject>().toMatchTypeOf<Record<PromptKind, Question>>()
+  })
+
+  it('should match [PromptKind.SCOPE: Question<Scope>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty(PromptKind.SCOPE)
+      .toEqualTypeOf<Question<Scope>>()
+  })
+
+  it('should match [PromptKind.TYPE: Question<Type, Required<QuestionEnum>>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty(PromptKind.TYPE)
+      .toEqualTypeOf<Question<Type, Required<QuestionEnum>>>()
+  })
+})

src/types/index.ts

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

src/types/questions.ts

@@ -0,0 +1,33 @@
+/**
+ * @file Type Definitions - Questions
+ * @module commitlint-config/types/Questions
+ */
+
+import type { PromptKind, Scope, Type } from '#src/enums'
+import type { Overwrite } from '@flex-development/tutils'
+import type Question from './question'
+import type QuestionEnum from './question-enum'
+
+/**
+ * Prompt questions.
+ *
+ * @see https://commitlint.js.org/#/reference-prompt?id=questions
+ *
+ * @extends {Record<PromptKind,Question>}
+ */
+type Questions = Overwrite<
+  Record<PromptKind, Question>,
+  {
+    /**
+     * Commit scope questions configuration.
+     */
+    [PromptKind.SCOPE]: Question<Scope>
+
+    /**
+     * Commit type questions configuration.
+     */
+    [PromptKind.TYPE]: Question<Type, Required<QuestionEnum>>
+  }
+>
+
+export type { Questions as default }