Skip to main content

Documentation

Welcome to Lintje! A Git linter made for people. Lintje will help you and your team write better commit messages, branch and Pull Requests.

This documentation section will get you started. Use the side bar on the left (or at the bottom of this page) to read more about Lintje.

Get started with Lintje

If you need help, have any questions, feature requests or any feedback, please contact me.

Example Lintje output

Lintje has descriptive output to helps you recognize issues more easily and know how to fix them.

$ lintje
Error[SubjectTicketNumber]: The subject contains a ticket number
  883a427:1:10: Fix bug. Closes #123
    |
  1 | Fix bug. Closes #123
    |          ----------- Remove the ticket number from the subject
   ~~~
  3 | Closes #123
    | +++++++++++ Move the ticket number to the message body
    |
    = help: https://r.lintje.dev/r/SubjectTicketNumber

Error[SubjectCliche]: The subject does not explain the change in much detail
  9a2ae29:1:1: Fix bug
    |
  1 | Fix bug
    | ^^^^^^^ Describe the change in more detail
    |
    = help: https://r.lintje.dev/r/SubjectCliche

Error[MessagePresence]: No message body was found
  9a2ae29:3:1: Fix bug
    |
  1 | Fix bug
  2 |
  3 |
    | +++ Add a message body with context about the change and why it was made
    |
    = help: https://r.lintje.dev/r/MessagePresence

Error[BranchNameTicketNumber]: A ticket number was detected in the branch name
  Branch:1: fix-123
  |
  | fix-123
  | ------- Remove the ticket number from the branch name or expand the branch name with more details
  |
  = help: https://r.lintje.dev/r/BranchNameTicketNumber

2 commits and branch inspected, 4 errors detected