RETIRED, further work has moved to Debian project infrastructure
649c7dc799
I noticed that we end up treating a heredoc as one big logical line, then passing it through things like the line-length check. So cat <<EOF this is normal lines that get picked up as a long line! EOF end up triggering the long-line exception ... clearly not what is intended. In fact, there's not much we can do with heredocs. They are usually some weird syntax for a config file, or something else you're writing out in bulk. Often they have offsets that just don't match what we want, etc. Thus most logical thing to do seems to be to just ignore whatever is in the heredoc. I also noticed we don't handle <<'EOF', which is another common idiom, so add that to the regex. Also add a test-case to ensure we're ignoring the heredoc contents. Change-Id: I2e3d66f27ff4c0d1f542511ca3e19c29a596896f |
||
---|---|---|
bashate | ||
doc/source | ||
.coveragerc | ||
.gitignore | ||
.gitreview | ||
.mailmap | ||
.testr.conf | ||
babel.cfg | ||
CONTRIBUTING.rst | ||
HACKING.rst | ||
LICENSE | ||
openstack-common.conf | ||
pylintrc | ||
README.rst | ||
requirements.txt | ||
setup.cfg | ||
setup.py | ||
test-requirements.txt | ||
tox.ini |
bashate
A pep8 equivalent for bash scripts
This program attempts to be an automated style checker for bash scripts to fill the same part of code review that pep8 does in most OpenStack projects. It started from humble beginnings in the DevStack project, and will continue to evolve over time.
- Free software: Apache license
- Documentation: http://docs.openstack.org/developer/bashate
- Source: http://git.openstack.org/cgit/openstack-dev/bashate
- Bugs: http://bugs.launchpad.net/bash8
Currently Supported Checks
Errors
Basic white space errors, for consistent indenting
- E001: check that lines do not end with trailing whitespace
- E002: ensure that indents are only spaces, and not hard tabs
- E003: ensure all indents are a multiple of 4 spaces
- E004: file did not end with a newline
- E006: check for lines longer than 79 columns
Structure Errors
A set of rules that help keep things consistent in control blocks. These are ignored on long lines that have a continuation, because unrolling that is kind of "interesting"
- E010: do not on the same line as for
- E011: then not on the same line as if or elif
- E012: heredoc didn't end before EOF
- E020: Function declaration not in format
^function name {$
Obsolete, deprecated or unsafe syntax
Rules to identify obsolete, deprecated or unsafe syntax that should not be used
- E040: Syntax errors reported by bash -n
- E041: Usage of $[ for arithmetic is deprecated for $((
- E042: local declaration hides errors
See also
See also /man/bashate
.