gitlint icon indicating copy to clipboard operation
gitlint copied to clipboard

Supported API?

Open nedbat opened this issue 4 years ago • 2 comments

I would like to collect metrics about commit message conformance in a large collection of repos (https://github.com/edx). Gitlint looks perfect for the "brains" of the measurement, but I think I need to use it as an API rather than a command-line tool.

Do you have plans for a supported public API to gitlint?

Details: I would like to categorize the commits into three buckets:

  • With a conforming message and a body
  • With a conforming message but no body
  • Without a conforming message

Then I'd like to graph that over time to see how the organization is improving.

nedbat avatar Apr 13 '21 12:04 nedbat

Thanks for the interest, edx looks cool :)

I have thought about this before and I think the conversation around custom OutputFormatters in #45 is somewhat related as it also can be used to more easily parse gitlint output and integrate it with other tools. Not exactly the same, but potentially less effort to implement and maintain while enabling similar use-cases.

Having said that, I'm heavily time-constraint (#134) and don't see myself working on this in the near future. The best I can suggest for right now to script around it using shell, although I understand that's far from ideal.

jorisroovers avatar Apr 13 '21 13:04 jorisroovers

OK, thanks for the quick reply, that's better than I manage in my own side-project repos!

nedbat avatar Apr 13 '21 14:04 nedbat