Lint your conventional commits
Shareable commitlint config enforcing conventional commits.
Use with @commitlint/cli and @commitlint/prompt-cli.
npm install --save-dev @commitlint/config-conventional @commitlint/cli
echo"export default {extends: ['@commitlint/config-conventional']};"> commitlint.config.jsThe following rules are considered problems for @commitlint/config-conventional and will yield a non-zero exit code when not met.
Consult Rules reference for a list of available rules.
condition:
typeis found in valuerule:
alwayslevel:
errorvalue
[ 'build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test' ];
echo"foo: some message"# failsecho"fix: some message"# passes- description:
typeis in casevalue - rule:
always - level:
error - value
'lowerCase'
echo"FIX: some message"# failsecho"fix: some message"# passes- condition:
typeis empty - rule:
never - level:
error
echo": some message"# failsecho"fix: some message"# passes- condition:
subjectis in one of the cases['sentence-case', 'start-case', 'pascal-case', 'upper-case'] - rule:
never - level:
error
echo"fix(SCOPE): Some message"# failsecho"fix(SCOPE): Some Message"# failsecho"fix(SCOPE): SomeMessage"# failsecho"fix(SCOPE): SOMEMESSAGE"# failsecho"fix(scope): some message"# passesecho"fix(scope): some Message"# passes- condition:
subjectis empty - rule:
never - level:
error
echo"fix:"# failsecho"fix: some message"# passes- condition:
subjectends withvalue - rule:
never - level:
error - value
'.'
echo"fix: some message."# failsecho"fix: some message"# passes- condition:
headerhasvalueor less characters - rule:
always - level:
error - value
100
echo"fix: some message that is way too long and breaks the line max-length by several characters"# failsecho"fix: some message"# passes- condition:
footershould have a leading blank line - rule:
always - level:
warning
echo"fix: some messageBREAKING CHANGE: It will be significant"# warningecho"fix: some messageBREAKING CHANGE: It will be significant"# passes- condition:
footereach line hasvalueor less characters - rule:
always - level:
error - value
100
echo"fix: some messageBREAKING CHANGE: footer with multiple lineshas a message that is way too long and will break the line rule 'line-max-length' by several characters"# failsecho"fix: some messageBREAKING CHANGE: footer with multiple linesbut still no line is too long"# passes- condition:
bodyshould have a leading blank line - rule:
always - level:
warning
echo"fix: some messagebody"# warningecho"fix: some messagebody"# passes- condition:
bodyeach line hasvalueor less characters - rule:
always - level:
error - value
100
echo"fix: some messagebody with multiple lineshas a message that is way too long and will break the line rule 'line-max-length' by several characters"# failsecho"fix: some messagebody with multiple linesbut still no line is too long"# passes