1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
# gitlint
[]
(https://travis-ci.org/jorisroovers/gitlint)
[]
(https://pypi.python.org/pypi/gitlint)
Git linter written in python. Checks your git log for style.
**NOTE: gitlint is still under active development**
## Getting Started ##
```bash
# Install gitlint
pip install gitlint
# Check the last commit message
gitlint
# Alternatively, pipe a commit message to gitlint:
cat examples/commit-message-1 | gitlint
```
Output example:
```bash
$ cat examples/commit-message-2 | gitlint
1: T1 Title exceeds max length (134>80): "This is the title of a commit message that is over 80 characters and contains hard tabs and trailing whitespace and the word wiping "
1: T2 Title has trailing whitespace: "This is the title of a commit message that is over 80 characters and contains hard tabs and trailing whitespace and the word wiping "
1: T4 Title contains hard tab characters (\t): "This is the title of a commit message that is over 80 characters and contains hard tabs and trailing whitespace and the word wiping "
2: B4 Second line is not empty: "This line should not contain text"
3: B1 Line exceeds max length (125>80): "Lines typically need to have a max length, meaning that they can't exceed a preset number of characters, usually 80 or 120. "
3: B2 Line has trailing whitespace: "Lines typically need to have a max length, meaning that they can't exceed a preset number of characters, usually 80 or 120. "
3: B3 Line contains hard tab characters (\t): "Lines typically need to have a max length, meaning that they can't exceed a preset number of characters, usually 80 or 120. "
```
NOTE: The returned exit code equals the number of errors found.
You can modify verbosity using the ```-v``` flag, like so:
```bash
$ cat examples/commit-message-2 | gitlint -v
1: T1
1: T2
[removed output]
$ cat examples/commit-message-2 | gitlint -vv
1: T1 Title exceeds max length (134>80)
1: T2 Title has trailing whitespace
1: T4 Title contains hard tab characters (\t)
[removed output]
$ cat examples/commit-message-2 | gitlint -vvv
1: T1 Title exceeds max length (134>80): "This is the title of a commit message that is over 80 characters and contains hard tabs and trailing whitespace and the word wiping "
1: T2 Title has trailing whitespace: "This is the title of a commit message that is over 80 characters and contains hard tabs and trailing whitespace and the word wiping "
[removed output]
```
The default verbosity is ```-vvv```.
Other commands and variations:
```bash
Usage: gitlint [OPTIONS]
Git lint tool, checks your git commit messages for styling issues
Options:
--config PATH Config file location (default: .gitlint).
--ignore TEXT Ignore rules (comma-separated by id or name).
-v, --verbose Verbosity, more v's for more verbose output (e.g.: -v, -vv,
-vvv). Default: -vvv
-s, --silent Silent mode (no output).
--version Show the version and exit.
--help Show this message and exit.
```
## Config file ##
You can modify gitlint's behavior by specifying a config file like so:
```bash
gitlint --config myconfigfile
```
By default, gitlint will look for an **optional** ```.gitlint``` file for configuration.
```
[general]
# rules can be ignored by name or by id
ignore=title-max-length, B1
# verbosity level: 0-3 (default: 2)
verbosity=3
```
## Supported Rules ##
ID | Name | Description
------|-----------------------------|----------------------------------------------------
T1 | title-max-length | Title length must be < 80 chars.
T2 | title-trailing-whitespace | Title cannot have trailing whitespace (space or tab)
T3 | title-trailing-punctuation | Title cannot have trailing punctuation (?:!.,;)
T4 | title-hard-tab | Title cannot contain hard tab characters (\t)
T5 | title-must-not-contain-word | Title cannot contain certain words (default: "WIP")
B1 | body-max-line-length | Lines in the body must be < 80 chars.
B2 | body-trailing-whitespace | Body cannot have trailing whitespace (space or tab)
B3 | body-hard-tab | Body cannot contain hard tab characters (\t)
## Development ##
To run tests:
```bash
./run_tests.sh # run unit tests and print test coverage
./run_tests.sh --no-coverage # run unit tests without test coverage
./run_tests.sh --pep8 # pep8 checks
./run_tests.sh --stats # print some code stats
```
There is a Vagrantfile in this repository that can be used for development.
```bash
vagrant up
vagrant ssh
```
## Wishlist ##
- More rules:
- title-regex: Title must match a given regex
- changed-file-mentioned: If a specific file is changed, it needs to be explicitly mentioned in the commit message
- ...
- Check the entire git log
- Rule specific configuration
- Commandline arguments to set config, e.g.: -c general.ignore T2,B3
- More Unit tests :D
- Check a specific commit or range of commits, similar to how git log works, eg.: ```git log -1 -3```
- Checks on different attributes of the the commit message: author, date, etc
|
