1. module validate-commit-msg
   1. function validate-commit-msg (raw)
   2. object validate-commit-msg.config
   3. object validate-commit-msg.validateMessage
2. module validate-commit-msg.config
   1. function validate-commit-msg.config.getConfig ()
   2. function validate-commit-msg.config.getConfigObject (filename)
   3. function validate-commit-msg.config.getPackageConfig ()
   4. function validate-commit-msg.config.getRcConfig ()
3. module validate-commit-msg.validateMessage
   1. function validate-commit-msg.validateMessage (raw)
   2. object validate-commit-msg.validateMessage.config

module validate-commit-msg

function validate-commit-msg (raw)

• description and source-code

  function validateMessage(raw) {
    var types = config.types = config.types || 'conventional-commit-types';
  
    // resolve types from a module
    if (typeof types === 'string' && types !== '*') {
      types = Object.keys(require(types).types);
    }
  
    var messageWithBody = (raw || '').split('\n').filter(function(str) {
      return str.indexOf('#') !== 0;
    }).join('\n');
  
    var message = messageWithBody.split('\n').shift();
  
    if (message === '') {
      console.log('Aborting commit due to empty commit message.');
      return false;
    }
  
    var isValid = true;
  
    if (MERGE_COMMIT_PATTERN.test(message)) {
      console.log('Merge commit detected.');
      return true
    }
  
    if (IGNORED.test(message)) {
      console.log('Commit message validation ignored.');
      return true;
    }
  
    var match = PATTERN.exec(message);
  
    if (!match) {
      error('does not match "<type>(<scope>): <subject>" !');
      isValid = false;
    } else {
      var firstLine = match[1];
      var squashing = !!match[2];
      var type = match[3];
      var scope = match[4];
      var subject = match[5];
  
      var SUBJECT_PATTERN = new RegExp(config.subjectPattern || '.+');
      var SUBJECT_PATTERN_ERROR_MSG = config.subjectPatternErrorMsg || 'subject does not match subject pattern!';
  
      if (firstLine.length > MAX_LENGTH && !squashing) {
        error('is longer than %d characters !', MAX_LENGTH);
        isValid = false;
      }
  
      // If should auto fix type then do it here
      if (config.autoFix) {
        type = lowercase(type);
      }
  
      if (types !== '*' && types.indexOf(type) === -1) {
        error('"%s" is not allowed type ! Valid types are: %s', type, types.join(', '));
        isValid = false;
      }
  
      isValid = validateScope(isValid, scope);
  
      if (config.autoFix) {
        subject = lowercaseFirstLetter(subject);
      }
  
      if (!SUBJECT_PATTERN.exec(subject)) {
        error(SUBJECT_PATTERN_ERROR_MSG);
        isValid = false;
      }
    }
  
    // Some more ideas, do want anything like this ?
    // - Validate the rest of the message (body, footer, BREAKING CHANGE annotations)
    // - auto add empty line after subject ?
    // - auto remove empty () ?
    // - auto correct typos in type ?
    // - store incorrect messages, so that we can learn
  
    isValid = isValid || config.warnOnFail;
  
    if (isValid) { // exit early and skip messaging logics
      return true;
    }
  
    var argInHelp = config.helpMessage && config.helpMessage.indexOf('%s') !== -1;
  
    if (argInHelp) {
      console.log(config.helpMessage, messageWithBody);
    } else if (message) {
      console.log(message);
    }
  
    if (!argInHelp && config.helpMessage) {
      console.log(config.helpMessage);
    }
  
    return false;
  }

• example usage

  n/a

module validate-commit-msg.config

function validate-commit-msg.config.getConfig ()

• description and source-code

  function getConfig() {
    return getRcConfig() || getPackageConfig() || {};
  }

• example usage

  n/a

function validate-commit-msg.config.getConfigObject (filename)

• description and source-code

  function getConfigObject(filename) {
    try {
      var rcFile = findup.sync(process.cwd(), filename);
      return JSON.parse(fs.readFileSync(resolve(rcFile, filename)));
    } catch (e) {
      return null;
    }
  }

• example usage

  n/a

function validate-commit-msg.config.getPackageConfig ()

• description and source-code

  function getPackageConfig() {
    var configObject = getConfigObject('package.json');
    return configObject && configObject.config && configObject.config['validate-commit-msg'];
  }

• example usage

  n/a

function validate-commit-msg.config.getRcConfig ()

• description and source-code

  function getRcConfig() {
    return getConfigObject('.vcmrc');
  }

• example usage

  n/a

module validate-commit-msg.validateMessage

function validate-commit-msg.validateMessage (raw)

• description and source-code

  function validateMessage(raw) {
    var types = config.types = config.types || 'conventional-commit-types';
  
    // resolve types from a module
    if (typeof types === 'string' && types !== '*') {
      types = Object.keys(require(types).types);
    }
  
    var messageWithBody = (raw || '').split('\n').filter(function(str) {
      return str.indexOf('#') !== 0;
    }).join('\n');
  
    var message = messageWithBody.split('\n').shift();
  
    if (message === '') {
      console.log('Aborting commit due to empty commit message.');
      return false;
    }
  
    var isValid = true;
  
    if (MERGE_COMMIT_PATTERN.test(message)) {
      console.log('Merge commit detected.');
      return true
    }
  
    if (IGNORED.test(message)) {
      console.log('Commit message validation ignored.');
      return true;
    }
  
    var match = PATTERN.exec(message);
  
    if (!match) {
      error('does not match "<type>(<scope>): <subject>" !');
      isValid = false;
    } else {
      var firstLine = match[1];
      var squashing = !!match[2];
      var type = match[3];
      var scope = match[4];
      var subject = match[5];
  
      var SUBJECT_PATTERN = new RegExp(config.subjectPattern || '.+');
      var SUBJECT_PATTERN_ERROR_MSG = config.subjectPatternErrorMsg || 'subject does not match subject pattern!';
  
      if (firstLine.length > MAX_LENGTH && !squashing) {
        error('is longer than %d characters !', MAX_LENGTH);
        isValid = false;
      }
  
      // If should auto fix type then do it here
      if (config.autoFix) {
        type = lowercase(type);
      }
  
      if (types !== '*' && types.indexOf(type) === -1) {
        error('"%s" is not allowed type ! Valid types are: %s', type, types.join(', '));
        isValid = false;
      }
  
      isValid = validateScope(isValid, scope);
  
      if (config.autoFix) {
        subject = lowercaseFirstLetter(subject);
      }
  
      if (!SUBJECT_PATTERN.exec(subject)) {
        error(SUBJECT_PATTERN_ERROR_MSG);
        isValid = false;
      }
    }
  
    // Some more ideas, do want anything like this ?
    // - Validate the rest of the message (body, footer, BREAKING CHANGE annotations)
    // - auto add empty line after subject ?
    // - auto remove empty () ?
    // - auto correct typos in type ?
    // - store incorrect messages, so that we can learn
  
    isValid = isValid || config.warnOnFail;
  
    if (isValid) { // exit early and skip messaging logics
      return true;
    }
  
    var argInHelp = config.helpMessage && config.helpMessage.indexOf('%s') !== -1;
  
    if (argInHelp) {
      console.log(config.helpMessage, messageWithBody);
    } else if (message) {
      console.log(message);
    }
  
    if (!argInHelp && config.helpMessage) {
      console.log(config.helpMessage);
    }
  
    return false;
  }

• example usage

  n/a