3dfd7e1de9
Add a test that the first line of a checked file either starts with #! or has a .sh file extension. This is useful for tools such as file, syntax-highlighting with tools such as gerrit and automatic mode-selection for editors. This is added at a warning level, so as not to be enforcing. To accomodate this each message is given a default-level (all others remain at error). long_msg is extended with some rationale. The output of --show is modified to show this. While we're there, flesh out the long_msg for a few other checks as well. A new option "-e" option is also added that turns warnings into errors, should a project decide they wish to enforce particular warning such as this. Change-Id: I0ed3e1dd17810ff826ee9cf5528d7a0805487624
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
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 and deprecated syntax
Rules to identify obsolete and deprecated syntax that should not be used
- E041: Usage of $[ for arithmetic is deprecated for $((
See also
See also /man/bashate.