##// END OF EJS Templates
check-commit: check capitalization in summary lines...
Eric Sumner -
r24049:ba272156 default
parent child Browse files
Show More
@@ -1,55 +1,56 b''
1 1 #!/usr/bin/env python
2 2 #
3 3 # Copyright 2014 Matt Mackall <mpm@selenic.com>
4 4 #
5 5 # A tool/hook to run basic sanity checks on commits/patches for
6 6 # submission to Mercurial. Install by adding the following to your
7 7 # .hg/hgrc:
8 8 #
9 9 # [hooks]
10 10 # pretxncommit = contrib/check-commit
11 11 #
12 12 # The hook can be temporarily bypassed with:
13 13 #
14 14 # $ BYPASS= hg commit
15 15 #
16 16 # See also: http://mercurial.selenic.com/wiki/ContributingChanges
17 17
18 18 import re, sys, os
19 19
20 20 errors = [
21 21 (r"[(]bc[)]", "(BC) needs to be uppercase"),
22 22 (r"[(]issue \d\d\d", "no space allowed between issue and number"),
23 23 (r"[(]bug", "use (issueDDDD) instead of bug"),
24 24 (r"^# User [^@\n]+$", "username is not an email address"),
25 25 (r"^# .*\n(?!merge with )[^#]\S+[^:] ",
26 26 "summary line doesn't start with 'topic: '"),
27 27 (r"^# .*\n[A-Z][a-z]\S+", "don't capitalize summary lines"),
28 (r"^# .*\n[^\n]*: *[A-Z][a-z]\S+", "don't capitalize summary lines"),
28 29 (r"^# .*\n.*\.\s+$", "don't add trailing period on summary line"),
29 30 (r"^# .*\n.{78,}", "summary line too long"),
30 31 (r"^\+\n \n", "adds double empty line"),
31 32 (r"\+\s+def [a-z]+_[a-z]", "adds a function with foo_bar naming"),
32 33 ]
33 34
34 35 node = os.environ.get("HG_NODE")
35 36
36 37 if node:
37 38 commit = os.popen("hg export %s" % node).read()
38 39 else:
39 40 commit = sys.stdin.read()
40 41
41 42 exitcode = 0
42 43 for exp, msg in errors:
43 44 m = re.search(exp, commit, re.MULTILINE)
44 45 if m:
45 46 pos = 0
46 47 for n, l in enumerate(commit.splitlines(True)):
47 48 pos += len(l)
48 49 if pos >= m.end():
49 50 print "%d: %s" % (n, msg)
50 51 print " %s" % l[:-1]
51 52 if "BYPASS" not in os.environ:
52 53 exitcode = 1
53 54 break
54 55
55 56 sys.exit(exitcode)
General Comments 0
You need to be logged in to leave comments. Login now