Lint your conventional commits
@commitlint/config-conventional
Shareable commitlint
config enforcing conventional commits.
Use with @commitlint/cli and @commitlint/prompt-cli.
Getting started
npm install --save-dev @commitlint/config-conventional @commitlint/cli
echo "module.exports = {extends: ['@commitlint/config-conventional']};" > commitlint.config.js
Rules
Problems
The following rules are considered problems for @commitlint/config-conventional
and will yield a non-zero exit code when not met.
Consult docs/rules for a list of available rules.
type-enum
-
condition: type
is found in value
-
rule: always
-
level: error
-
value
[
'build',
'chore',
'ci',
'docs',
'feat',
'fix',
'perf',
'refactor',
'revert',
'style',
'test'
];
echo "foo: some message"
echo "fix: some message"
type-case
- description:
type
is in case value
- rule:
always
- level:
error
- value
'lowerCase'
echo "FIX: some message"
echo "fix: some message"
type-empty
- condition:
type
is empty - rule:
never
- level:
error
echo ": some message"
echo "fix: some message"
subject-case
- condition:
subject
is in one of the cases ['sentence-case', 'start-case', 'pascal-case', 'upper-case']
- rule:
never
- level:
error
echo "fix(SCOPE): Some message"
echo "fix(SCOPE): Some Message"
echo "fix(SCOPE): SomeMessage"
echo "fix(SCOPE): SOMEMESSAGE"
echo "fix(scope): some message"
echo "fix(scope): some Message"
subject-empty
- condition:
subject
is empty - rule:
never
- level:
error
echo "fix:"
echo "fix: some message"
subject-full-stop
- condition:
subject
ends with value
- rule:
never
- level:
error
- value
'.'
echo "fix: some message."
echo "fix: some message"
- condition:
header
has value
or 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"
echo "fix: some message"
- condition:
footer
should have a leading blank line - rule:
always
- level:
warning
echo "fix: some message
BREAKING CHANGE: It will be significant"
echo "fix: some message
BREAKING CHANGE: It will be significant"
- condition:
footer
each line has value
or less characters - rule:
always
- level:
error
- value
100
echo "fix: some message
BREAKING CHANGE: footer with multiple lines
has a message that is way too long and will break the line rule 'line-max-length' by several characters"
echo "fix: some message
BREAKING CHANGE: footer with multiple lines
but still no line is too long"
body-leading-blank
- condition:
body
should have a leading blank line - rule:
always
- level:
warning
echo "fix: some message
body"
echo "fix: some message
body"
body-max-line-length
- condition:
body
each line has value
or less characters - rule:
always
- level:
error
- value
100
echo "fix: some message
body with multiple lines
has a message that is way too long and will break the line rule 'line-max-length' by several characters"
echo "fix: some message
body with multiple lines
but still no line is too long"