feat(config): config

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

Author: unicornware

.commitlintrc.json

@@ -1,61 +1,3 @@
 {
-  "defaultIgnores": true,
-  "extends": ["@commitlint/config-conventional"],
-  "formatter": "@commitlint/format",
-  "ignores": [],
-  "rules": {
-    "body-max-line-length": [2, "always", 5000],
-    "scope-case": [2, "always", ["kebab-case", "lower-case"]],
-    "scope-enum": [
-      2,
-      "always",
-      [
-        "build",
-        "cjs",
-        "config",
-        "deps",
-        "deps-bundle",
-        "deps-dev",
-        "deps-opt",
-        "deps-peer",
-        "esm",
-        "exports",
-        "github",
-        "install",
-        "internal",
-        "loader",
-        "nvm",
-        "pkg",
-        "release",
-        "rules",
-        "scripts",
-        "spelling",
-        "tests",
-        "ts",
-        "types",
-        "vscode",
-        "workflows",
-        "yarn"
-      ]
-    ],
-    "subject-case": [1, "always", "lower-case"],
-    "type-enum": [
-      2,
-      "always",
-      [
-        "build",
-        "chore",
-        "ci",
-        "docs",
-        "feat",
-        "fix",
-        "perf",
-        "refactor",
-        "revert",
-        "style",
-        "test",
-        "wip"
-      ]
-    ]
-  }
+  "extends": "@flex-development"
 }

__tests__/ts/v4/tsconfig.json

@@ -32,7 +32,8 @@
       "#fixtures/*": ["__fixtures__/*"],
       "#src": ["src/index"],
       "#src/*": ["src/*"],
-      "#tests/*": ["__tests__/*"]
+      "#tests/*": ["__tests__/*"],
+      "@flex-development/commitlint-config": ["src/index"]
     },
     "preserveConstEnums": true,
     "preserveSymlinks": false,

config/changelog.config.ts

@@ -8,6 +8,11 @@
  * @see https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/git-raw-commits
  */
 
+import {
+  Type,
+  parserPreset,
+  type Commit
+} from '@flex-development/commitlint-config'
 import pathe from '@flex-development/pathe'
 import { CompareResult, isNIL } from '@flex-development/tutils'
 import addStream from 'add-stream'
@@ -17,7 +22,7 @@ import type {
   CommitGroup,
   GeneratedContext
 } from 'conventional-changelog-writer'
