@quatredeux/commit-convention v1.0.0

Lint your commits, Quatre Deux-style

Commit Convention

Shareable commitlint configuration enforcing Quatre Deux commit convention

Installation and configuration

npm install @commitlint/cli @quatredeux/commit-convention --save-dev
echo "module.exports = {extends: ['@quatredeux/commit-convention']};" > commitlint.config.js

Rules

The following rules are considered problems and will yield a non-zero exit code when not met.

type-enum

• condition: type is found in value
• rule: always
• level: error
• value: ['build', 'doc', 'feat', 'fix', 'perf', 'refac', 'style', 'test']

echo "foo: some message" # fails
echo "feat: some message" # passes

type-case

• description: type is in case value
• rule: always
• level: error
• value: 'lower-case'

echo "FEAT: some message" # fails
echo "feat: some message" # passes

type-empty

• condition: type is empty
• rule: never
• level: error

echo ": some message" # fails
echo "feat: some message" # passes

scope-case

• condition: scope is in case value
• rule: always
• level: error
• value: 'lower-case'

echo "feat(SCOPE): some message" # fails
echo "feat(scope): some message" # passes

subject-case

• condition: subject is one of value
• rule: never
• level: error
• value: ['sentence-case', 'start-case', 'pascal-case', 'upper-case']

echo "feat(SCOPE): Some message" # fails
echo "feat(SCOPE): Some Message" # fails
echo "feat(SCOPE): SomeMessage" # fails
echo "feat(SCOPE): SOMEMESSAGE" # fails
echo "feat(scope): some message" # passes
echo "feat(scope): some Message" # passes

subject-empty

• condition: subject is empty
• rule: never
• level: error

echo "feat:" # fails
echo "feat: some message" # passes

subject-full-stop

• condition: subject ends with value
• rule: never
• level: error
• value: '.'

echo "feat: some message." # fails
echo "feat: some message" # passes

header-max-length

• condition: header has value or less characters
• rule: always
• level: error
• value: 75

echo "feat: some message that is way too long and breaks the max-length rule by several characters" # fails
echo "feat: some message" # passes

body-max-line-length

• condition: body each line has value or less characters
• rule: always
• level: error
• value: 500

echo "feat: some message

body with multiple lines
has a message that is way too long but will not break the rule line-max-length to ensure the reason of the change is well explained" # passes

footer-max-line-length

• condition: footer each line has value or less characters
• rule: always
• level: error
• value: 100

echo "feat: some message

BREAKING CHANGE: footer with multiple lines
has a message that is way too long and will definitely break the rule max-line-length by several characters" # fails

echo "feat: some message

BREAKING CHANGE: footer with multiple lines
but still has a not too long message" # passes

body-leading-blank

• condition: body should have a leading blank line
• rule: always
• level: warning

echo "feat: some message
body message" # warning

echo "feat: some message

body message" # passes

footer-leading-blank

• condition: footer should have a leading blank line
• rule: always
• level: warning

echo "feat: some message
BREAKING CHANGE: It will break a lot" # warning

echo "feat: some message

BREAKING CHANGE: It will break a lot" # passes