1- # python-lint
1+ # python-lint-plus
22
33<p align =" left " >
4- <a href =" https://github.com/weibullguy/python-lint " ><img alt =" All lints status " src =" https://github.com/weibullguy/python-lint/workflows/all-lints/badge.svg " ></a ></p >
4+ <a href =" https://github.com/weibullguy/python-lint-plus " ><img alt =" All lints status " src =" https://github.com/weibullguy/python-lint-plus /workflows/all-lints/badge.svg " ></a ></p >
55
66## About
77
8+ This is a fork of Ricardo Chaves [ python-lint action] ( https://github.com/ricardochaves/python-lint/ )
9+ but I added some tools that I like to use.
10+
811This action may be used to execute the following applications:
912
1013- [ black] ( https://github.com/psf/black )
11- - [ pylint] ( https://www.pylint.org/ )
1214- [ isort] ( https://github.com/timothycrosley/isort )
13- - [ pycodestyle] ( https://pycodestyle.readthedocs.io )
14- - [ flake8] ( http://flake8.pycqa.org )
15- - [ mypy] ( http://mypy-lang.org/ )
1615- [ docformatter] ( https://github.com/myint/docformatter )
16+ - [ pycodestyle] ( https://pycodestyle.readthedocs.io )
1717- [ pydocstyle] ( https://github.com/PyCQA/pydocstyle/ )
18+ - [ mypy] ( http://mypy-lang.org/ )
19+ - [ pylint] ( https://www.pylint.org/ )
20+ - [ flake8] ( http://flake8.pycqa.org )
21+
22+ The default for each tool is check only, not make automatic changes. It's
23+ recommended that the tools you use in this action be used in-line with your
24+ editor or IDE and/or as pre-commit hooks. This action just verifies you didn't
25+ forget to do that.
26+
27+ However, you could choose to have fixes applies by each tool. If you do, it's
28+ recommended that the autoformatters come first, followed by the style checking
29+ tools to verify the autoformatter results. After this, the type checkers and
30+ linters can be run.
1831
1932## Usage
2033
@@ -24,54 +37,54 @@ Basic:
2437
2538``` yml
2639steps :
27- - uses : actions/checkout@v1
28- - uses : weibullguy/python-lint@master
40+ - uses : actions/checkout@v2
41+ - uses : weibullguy/python-lint-plus @master
2942` ` `
3043
3144Options:
3245
3346` ` ` yml
3447steps :
35- - uses : actions/checkout@v1
36- - uses : weibullguy/python-lint@master
48+ - uses : actions/checkout@v2
49+ - uses : weibullguy/python-lint-plus @master
3750 with :
3851 python-root-list : " python_alelo tests"
39- use-pylint : false
40- use-pycodestyle : false
41- use-flake8 : false
4252 use-black : false
43- use-mypy : false
4453 use-isort : false
4554 use-docformatter : false
55+ use-pycodestyle : false
4656 use-pydocstyle : false
47- extra-pylint-options : " "
48- extra-pycodestyle-options : " "
49- extra -flake8-options : " "
57+ use-mypy : false
58+ use-pylint : false
59+ use -flake8: false
5060 extra-black-options : " "
51- extra-mypy-options : " "
5261 extra-isort-options : " "
5362 extra-docformatter-options : " "
63+ extra-pycodestyle-options : " "
5464 extra-pydocstyle-options : " "
65+ extra-mypy-options : " "
66+ extra-pylint-options : " "
67+ extra-flake8-options : " "
5568` ` `
5669
5770Command build logic list:
5871
5972` ` ` bash
60- pylint $(extra-pylint-options) $(python-root-list)
61-
62- pycodestyle $(extra-pycodestyle-options) $(python-root-list)
63-
64- flake8 $(extra-flake8-options) $(python-root-list)
65-
6673black --check $(extra-black-options) $(python-root-list)
6774
68- mypy $(extra-mypy-options) $(python-root-list)
69-
7075isort $(extra-isort-options) $(python-root-list) -c --diff
7176
7277docformatter $(extra-docformatter-options) $(python-root-list)
7378
79+ pycodestyle $(extra-pycodestyle-options) $(python-root-list)
80+
7481pydocstyle $(extra-pydocstyle-options) $(python-root-list)
82+
83+ mypy $(extra-mypy-options) $(python-root-list)
84+
85+ pylint $(extra-pylint-options) $(python-root-list)
86+
87+ flake8 $(extra-flake8-options) $(python-root-list)
7588```
7689
7790## Versions used
0 commit comments