feat(interfaces): PromptConfig

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

Author: unicornware

src/interfaces/__tests__/config-prompt.spec-d.ts

@@ -0,0 +1,20 @@
+/**
+ * @file Type Tests - PromptConfig
+ * @module commitlint-config/interfaces/tests/unit-d/PromptConfig
+ */
+
+import type { Questions } from '#src/types'
+import type * as commitlint from '@commitlint/types'
+import type TestSubject from '../config-prompt'
+
+describe('unit-d:interfaces/PromptConfig', () => {
+  it('should extend commitlint.PromptConfig', () => {
+    expectTypeOf<TestSubject>().toMatchTypeOf<commitlint.PromptConfig>()
+  })
+
+  it('should match [questions: Questions]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('questions')
+      .toEqualTypeOf<Questions>()
+  })
+})

src/interfaces/config-prompt.ts

@@ -0,0 +1,40 @@
+/**
+ * @file Interfaces - PromptConfig
+ * @module commitlint-config/interfaces/PromptConfig
+ */
+
+import type { Questions } from '#src/types'
+import type * as commitlint from '@commitlint/types'
+
+/**
+ * Object representing prompt configuration used by `@commitlint/cz-commitlint`.
+ *
+ * @see https://commitlint.js.org/#/reference-prompt
+ * @see https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/cz-commitlint
+ *
+ * @extends {commitlint.PromptConfig}
+ */
+interface PromptConfig extends commitlint.PromptConfig {
+  /**
+   * Message hints.
+   *
+   * @see https://commitlint.js.org/#/reference-prompt?id=messages
+   */
+  messages: commitlint.PromptConfig['messages']
+
+  /**
+   * Interactive steps.
+   *
+   * @see https://commitlint.js.org/#/reference-prompt?id=questions
+   */
+  questions: Questions
+
+  /**
+   * Additional prompt settings.
+   *
+   * @see https://commitlint.js.org/#/reference-prompt?id=settings
+   */
+  settings: commitlint.PromptConfig['settings']
+}
+
+export type { PromptConfig as default }

src/interfaces/index.ts

@@ -3,4 +3,5 @@
  * @module commitlint-config/interfaces
  */
 
+export type { default as PromptConfig } from './config-prompt'
 export type { default as ParserOptions } from './options-parser'