check-commit
109 lines
| 3.4 KiB
| text/plain
|
TextLexer
/ contrib / check-commit
|
r22043 | #!/usr/bin/env python | ||
# | ||||
# Copyright 2014 Matt Mackall <mpm@selenic.com> | ||||
# | ||||
# A tool/hook to run basic sanity checks on commits/patches for | ||||
# submission to Mercurial. Install by adding the following to your | ||||
# .hg/hgrc: | ||||
# | ||||
# [hooks] | ||||
# pretxncommit = contrib/check-commit | ||||
# | ||||
# The hook can be temporarily bypassed with: | ||||
# | ||||
# $ BYPASS= hg commit | ||||
# | ||||
|
r26421 | # See also: https://mercurial-scm.org/wiki/ContributingChanges | ||
|
r22043 | |||
|
r29164 | from __future__ import absolute_import, print_function | ||
|
r29163 | |||
import os | ||||
import re | ||||
import sys | ||||
|
r22043 | |||
|
r27782 | commitheader = r"^(?:# [^\n]*\n)*" | ||
afterheader = commitheader + r"(?!#)" | ||||
beforepatch = afterheader + r"(?!\n(?!@@))" | ||||
|
r22043 | errors = [ | ||
|
r27782 | (beforepatch + r".*[(]bc[)]", "(BC) needs to be uppercase"), | ||
|
r28042 | (beforepatch + r".*[(]issue \d\d\d", | ||
"no space allowed between issue and number"), | ||||
|
r27782 | (beforepatch + r".*[(]bug(\d|\s)", "use (issueDDDD) instead of bug"), | ||
(commitheader + r"# User [^@\n]+\n", "username is not an email address"), | ||||
(commitheader + r"(?!merge with )[^#]\S+[^:] ", | ||||
|
r22043 | "summary line doesn't start with 'topic: '"), | ||
|
r27782 | (afterheader + r"[A-Z][a-z]\S+", "don't capitalize summary lines"), | ||
(afterheader + r"[^\n]*: *[A-Z][a-z]\S+", "don't capitalize summary lines"), | ||||
|
r30061 | (afterheader + r"\S*[^A-Za-z0-9-_]\S*: ", | ||
|
r27692 | "summary keyword should be most user-relevant one-word command or topic"), | ||
|
r27782 | (afterheader + r".*\.\s*\n", "don't add trailing period on summary line"), | ||
(afterheader + r".{79,}", "summary line too long (limit is 78)"), | ||||
|
r29716 | # Forbid "_" in function name. | ||
# | ||||
# We skip the check for cffi related functions. They use names mapping the | ||||
# name of the C function. C function names may contain "_". | ||||
(r"\n\+[ \t]+def (?!cffi)[a-z]+_[a-z]", | ||||
"adds a function with foo_bar naming"), | ||||
|
r22043 | ] | ||
|
r27782 | word = re.compile('\S') | ||
def nonempty(first, second): | ||||
if word.search(first): | ||||
return first | ||||
return second | ||||
|
r28043 | def checkcommit(commit, node=None): | ||
|
r27780 | exitcode = 0 | ||
|
r27781 | printed = node is None | ||
|
r27783 | hits = [] | ||
|
r30843 | signtag = (afterheader + | ||
r'Added (tag [^ ]+|signature) for changeset [a-f0-9]{12}') | ||||
if re.search(signtag, commit): | ||||
return 0 | ||||
|
r27780 | for exp, msg in errors: | ||
|
r28012 | for m in re.finditer(exp, commit): | ||
|
r27782 | end = m.end() | ||
trailing = re.search(r'(\\n)+$', exp) | ||||
if trailing: | ||||
end -= len(trailing.group()) / 2 | ||||
|
r27783 | hits.append((end, exp, msg)) | ||
if hits: | ||||
hits.sort() | ||||
pos = 0 | ||||
last = '' | ||||
for n, l in enumerate(commit.splitlines(True)): | ||||
pos += len(l) | ||||
while len(hits): | ||||
end, exp, msg = hits[0] | ||||
|
r27782 | if pos < end: | ||
|
r27780 | break | ||
|
r27783 | if not printed: | ||
printed = True | ||||
|
r29164 | print("node: %s" % node) | ||
print("%d: %s" % (n, msg)) | ||||
print(" %s" % nonempty(l, last)[:-1]) | ||||
|
r27783 | if "BYPASS" not in os.environ: | ||
exitcode = 1 | ||||
del hits[0] | ||||
last = nonempty(l, last) | ||||
|
r27780 | return exitcode | ||
|
r22043 | |||
|
r27780 | def readcommit(node): | ||
return os.popen("hg export %s" % node).read() | ||||
if __name__ == "__main__": | ||||
|
r27781 | exitcode = 0 | ||
|
r27780 | node = os.environ.get("HG_NODE") | ||
|
r22043 | |||
|
r27780 | if node: | ||
commit = readcommit(node) | ||||
|
r27781 | exitcode = checkcommit(commit) | ||
elif sys.argv[1:]: | ||||
for node in sys.argv[1:]: | ||||
exitcode |= checkcommit(readcommit(node), node) | ||||
|
r27780 | else: | ||
commit = sys.stdin.read() | ||||
|
r27781 | exitcode = checkcommit(commit) | ||
|
r27780 | sys.exit(exitcode) | ||