What problem does it solve?
Enforces a consistent commit message format so teams can generate changelogs, apply semantic versioning, and maintain a readable git history across repositories.
Core Features & Use Cases
- Installation and Environment Checks: Detects whether @commitlint/cli and @commitlint/config-conventional are available and attempts to install them when missing, with clear remediation guidance if installation fails.
- Config Detection and Fallbacks: Uses project-specific commitlint configuration when present and falls back to a sensible default configuration sourced from the included reference document.
- Message Validation and Reporting: Validates commit messages (from strings, files, or the last git commit), reports each failing rule with an explanation and concrete fix suggestions, and supports iterative re-validation.
- Use Case: Run as a pre-commit or CI check to block invalid messages, or use when preparing pull requests to ensure titles and messages follow team conventions.
Quick Start
Validate the most recent git commit message and receive precise failure reasons and suggested fixes for any Conventional Commits violations.