feat(interfaces): ParserOptions

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

Author: unicornware

package.json

@@ -75,6 +75,7 @@
     "@commitlint/config-conventional": "17.4.4",
     "@commitlint/types": "17.4.4",
     "@flex-development/tutils": "6.0.0-alpha.10",
+    "@types/conventional-commits-parser": "3.0.3",
     "conventional-changelog-conventionalcommits": "5.0.0"
   },
   "devDependencies": {
@@ -88,7 +89,6 @@
     "@types/conventional-changelog": "3.1.1",
     "@types/conventional-changelog-core": "4.2.1",
     "@types/conventional-changelog-writer": "4.0.2",
-    "@types/conventional-commits-parser": "3.0.3",
     "@types/conventional-recommended-bump": "6.1.0",
     "@types/dateformat": "5.0.0",
     "@types/eslint": "8.21.1",

src/index.ts

@@ -4,4 +4,5 @@
  */
 
 export * from './enums'
+export * from './interfaces'
 export * from './types'

src/interfaces/__tests__/options-parser.spec-d.ts

@@ -0,0 +1,87 @@
+/**
+ * @file Type Tests - ParserOptions
+ * @module commitlint-config/interfaces/tests/unit-d/ParserOptions
+ */
+
+import type { ReferenceAction } from '#src/enums'
+import type { NoteKeyword } from '#src/types'
+import type * as parser from 'conventional-commits-parser'
+import type TestSubject from '../options-parser'
+
+describe('unit-d:interfaces/ParserOptions', () => {
+  it('should extend Required<parser.Options>', () => {
+    expectTypeOf<TestSubject>().toMatchTypeOf<Required<parser.Options>>()
+  })
+
+  it('should match [commentChar: string]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('commentChar').toBeString()
+  })
+
+  it('should match [fieldPattern: RegExp]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('fieldPattern')
+      .toEqualTypeOf<RegExp>()
+  })
+
+  it('should match [headerCorrespondence: string[]]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('headerCorrespondence')
+      .toEqualTypeOf<string[]>()
+  })
+
+  it('should match [headerPattern: RegExp]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('headerPattern')
+      .toEqualTypeOf<RegExp>()
+  })
+
+  it('should match [issuePrefixes: string[]]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('issuePrefixes')
+      .toEqualTypeOf<string[]>()
+  })
+
+  it('should match [issuePrefixesCaseSensitive: boolean]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('issuePrefixesCaseSensitive')
+      .toBeBoolean()
+  })
+
+  it('should match [mergeCorrespondence: null]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('mergeCorrespondence').toBeNull()
+  })
+
+  it('should match [mergePattern: null]', () => {
+    expectTypeOf<TestSubject>().toHaveProperty('mergePattern').toBeNull()
+  })
+
+  it('should match [noteKeywords: NoteKeyword[]]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('noteKeywords')
+      .toEqualTypeOf<NoteKeyword[]>()
+  })
+
+  it('should match [referenceActions: ReferenceAction[]]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('referenceActions')
+      .toEqualTypeOf<ReferenceAction[]>()
+  })
+
+  it('should match [revertCorrespondence: string[]]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('revertCorrespondence')
+      .toEqualTypeOf<string[]>()
+  })
+
+  it('should match [revertPattern: RegExp]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('revertPattern')
+      .toEqualTypeOf<RegExp>()
+  })
+
+  it('should match [warn: Console["warn"]]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('warn')
+      .toEqualTypeOf<Console['warn']>()
+  })
+})

src/interfaces/index.ts

@@ -0,0 +1,6 @@
+/**
+ * @file Entry Point - Interfaces
+ * @module commitlint-config/interfaces
+ */
+
+export type { default as ParserOptions } from './options-parser'

src/interfaces/options-parser.ts

@@ -0,0 +1,33 @@
+/**
+ * @file Interfaces - ParserOptions
+ * @module commitlint-config/interfaces/ParserOptions
+ */
+
+import type { ReferenceAction } from '#src/enums'
+import type { NoteKeyword } from '#src/types'
+import type * as parser from 'conventional-commits-parser'
+
+/**
+ * Commit parser options.
+ *
+ * @see https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-commits-parser/README.md#options
+ *
+ * @extends {Required<parser.Options>}
+ */
+interface ParserOptions extends Required<parser.Options> {
+  commentChar: string
+  fieldPattern: RegExp
+  headerCorrespondence: string[]
+  headerPattern: RegExp
+  issuePrefixes: string[]
+  issuePrefixesCaseSensitive: boolean
+  mergeCorrespondence: null
+  mergePattern: null
+  noteKeywords: NoteKeyword[]
+  referenceActions: ReferenceAction[]
+  revertCorrespondence: string[]
+  revertPattern: RegExp
+  warn: Console['warn']
+}
+
+export type { ParserOptions as default }

vitest.config.ts

@@ -56,6 +56,7 @@ const config: UserConfigExport = defineConfig((): UserConfig => {
           '**/__mocks__/**',
           '**/__tests__/**',
           '**/index.ts',
+          'src/interfaces/',
           'src/types/'
         ],
         extension: ['.ts'],
@@ -121,6 +122,7 @@ const config: UserConfigExport = defineConfig((): UserConfig => {
       snapshotFormat: {
         callToJSON: true,
         min: false,
+        printBasicPrototype: false,
         printFunctionName: true
       },
       testTimeout: 10 * 1000,