@commitlint/cli

What is @commitlint/cli?

The @commitlint/cli package is a command-line tool that helps enforce conventions on commit messages. It allows teams to follow a predefined set of rules for commit messages, ensuring consistency and readability across the project's history. This is particularly useful in projects that use semantic versioning or need to generate changelogs automatically.

What are @commitlint/cli's main functionalities?

Linting Commit Messages

This command lints the commit message found in the file that `--edit` points to (defaults to the last commit message). It checks the message against the configured commitlint rules and returns errors or warnings based on those rules.

commitlint --edit

Configuring Commitlint

This code snippet shows how to configure commitlint in a project. It uses the `config-conventional` preset, which enforces conventional commit message guidelines. This configuration is typically placed in a `commitlint.config.js` file at the root of the project.

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

Integrating with Husky for Git Hooks

This JSON configuration integrates commitlint with Husky, a tool for managing Git hooks. It sets up a `commit-msg` hook that runs commitlint against commit messages, using the `HUSKY_GIT_PARAMS` environment variable to pass the commit message file path to commitlint. This ensures that all commit messages are linted before they are finalized.

{
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  }
}

Other packages similar to @commitlint/cli

standard-version

Similar to @commitlint/cli in its goal to enforce standard commit practices, standard-version is focused on versioning and CHANGELOG generation based on semantic versioning (semver) and conventional commit messages. It does not lint commit messages but automates versioning and changelog creation.

commitizen

Commitizen is a tool that prompts developers to fill out any required commit fields at commit time, ensuring that commits are formatted properly. While @commitlint/cli lints commit messages for compliance with a standard, commitizen helps in creating those standardized commit messages in the first place.

pre-commit

pre-commit is a framework for managing and maintaining multi-language pre-commit hooks. It can be used to lint commit messages among other things, similar to how @commitlint/cli is used. However, pre-commit is more general-purpose and can be used for a wide range of pre-commit checks beyond commit message linting.

README

Lint commit messages

@commitlint/cli

Getting started

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

Consult docs/cli for comprehensive documentation.