Lintje is an opinionated linter for Git. It lints commit messages based on a preconfigured set of rules focussed on promoting communication between people. The idea is to write commits meant for other people reading them during reviews and debug sessions 2+ months from now.
Given the last commit in a project is this:
Fix bug
When running lintje to lint the last commit, the output will be:
``` $ lintje 6162010: Fix bug SubjectCliche: Reword the subject to explain what bug was fixed. MessagePresence: Add a message body to provide more context about the change and why it was made.
1 commit inspected, 2 violations detected ```
For more examples, see the usage section.
To install Lintje on macOS use the Homebrew tap.
brew tap tombruijn/lintje
brew install lintje
Whenever a new version comes out run the following:
brew update
brew upgrade lintje
Or install it manually by downloading the archive from the latest release on the releases page for the appropriate system. See the list of installation targets.
Once downloaded extract it to a directory in your $PATH so the lintje
executable is available in any directory from the command line.
To install Lintje on Linux download the archive from the latest release on the releases page for the appropriate system. See the list of installation targets.
Once downloaded extract it to a directory in your $PATH so the lintje
executable is available in any directory from the command line.
To install Lintje on Microsoft Windows download the archive from the latest release on the releases page for the appropriate system. See the list of installation targets.
Once downloaded extract it to a directory in your PATH so the lintje.exe
executable is available in any directory from the command line.
x86_64-apple-darwin)aarch64-apple-darwin) (Apple Silicon)x86_64-unknown-linux-gnu)aarch64-unknown-linux-gnu)x86_64-unknown-linux-musl)aarch64-unknown-linux-musl)x86_64-pc-windows-gnu)```
lintje
lintje HEAD
lintje 3a561ef766c2acfe5da478697d91758110b8b24c
lintje HEAD~5..HEAD
lintje main..develop ```
It's recommended to add Lintje to your CI setup to lint the range of commits added by a Pull Request or job.
Lintje will exit with the following status codes in these situations:
0 (Success) - No violations have been found. The commit is accepted.1 (Failure) - One or more violations have been found. The commit is not
accepted.2 (Error) - An internal error occurred and the program had to exit. This is
probably a bug, please report it in the issue tracker.To lint the commit locally immediately after writing the commit message, use a Git hook. To add it, run the following:
echo "lintje --hook-message-file=\$1" >> .git/hooks/commit-msg
chmod +x .git/hooks/commit-msg
If Lintje fails the commit is aborted. The message you entered is available
in .git/COMMIT_EDITMSG and you can restart your commit message with:
git commit --edit --file=.git/COMMIT_EDITMSG
Personally I don't like how it fails the commit process and makes the commit message harder to reach to use again. It also makes making fixup commits really difficult. Instead I prefer not failing the commit hook and amending the commit afterwards to fix any issues that came up. The example below will have Lintje output the issues it found, but still make the commit. You can then amend the commit to fix any issues it found afterwards.
echo "lintje --hook-message-file=\$1 || echo \"\\\nLintje failure\"" >> .git/hooks/commit-msg
chmod +x .git/hooks/commit-msg
It's possible to set up an alias with Git to use git lint as the command
instead, or any other alias you prefer.
Set up your alias with the following line.
git config --global alias.lint '!lintje'
You'll then be able to call it like the examples below and any other methods listed in usage.
git lint
git lint main..develop
For more information on which rules are validated on, see the rules docs page.
Lintje does not have a configuration file where you can enable/disable/configure certain rules for an entire project.
Instead it's possible to ignore specific rules per commit.
It's possible to ignore certain rules for a commit, but this be used very infrequently. If you think Lintje should handle a certain scenario better, please create an issue explaining your use case.
To ignore a rule in a specific commit, use the magic lintje:disable comment.
Start a new line (preferably at the end of the commit message) that starts with
lintje:disable and continue specifying the rule you want to ignore, such as:
lintje:disable SubjectPunctuation.
Example commit with multiple ignored rules:
``` This is a commit subject!!
This is a commit message line 1. Here is some more content of the commit message is very long for valid reasons.
lintje:disable SubjectPunctuation lintje:disable MessageLineTooLong ```
(The above is a bad commit, please don't use the disabling of rules this way.)
Make sure Rust is installed before continuing.
cargo build
cargo test
Docker is required to build all the different target releases using cross.
To build all different targets, run the build script:
rake build
The build output can be found in the dist/ directory.
Before release all the supported targets will be build. See Building for more information about the build step.
To release all different targets, run the release script:
rake release
The release will be pushed to GitHub.
Finally update the Lintje Homebrew tap.
This project has a Code of Conduct and contributors are expected to adhere to it.