@commitlint/config-conventional

What is @commitlint/config-conventional?

The @commitlint/config-conventional npm package is used to enforce conventional commit messages. This package provides a set of rules that follow the Conventional Commits specification, which standardizes commit messages to make them more readable and to facilitate automatic generation of changelogs.

What are @commitlint/config-conventional's main functionalities?

Enforcing commit message structure

This code snippet is a configuration file that extends the rules from @commitlint/config-conventional. It is used to enforce a conventional commit message structure in your project.

module.exports = {extends: ['@commitlint/config-conventional']};

Linting commit messages

This command line example demonstrates how to lint a commit message using commitlint with the conventional configuration. It will check if the message follows the conventional commit format.

echo 'fix: correct minor typos in code' | npx commitlint

Integrating with commit hooks

This code snippet shows how to integrate commitlint with Husky's commit-msg hook to automatically lint each commit message before it is finalized.

husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

Other packages similar to @commitlint/config-conventional

standard-version

Similar to @commitlint/config-conventional, standard-version is a utility for versioning using semver and CHANGELOG generation powered by Conventional Commits. It differs in that it focuses on versioning and changelog generation rather than linting commit messages.

semantic-release

semantic-release automates the versioning and package publishing process based on semantic versioning and Conventional Commits, similar to @commitlint/config-conventional's adherence to the Conventional Commits specification. However, semantic-release encompasses the full release process, including determining the next version number, generating release notes, and publishing the package.

commitizen

commitizen is a tool that prompts developers to follow the Conventional Commits format when creating commit messages. It is complementary to @commitlint/config-conventional, which lints commit messages, whereas commitizen helps in crafting them.

README

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

type-case

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

  'lowerCase'
  

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

type-empty

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

echo ": some message" # fails
echo "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" # 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

subject-empty

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

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

subject-full-stop

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

'.'

echo "fix: some message." # fails
echo "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" # fails
echo "fix: some message" # passes

footer-leading-blank

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

footer-max-line-length

• 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" # fails

echo "fix: some message

BREAKING CHANGE: footer with multiple lines
but 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 message
body" # warning

echo "fix: some message

body" # passes

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" # fails

echo "fix: some message

body with multiple lines
but still no line is too long" # passes

Changelog

18.4.4 (2024-01-04)

Bug Fixes

• @commitlint/load: Remove unused @types/node dependency (#3801) (7b3f8b3)
• read: remove fs-extra usage and use fs/promises (#3803) (714be66)
• subject-full-stop false positive when using ellipsis (#3839) (b4246d6)
• update dependency fs-extra to v11.2.0 (#3799) (abb4da2)
• utils: remove fs-extra usage (#3804) (92f2237)