Description

This brings two additional rules to the table; header-matches and subject-matches which are given a string regex to match against the header and subject respectively.

Motivation and Context

The motivation behind this is more about ease-of-use when granular customization is needed. While I'm sure, the same goal can be achieved using custom parsers, I found myself not wanting to redefine headers and subjects in parser presets. I just needed more customization power.

While this might suit a plugin, I felt like it could also be a good fit for core rules as it opens up endless possibilities for customization.

Usage examples

// commitlint.config.js
module.exports = {
 'subject-matches': [2, 'always', '^[A-Z]{1}.+\\.(\\s#\\d+)?$'],
 'header-matches': [2, 'always', '^(Feat|Bug):\\s[A-Z]{1}.+\\.(\\s#\\d+)?$']
};

echo "Header. #420" | commitlint # passes
echo "header #420" | commitlint # fails
echo "Feat: Add new rules. #819" | commitlint # passes

How Has This Been Tested?

Added new test suites.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.