Feature/read msg regex from config (#163)

* feat: make the message RegEx configurable

* feat: add configurable merge RegEx

* refactor

---------

Co-authored-by: insurancer591 <148952341+insurancer591@users.noreply.github.com>

Author: qoomon

lib/commands/commandChangelog.js

@@ -62,7 +62,7 @@ exports.handler = async function (argv) {
         includeInvalidCommits: config.changelog.includeInvalidCommits,
         commitTypes: config.changelog.commitTypes,
         commitScopes: config.changelog.commitScopes,
-        commitIgnoreRegex: new RegExp(config.changelog.commitIgnoreRegexPattern, "m")
+        commitIgnoreRegex: config.changelog.commitIgnoreRegex(),
     });
 
     // ------ output -------------------------------------------------

lib/commands/config.js

@@ -26,13 +26,21 @@ function load(configFile) {
         const conventionOverride = configOverride.convention;
         conventionConfig.releaseTagGlobPattern = conventionOverride.releaseTagGlobPattern ||
             conventionConfig.releaseTagGlobPattern;
+
+        conventionConfig.msgRegex = RegExp(conventionOverride.commitMessageRegexPattern) || conventionConfig.msgRegex;
         conventionConfig.commitTypes = conventionOverride.commitTypes || conventionConfig.commitTypes;
         conventionConfig.featureCommitTypes = conventionOverride.featureCommitTypes || conventionConfig.featureCommitTypes;
         conventionConfig.commitScopes = conventionOverride.commitScopes || conventionConfig.commitScopes;
+        
         // Legacy support convention.issueRegexPattern
         config.changelog.issueRegexPattern = conventionOverride.issueRegexPattern || config.changelog.issueRegexPattern;
     }
 
+    // check for mandatory capturing groups
+    if (!hasAllCapturingGroups(config.convention.msgRegex, ['type', 'scope', 'breaking', 'description'])) {
+        throw new Error(`msgRegex: ${config.convention.msgRegex.source} does not have all mandatory capture groups ('type', 'scope', 'breaking', 'description')`);
+    }
+
     if (configOverride.changelog) {
         const changelogConfig = config.changelog;
         const changelogOverride = configOverride.changelog;
@@ -106,7 +114,7 @@ function defaultConfig() {
     // match only release version e.g. 1.2.3 ((?:[^-]|$) ignores pre-release versions e.g. 1.2.3-SNAPSHOT)
     config.convention.semanticVersionRegex = /(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)/;
 
-    config.changelog.commitIgnoreRegex = () => RegExp(config.changelog.commitIgnoreRegexPattern || '(?!)');
+    config.changelog.commitIgnoreRegex = () => RegExp(config.changelog.commitIgnoreRegexPattern || '(?!)',"m");
 
     config.changelog.issueRegex = () => RegExp(
         "(?<=(^|\\s))" + (config.changelog.issueRegexPattern || '(?!)') + "(?=(\\s|$))",
@@ -116,9 +124,15 @@ function defaultConfig() {
     return config;
 }
 
+
+function hasAllCapturingGroups(exp, groups) {
+  return groups.every(group => exp.source.includes(`(?<${group}>`));
+}
+
 module.exports = {
     defaultPath,
     templatePath,
     load,
     defaultConfig,
+    hasAllCapturingGroups
 }

lib/gitCommitConvention.js

@@ -87,9 +87,13 @@ module.exports = function (convention, commitAnchor = 'HEAD') {
         const msgMatch = commit.subject.match(convention.msgRegex);
         if (msgMatch) {
             conventionalSubject.type = msgMatch.groups.type;
+            if (!conventionalSubject.type)
+                throw new Error(`Invalid msgRegex: ${convention.msgRegex}. Capturing group 'type' is empty.`);
             conventionalSubject.scope = msgMatch.groups.scope === '' ? undefined : msgMatch.groups.scope;
             conventionalSubject.breaking = msgMatch.groups.breaking === '!';
             conventionalSubject.description = msgMatch.groups.description;
+            if (!conventionalSubject.description)
+                throw new Error(`Invalid msgRegex: ${convention.msgRegex}. Capturing group 'description' is empty.`);
         } else {
             const msgMergeMatch = getFirstMatch(commit.subject, convention.msgMergeRegexList);
             if (msgMergeMatch) {

test/commands/config.test.js

@@ -0,0 +1,32 @@
+const config = require("../../lib/commands/config");
+
+
+test("config - message RegEx", async () => {
+    // GIVEN
+    const requiredCaptureGroups = ['type', 'scope', 'breaking', 'description'];
+    
+
+    // WHEN
+    const validMsgRegex = /^(?<type>\w+)(?:\((?<scope>[^()]+)\))?(?<breaking>!)?:\s*(?<description>.+)/i;
+    const invalidMsgRegex = /(?:\((?<scope>[^()]+)\))?(?<breaking>!)?:\s*(?<description>.+)/i;
+
+    // THEN
+    expect(config.hasAllCapturingGroups(validMsgRegex, requiredCaptureGroups)).toBe(true);
+    expect(config.hasAllCapturingGroups(invalidMsgRegex, requiredCaptureGroups)).toBe(false);
+});
+
+test("config - merge RegEx", async () => {
+    // GIVEN
+    const requiredCaptureGroups = ['description'];
+    
+
+    // WHEN
+    const validMsgRegex = /^Merge (?<description>.+)/i; 
+    const invalidMsgRegex = /^Merge (?<type>.+)/i;
+
+    // THEN
+    expect(config.hasAllCapturingGroups(validMsgRegex, requiredCaptureGroups)).toBe(true);
+    expect(config.hasAllCapturingGroups(invalidMsgRegex, requiredCaptureGroups)).toBe(false);
+});
+
+