feat(config): allow custom error message for pattern validation

adds "msg-pattern-error" as a available option in the config object to throw a custom error message when the "msg-pattern" validation fails
bahmutov · Feb 22, 2017 · 4bfc792 · 4bfc792
1 parent 70c2b20
commit 4bfc792
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 10 deletions.
diff --git a/bin/commit-msg.js b/bin/commit-msg.js
@@ -13,6 +13,14 @@ function checkMessageAgainstPattern(msg, pattern) {
   var regex = new RegExp(pattern);
 
   if (!regex.test(msg)) {
+
+    var msgError = preGit.customMsgPatternError();
+
+    if(msgError) {
+      console.error(msgError);
+      console.error('');
+    }
+
     log('invalid commit message, must match the following pattern: ' + pattern, msg);
     process.exit(-1);
   }

diff --git a/src/pre-git.js b/src/pre-git.js
@@ -143,6 +143,20 @@ function getConfig() {
   return pkg.config && pkg.config[packageName];
 }
 
+function getConfigProperty(propertyName) {
+  const config = getConfig();
+  if (!config) {
+    return false;
+  }
+  const property = config[propertyName];
+
+  if (!property) {
+    return false;
+  }
+
+  return property;
+}
+
 function hasEnabledOption(config) {
   return 'enabled' in config;
 }
@@ -362,17 +376,12 @@ function pickWizard() {
 }
 
 function customCommitMsgPattern() {
-  const config = getConfig();
-  if (!config) {
-    return false;
-  }
-  const msgPattern = config['msg-pattern'];
+  return getConfigProperty('msg-pattern');
 
-  if (!msgPattern) {
-    return false;
-  }
+}
 
-  return msgPattern;
+function customCommitMsgPatternError() {
+  return getConfigProperty('msg-pattern-error');
 }
 
 module.exports = {
@@ -382,7 +391,8 @@ module.exports = {
   printError: printError,
   wizard: pickWizard,
   hasUntrackedFiles: hasUntrackedFiles,
-  customMsgPattern: customCommitMsgPattern
+  customMsgPattern: customCommitMsgPattern,
+  customMsgPatternError: customCommitMsgPatternError
 };
 
 if (!module.parent) {