Shareable commitlint config enforcing conventional commits with rules from @insurgent/conventional-changelog-preset. Use with @commitlint/cli and @commitlint/prompt-cli.
npm install --save-dev @insurgent/commitlint-config @commitlint/cli echo '{"extends": ["@insurgent/commitlint-config"]}' > .commitlintrcThe following rules are considered problems for @insurgent/commitlint-config and will yield a non-zero exit code when not met.
Consult docs/rules for a list of available rules.
-
condition:
typeis found in value -
rule:
always -
level:
error -
value
[ 'build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test' ];
echo "foo: some message" # fails echo "fix: some message" # passes- description:
typeis in casevalue - rule:
always - level:
error - value
'lowerCase'
echo "FIX: some message" # fails echo "fix: some message" # passes- condition:
typeis empty - rule:
never - level:
error
echo ": some message" # fails echo "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" # fails echo "fix(SCOPE): Some Message" # fails echo "fix(SCOPE): SomeMessage" # fails echo "fix(SCOPE): SOMEMESSAGE" # fails echo "fix(scope): some message" # passes echo "fix(scope): some Message" # passes- condition:
subjectis empty - rule:
never - level:
error
echo "fix:" # fails echo "fix: some message" # passes- condition:
subjectends withvalue - rule:
never - level:
error - value
'.' echo "fix: some message." # fails echo "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" # fails echo "fix: some message" # passes- condition:
footershould have a leading blank line - rule:
always - level:
warning
echo "fix: some message BREAKING CHANGE: It will be significant" # warning echo "fix: some message BREAKING CHANGE: It will be significant" # passes- condition:
footereach line hasvalueor 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" # fails echo "fix: some message BREAKING CHANGE: footer with multiple lines but still no line is too long" # passes- condition:
bodyshould have a leading blank line - rule:
always - level:
warning
echo "fix: some message body" # warning echo "fix: some message body" # passes- condition:
bodyeach line hasvalueor 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" # fails echo "fix: some message body with multiple lines but still no line is too long" # passes