blob: aaabfecb8ea65088bc5fcfa7752280fc18cac92a (
plain)
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
|
# gitlint
[]
(https://travis-ci.org/jorisroovers/gitlint)
[]
(https://pypi.python.org/pypi/gitlint)
Git linter written in python.
**NOTE: gitlint is still under active development and missing many core features**
NOTE: The returned exit code equals the number of errors found.
Other commands and variations:
```bash
Usage: gitlint [OPTIONS] PATH
Git lint tool, checks your git commit messsages for styling issues
Options:
--config PATH Config file location (default: .markdownlint).
--ignore TEXT Ignore rules (comma-separated by id or name).
--version Show the version and exit.
--help Show this message and exit.
```
You can modify pymarkdownlint's behavior by specifying a config file like so:
```bash
markdownlint --config myconfigfile
```
By default, markdownlint will look for an **optional** ```.markdownlint``` file for configuration.
## 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 ##
|
