commitlint

module
v1.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 24, 2025 License: MIT

README




Latest Release GoDoc Build Status Go report card
Documentation Discord


A lightweight, fast, and cross-platform CLI tool for linting Git commit messages.

Linting commit messages helps maintain a consistent commit history, which is critical for readability, automation, and collaboration across teams. commitlint ensures your commits follow a defined convention, making your Git logs cleaner and easier to work with.

Features

  • Fast and lightweight: Built for performance.
  • 💻 Cross-platform support: Works on Windows, macOS, and Linux.
  • 📦 Easy installation: Install with a single command per OS.
  • 🔧 Project-level integration: Add to your project with commitlint install.
  • 💉 Plugin system: Simple & intuitive.

Commitlint in action



Contributing

We welcome contributions! Please fork the repository and submit a pull request. Be sure your commits follow the linting rules — after all, that's the point!


Troubleshooting

  • CLI not found after install?
    Make sure the install location is in your system’s PATH.

License

This project is licensed under the MIT License.


Directories

Path Synopsis
cmd
commitlint command
internal
Plugin loading code.
Plugin loading code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL