feat(types): NoteKeyword

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

Author: unicornware

Diff for: src/index.ts

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

Diff for: src/types/__tests__/note-keyword.spec-d.ts

@@ -0,0 +1,16 @@
+/**
+ * @file Type Tests - NoteKeyword
+ * @module commitlint-config/types/tests/unit-d/NoteKeyword
+ */
+
+import type TestSubject from '../note-keyword'
+
+describe('unit-d:types/NoteKeyword', () => {
+  it('should extract "BREAKING CHANGE"', () => {
+    expectTypeOf<TestSubject>().extract('BREAKING CHANGE').toBeString()
+  })
+
+  it('should extract "BREAKING-CHANGE"', () => {
+    expectTypeOf<TestSubject>().extract('BREAKING-CHANGE').toBeString()
+  })
+})

Diff for: src/types/index.ts

@@ -0,0 +1,6 @@
+/**
+ * @file Entry Point - Type Definitions
+ * @module commitlint-config/types
+ */
+
+export type { default as NoteKeyword } from './note-keyword'

Diff for: src/types/note-keyword.ts

@@ -0,0 +1,13 @@
+/**
+ * @file Type Definitions - NoteKeyword
+ * @module commitlint-config/types/NoteKeyword
+ */
+
+/**
+ * Keywords for important notes.
+ *
+ * @see https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-commits-parser/README.md#notekeywords
+ */
+type NoteKeyword = 'BREAKING CHANGE' | 'BREAKING-CHANGE'
+
+export type { NoteKeyword as default }

Diff for: vitest.config.ts

@@ -52,7 +52,12 @@ const config: UserConfigExport = defineConfig((): UserConfig => {
         all: !LINT_STAGED,
         clean: true,
         cleanOnRerun: true,
-        exclude: ['**/__mocks__/**', '**/__tests__/**', '**/index.ts'],
+        exclude: [
+          '**/__mocks__/**',
+          '**/__tests__/**',
+          '**/index.ts',
+          'src/types/'
+        ],
         extension: ['.ts'],
         ignoreClassMethods: [],
         include: ['src'],