build: update commitlint configuration file

vgbr-dev · Jun 12, 2023 · df82f55 · df82f55
1 parent eb0f093
commit df82f55
Showing 1 changed file with 18 additions and 2 deletions.
diff --git a/commitlint.config.js b/commitlint.config.js
@@ -2,7 +2,23 @@
  * @file Manages the commitlint module configuration.
  */
 
-// ━━	EXPORT MODULE	━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
-module.exports = {
+// ━━ TYPE DEFINITIONS ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+/**
+ * User configuration for commitlint.
+ *
+ * @private
+ * @typedef {import('@commitlint/types').UserConfig} UserConfig
+ */
+
+// ━━ MODULE ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+/**
+ * Configuration object for commitlint.
+ *
+ * @type {UserConfig}
+ */
+const commitlintConfiguration = {
   extends: ['@commitlint/config-conventional'],
 };
+
+// ━━	EXPORT MODULE	━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+module.exports = commitlintConfiguration;