config-conventional

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"# failsecho"fix: some message"# passes

type-case

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

  'lowerCase'
  

echo"FIX: some message"# failsecho"fix: some message"# passes

type-empty

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

echo": some message"# failsecho"fix: some message"# passes

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"# failsecho"fix(SCOPE): Some Message"# failsecho"fix(SCOPE): SomeMessage"# failsecho"fix(SCOPE): SOMEMESSAGE"# failsecho"fix(scope): some message"# passesecho"fix(scope): some Message"# passes

subject-empty

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

echo"fix:"# failsecho"fix: some message"# passes

subject-full-stop

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

'.'

echo"fix: some message."# failsecho"fix: some message"# passes

header-max-length

• 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"# failsecho"fix: some message"# passes

footer-leading-blank

• condition: footer should 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

footer-max-line-length

• condition: footer each line has value or 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

body-leading-blank

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

echo"fix: some messagebody"# warningecho"fix: some messagebody"# passes

body-max-line-length

• condition: body each line has value or 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