juped / git-lint-branch Goto Github PK

The skeleton project currently opens a git repository in the current directory. Real git commands work from anywhere in a repository's work tree (and the ones that don't involve work trees work from anywhere in the repository too). See if pygit2 has a mechanism to do this first (I think it does); if not, write a simple one.

Multi-commit linters are tougher than single-commit linters. I think they should get a fresh copy of the pygit2 walker and use it and/or the commit objects themselves to walk the log in their own style. However, it's possible that we might need more involved operations and data models. This requires some design forethought.

I'm thinking .git-lint-branch in the repository root (or a similar name) is good. Should be INI or TOML to match more or less closely with .gitconfig's format. This should be able to specify linters to run, options to linters that support them, and what warning level to apply to each linter.

With multiple linters producing output per commit, the output becomes hard to read.

• A --no-verbose or similar option should silence help messages.
• The commit data should include the commit message title and be printed only once per commit, with separators.
• Color code according to severity

Maybe we should make a disconnected commit graph in the repository with a fake project history with some messy branches to test our linters against.

Part of the output of a linter should be the warning level: we can provide defaults in the linter, overridable by .git-lint-branch files. Maybe the following:

• notice
• caution
• warning
• fail (not in any defaults, just for maintainers to use)

These should be the easiest to represent - linters that only look at a single commit. In the overall program flow, we should walk the commits once and check each one with all single-commit linters, then later each multi-commit linter can walk the branch in its own way individually. What we need is some kind of function or class interface that takes a pygit2 commit object and returns a lint result.