d7051e8c55
This job adds a single linters tox target. The linters target is an aggregation of linters for this repo including: - flake8 - bashate Other linters such as yamllint can be added to this repo by later commits. Certain bashate and flake8 codes are suppressed. They can be enabled by later commits. This commit also adds basic contributing and hacking docs. Change-Id: I3d12e16b09d94a5eb1f6ea5e7e77f78bc082af84 Story: 2006166 Task: 36536 Signed-off-by: Al Bailey <Al.Bailey@windriver.com>
77 lines
2.6 KiB
INI
77 lines
2.6 KiB
INI
[tox]
|
|
envlist = linters
|
|
minversion = 2.3
|
|
skipsdist = True
|
|
sitepackages=False
|
|
|
|
[testenv]
|
|
install_command = pip install -U {opts} {packages}
|
|
setenv =
|
|
VIRTUAL_ENV={envdir}
|
|
OS_STDOUT_CAPTURE=1
|
|
OS_STDERR_CAPTURE=1
|
|
OS_DEBUG=1
|
|
OS_LOG_CAPTURE=1
|
|
deps =
|
|
-r{toxinidir}/requirements.txt
|
|
-r{toxinidir}/test-requirements.txt
|
|
whitelist_externals =
|
|
bash
|
|
|
|
[testenv:bashate]
|
|
# Treat all E* codes as Errors rather than warnings using: -e 'E*'
|
|
# The following codes are being suppressed:
|
|
# E006 line too long
|
|
# E010 The "do" should be on same line as for
|
|
# E041 Arithmetic expansion using $[ is deprecated for $((
|
|
# E042 local declaration hides errors
|
|
# E043 Arithmetic compound has inconsistent return semantics
|
|
# E044 Use [[ for non-POSIX comparisions
|
|
commands =
|
|
bash -c "find {toxinidir} \
|
|
-not \( -type d -name .?\* -prune \) \
|
|
-type f \
|
|
-not -name \*~ \
|
|
-not -name \*.md \
|
|
-name \*.sh \
|
|
-print0 | xargs -n 1 -0 bashate -v \
|
|
-i E006,E010,E041,E042,E043,E044 \
|
|
-e 'E*'"
|
|
|
|
[flake8]
|
|
# Note: hacking pulls in flake8 2.5.5 which can not parse an ignore list spanning multiple lines
|
|
# F errors are high priority to fix. W are warnings. E series are pep8, H series are hacking
|
|
# F401 'FOO' imported but unused
|
|
# F841 local variable 'FOO' is assigned to but never used
|
|
# W291 trailing whitespace
|
|
# W391 blank line at end of file
|
|
# E128 continuation line under-indented for visual indent
|
|
# E221 multiple spaces before operator
|
|
# E226 missing whitespace around arithmetic operator
|
|
# E227 missing whitespace around bitwise or shift operator
|
|
# E241 multiple spaces after ','
|
|
# E265 block comment should start with '# '
|
|
# E302 expected 2 blank lines, found 1
|
|
# E501 line too long
|
|
# E502 the backslash is redundant between brackets
|
|
# E702 multiple statements on one line (semicolon)
|
|
# H101 is TODO
|
|
# H104 File contains nothing but comments
|
|
# H201 no 'except:' at least use 'except Exception:'
|
|
# H238 old style class declaration, use new style (inherit from `object`)
|
|
# H306 imports not in alphabetical order (sys, re)
|
|
# H401 docstring should not start with a space
|
|
# H405 multi line docstring summary not separated with an empty line
|
|
ignore = F401,F841,W291,W391,E128,E221,E226,E227,E241,E265,E302,E501,E502,E702,H101,H104,H201,H238,H306,H401,H405
|
|
# max-line-length is not referenced if E501 is suppressed
|
|
max-line-length=80
|
|
|
|
[testenv:flake8]
|
|
commands =
|
|
flake8
|
|
|
|
[testenv:linters]
|
|
commands =
|
|
{[testenv:bashate]commands}
|
|
{[testenv:flake8]commands}
|