@commitlint/rules

What is @commitlint/rules?

@commitlint/rules is a package that provides a set of rules for linting commit messages. It helps enforce consistent commit message formats, which can be crucial for maintaining a clean and understandable project history. The package is highly configurable and can be integrated into various CI/CD pipelines to ensure commit message standards are met.

What are @commitlint/rules's main functionalities?

Enforcing Commit Message Format

This feature allows you to enforce specific formats for commit messages. The 'type-enum' rule ensures that the commit type is one of the specified values, while the 'subject-case' rule enforces that the subject is not in certain cases.

{"rules":{"type-enum":[2,"always",["feat","fix","docs","style","refactor","test","chore"]],"subject-case":[2,"never",["sentence-case","start-case","pascal-case","upper-case"]]}}

Custom Rules

You can define custom rules to enforce specific constraints on commit messages. For example, 'header-max-length' ensures that the commit header does not exceed 72 characters, and 'body-max-line-length' ensures that each line in the commit body does not exceed 100 characters.

{"rules":{"header-max-length":[2,"always",72],"body-max-line-length":[2,"always",100]}}

Integration with CI/CD

This feature allows you to integrate @commitlint/rules with your CI/CD pipeline. By adding a script to your package.json, you can ensure that commit messages are linted automatically during the commit process.

{"scripts":{"commitmsg":"commitlint -E HUSKY_GIT_PARAMS"}}

Other packages similar to @commitlint/rules

commitizen

Commitizen is a tool that helps you write standardized commit messages. It provides an interactive CLI that guides you through the commit process, ensuring that your commit messages adhere to a predefined format. Unlike @commitlint/rules, which focuses on linting existing commit messages, Commitizen helps you create them correctly in the first place.

semantic-release

Semantic-release automates the versioning and package publishing process based on the commit messages. It uses commit message conventions to determine the type of release (major, minor, patch) and generates changelogs automatically. While @commitlint/rules focuses on enforcing commit message standards, semantic-release leverages those standards to automate the release process.

husky

Husky is a tool that allows you to run scripts in response to Git hooks. It can be used in conjunction with @commitlint/rules to enforce commit message standards by running commitlint as a pre-commit or pre-push hook. While Husky itself does not provide commit message linting, it is a powerful tool for integrating commitlint into your workflow.

README

The README file is missing

Changelog

19.5.0 (2024-09-11)

Features

• cli: use special errorCode for missing rules/config #4142 (#4143) (d7070d8)