-import type { Commit, ICommit } from 'conventional-commits-parser'
+import type { ICommit } from 'conventional-commits-parser'
 import dateformat from 'dateformat'
 import type mri from 'mri'
 import {
@@ -136,7 +141,8 @@ sade('changelog', true)
      *
      * @const {Readable} changelog
      */
-    const changelog: Readable = conventionalChangelog(
+    // @ts-expect-error type definitions are incorrect
+    const changelog: Readable = conventionalChangelog<Commit>(
       {
         append: false,
         debug: debug ? console.debug.bind(console) : undefined,
@@ -147,24 +153,23 @@ sade('changelog', true)
             ? !!outputUnreleased.trim()
             : false,
         pkg: { path: pathe.resolve('package.json') },
-        // @ts-expect-error ts(2322)
         preset: {
           header: '',
-          name: 'conventionalcommits',
+          name: parserPreset.name,
           releaseCommitMessageFormat: 'release: {{currentTag}}',
           types: [
-            { section: ':package: Build', type: 'build' },
-            { section: ':house_with_garden: Housekeeping', type: 'chore' },
-            { section: ':robot: Continuous Integration', type: 'ci' },
-            { section: ':pencil: Documentation', type: 'docs' },
-            { section: ':sparkles: Features', type: 'feat' },
-            { section: ':bug: Fixes', type: 'fix' },
-            { section: ':fire: Performance Improvements', type: 'perf' },
-            { section: ':zap: Refactors', type: 'refactor' },
-            { section: ':rewind: Reverts', type: 'revert' },
-            { hidden: true, type: 'style' },
-            { section: ':white_check_mark: Testing', type: 'test' },
-            { hidden: true, type: 'wip' }
+            { section: ':package: Build', type: Type.BUILD },
+            { section: ':house_with_garden: Housekeeping', type: Type.CHORE },
+            { section: ':robot: Continuous Integration', type: Type.CI },
+            { section: ':pencil: Documentation', type: Type.DOCS },
+            { section: ':sparkles: Features', type: Type.FEAT },
+            { section: ':bug: Fixes', type: Type.FIX },
+            { section: ':fire: Performance Improvements', type: Type.PERF },
+            { section: ':mechanical_arm: Refactors', type: Type.REFACTOR },
+            { section: ':wastebasket: Reverts', type: Type.REVERT },
+            { hidden: true, type: Type.STYLE },
+            { section: ':white_check_mark: Testing', type: Type.TEST },
+            { hidden: true, type: Type.WIP }
           ]
         },
         releaseCount,
@@ -183,25 +188,23 @@ sade('changelog', true)
         transform(commit: Commit, apply: Options.Transform.Callback): void {
           return void apply(null, {
             ...commit,
-            committerDate: dateformat(
-              commit.committerDate!,
-              'yyyy-mm-dd',
-              true
-            ),
+            committerDate: dateformat(commit.committerDate, 'yyyy-mm-dd', true),
             mentions: commit.mentions.filter(m => m !== 'flexdevelopment'),
             // @ts-expect-error ts(2322)
             raw: commit,
             references: commit.references.filter(ref => ref.action !== null),
-            shortHash: commit.hash!.slice(0, 7),
             version: commit.gitTags ? vgx.exec(commit.gitTags)?.[1] : undefined
           })
-        }
+        },
+        warn: parserPreset.parserOpts.warn
       },
       {},
-      {},
       {
-        issuePrefixesCaseSensitive: true
+        debug: debug ? parserPreset.parserOpts.warn : undefined,
+        format:
+          '%B%n-hash-%n%H%n-shortHash-%n%h%n-gitTags-%n%d%n-committerDate-%n%ci%n'
       },
+      parserPreset.parserOpts,
       {
         /**
          * Sorts commit groups in descending order by group title.
@@ -299,8 +302,8 @@ sade('changelog', true)
 
             // try setting previous tag based on current tag
             if (gitSemverTags.includes(currentTag ?? '')) {
-              const { version } = key
-              previousTag = gitSemverTags[gitSemverTags.indexOf(version!) + 1]
+              const { version = '' } = key
+              previousTag = gitSemverTags[gitSemverTags.indexOf(version) + 1]
               if (!previousTag) previousTag = last_commit?.hash ?? undefined
             }
           } else {

package.json

@@ -30,6 +30,10 @@
       "import": "./dist/index.mjs",
       "require": "./dist/index.cjs"
     },
+    "./config": {
+      "import": "./dist/config/index.mjs",
+      "require": "./dist/config/index.cjs"
+    },
     "./package.json": "./package.json"
   },
   "main": "./dist/index.cjs",
@@ -72,7 +76,6 @@
     "typecheck:watch": "vitest typecheck"
   },
   "dependencies": {
-    "@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",

src/config/__tests__/config.spec.ts

@@ -0,0 +1,66 @@
+/**
+ * @file Unit Tests - config
+ * @module commitlint-config/config/tests/unit/config
+ */
+
+import TEST_SUBJECT from '../config'
+import parserPreset from '../parser-preset'
+import prompt from '../prompt'
+import rules from '../rules'
+
+describe('unit:config/config', () => {
+  describe('defaultIgnores', () => {
+    it('should set default ignore rules', () => {
+      expect(TEST_SUBJECT.defaultIgnores).to.be.true
+    })
+  })
+
+  describe('formatter', () => {
+    it('should be default report formatter', () => {
+      expect(TEST_SUBJECT.formatter).to.equal('@commitlint/format')
+    })
+  })
+
+  describe('helpUrl', () => {
+    it('should be default help URL', () => {
+      // Arrange
+      const expected: string =
+        'https://github.com/conventional-changelog/commitlint/#what-is-commitlint'
+
+      // Act + Expect
+      expect(TEST_SUBJECT.helpUrl).to.equal(expected)
+    })
+  })
+
+  describe('ignores', () => {
+    it('should not set additional ignore rules', () => {
+      expect(TEST_SUBJECT.ignores).to.be.an('array').of.length(0)
+    })
+  })
+
+  describe('parserPreset', () => {
+    it('should set commit parser preset', () => {
+      expect(TEST_SUBJECT)
+        .to.have.property('parserPreset')
+        .deep.equal(parserPreset)
+    })
+  })
+
+  describe('plugins', () => {
+    it('should not push additional plugins', () => {
+      expect(TEST_SUBJECT.plugins).to.be.an('array').of.length(0)
+    })
+  })
+
+  describe('prompt', () => {
+    it('should set prompt configuration', () => {
+      expect(TEST_SUBJECT).to.have.property('prompt').deep.equal(prompt)
+    })
+  })
+
+  describe('rules', () => {
+    it('should set commit rules', () => {
+      expect(TEST_SUBJECT).to.have.property('rules').deep.equal(rules)
+    })
+  })
+})

src/config/config.ts

@@ -0,0 +1,34 @@
+/**
+ * @file Config - config
+ * @module commitlint-config/config/config
+ */
+
+import type { Config } from '#src/interfaces'
+import defaultIgnores from './default-ignores'
+import formatter from './formatter'
+import helpUrl from './help-url'
+import ignores from './ignores'
+import parserPreset from './parser-preset'
+import plugins from './plugins'
+import prompt from './prompt'
+import rules from './rules'
+
+/**
+ * `commitlint` configuration object.
+ *
+ * @see https://commitlint.js.org/#/reference-configuration
+ *
+ * @const {Config} config
+ */
+const config: Config = {
+  defaultIgnores,
+  formatter,
+  helpUrl,
+  ignores,
+  parserPreset,
+  plugins,
+  prompt,
+  rules
+}
+
+export default config

src/config/index.ts

@@ -3,6 +3,7 @@
  * @module commitlint-config/config
  */
 
+export { default as config, default } from './config'
 export { default as defaultIgnores } from './default-ignores'
 export { default as formatter } from './formatter'
 export { default as helpUrl } from './help-url'

tsconfig.json

@@ -31,7 +31,8 @@
       "#fixtures/*": ["__fixtures__/*"],
       "#src": ["src/index"],
       "#src/*": ["src/*"],
-      "#tests/*": ["__tests__/*"]
+      "#tests/*": ["__tests__/*"],
+      "@flex-development/commitlint-config": ["src/index"]
     },
     "preserveConstEnums": true,
     "preserveSymlinks": false,

typings/conventional-commits-parser/index.d.ts

@@ -1,27 +1,11 @@
-import type { Nilable, Nullable } from '@flex-development/tutils'
+import type { Commit } from '@flex-development/commitlint-config'
 import {} from 'conventional-commits-parser'
 
 declare module 'conventional-commits-parser' {
-  export interface CommitBase {
-    body: Nullable<string>
-    committerDate: string
-    footer: Nullable<string>
-    gitTags?: Nilable<string>
-    hash: string
-    header: Nullable<string>
-    mentions: string[]
-    merge: Nullable<string>
-    notes: import('conventional-commits-parser').Commit.Note[]
-    references: import('conventional-commits-parser').Commit.Reference[]
-    revert: Nullable<import('conventional-commits-parser').Commit.Revert>
-    scope?: Nilable<string>
-    subject?: Nilable<string>
-    type?: Nilable<string>
-  }
+  export interface CommitBase extends Commit {}
 
   export interface ICommit extends CommitBase {
     raw: CommitBase
-    shortHash: string
     version?: string | undefined
   }
 }

yarn.lock

@@ -190,15 +190,6 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@commitlint/config-conventional@npm:17.4.4":
-  version: 17.4.4
-  resolution: "@commitlint/config-conventional@npm:17.4.4"
-  dependencies:
-    conventional-changelog-conventionalcommits: "npm:^5.0.0"
-  checksum: 1dce765072a61354a1e17078441c2422b0166bc0c974d082835e76b0117e787b426063e5c978c68a59c8ebf46de9f499157902de18122538432a12efcc7dcce2
-  languageName: node
-  linkType: hard
-
 "@commitlint/config-validator@npm:^17.4.4":
   version: 17.4.4
   resolution: "@commitlint/config-validator@npm:17.4.4"
@@ -1155,7 +1146,6 @@ __metadata:
   resolution: "@flex-development/commitlint-config@workspace:."
   dependencies:
     "@commitlint/cli": "npm:17.4.4"
-    "@commitlint/config-conventional": "npm:17.4.4"
     "@commitlint/lint": "npm:17.4.4"
     "@commitlint/types": "npm:17.4.4"
     "@flex-development/mkbuild": "npm:1.0.0-alpha.14"
@@ -3441,7 +3431,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"conventional-changelog-conventionalcommits@npm:5.0.0, conventional-changelog-conventionalcommits@npm:^5.0.0":
+"conventional-changelog-conventionalcommits@npm:5.0.0":
   version: 5.0.0
   resolution: "conventional-changelog-conventionalcommits@npm:5.0.0"
   dependencies: